Class: Wx::RTC::RichTextLine

Inherits:

Object

• Object
• Wx::RTC::RichTextLine

Defined in:

lib/wx/doc/gen/rtc/rich_text_composite_object.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This object represents a line in a paragraph, and stores offsets from the start of the paragraph representing the start and end positions of the line.

Category: Rich Text

See Also:

• RichTextBuffer
• RichTextCtrl

Requires:

• USE_RICHTEXT

Instance Method Summary

• #clone ⇒ Wx::RTC::RichTextLine
• #copy(obj) ⇒ void

  Copies from obj.

• #get_absolute_position ⇒ Wx::Point (also: #absolute_position)

  Returns the absolute object position.

• #get_absolute_range ⇒ Range (also: #absolute_range)

  Returns the absolute range.

• #get_descent ⇒ Integer (also: #descent)

  Returns the stored descent.

• #get_parent ⇒ Wx::RTC::RichTextParagraph (also: #parent)

  Returns the parent paragraph.

• #get_position ⇒ Wx::Point (also: #position)

  Returns the object position relative to the parent.

• #get_range ⇒ Range (also: #range)

  Returns the range.

• #get_rect ⇒ Wx::Rect (also: #rect)

  Returns the rectangle enclosing the line.

• #get_size ⇒ Wx::Size (also: #size)

  Returns the line size as calculated by Layout.

• #init(parent) ⇒ void

  Initialises the object.

• #initialize(*args) ⇒ RichTextLine constructor

  A new instance of RichTextLine.

• #set_descent(descent) ⇒ void (also: #descent=)

  Sets the stored descent.

• #set_position(pos) ⇒ void (also: #position=)

  Sets the object position relative to the parent.

• #set_range(*args) ⇒ Object (also: #range=)
• #set_size(sz) ⇒ void (also: #size=)

  Sets the line size as calculated by Layout.

Constructor Details

#initialize(parent) ⇒ Wx::RTC::RichTextLine #initialize(obj) ⇒ Wx::RTC::RichTextLine

Returns a new instance of RichTextLine.

Overloads:

• #initialize(parent) ⇒ Wx::RTC::RichTextLine

  Parameters:

  • parent (Wx::RTC::RichTextParagraph)
• #initialize(obj) ⇒ Wx::RTC::RichTextLine

  Parameters:

  • obj (Wx::RTC::RichTextLine)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 448

def initialize(*args) end

Instance Method Details

#clone ⇒ Wx::RTC::RichTextLine

Returns:

• (Wx::RTC::RichTextLine)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 531

def clone; end

#copy(obj) ⇒ void

This method returns an undefined value.

Copies from obj.

Parameters:

• obj (Wx::RTC::RichTextLine)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 528

def copy(obj) end

#get_absolute_position ⇒ Wx::Point Also known as: absolute_position

Returns the absolute object position.

Returns:

• (Wx::Point)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 501

def get_absolute_position; end

#get_absolute_range ⇒ Range Also known as: absolute_range

Returns the absolute range.

Returns:

• (Range)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 474

def get_absolute_range; end

#get_descent ⇒ Integer Also known as: descent

Returns the stored descent.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 517

def get_descent; end

#get_parent ⇒ Wx::RTC::RichTextParagraph Also known as: parent

Returns the parent paragraph.

Returns:

• (Wx::RTC::RichTextParagraph)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 464

def get_parent; end

#get_position ⇒ Wx::Point Also known as: position

Returns the object position relative to the parent.

Returns:

• (Wx::Point)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 490

def get_position; end

#get_range ⇒ Range Also known as: range

Returns the range.

Returns:

• (Range)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 469

def get_range; end

#get_rect ⇒ Wx::Rect Also known as: rect

Returns the rectangle enclosing the line.

Returns:

• (Wx::Rect)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 506

def get_rect; end

#get_size ⇒ Wx::Size Also known as: size

Returns the line size as calculated by Layout.

Returns:

• (Wx::Size)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 479

def get_size; end

#init(parent) ⇒ void

This method returns an undefined value.

Initialises the object.

Parameters:

• parent (Wx::RTC::RichTextParagraph)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 523

def init(parent) end

#set_descent(descent) ⇒ void Also known as: descent=

This method returns an undefined value.

Sets the stored descent.

Parameters:

• descent (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 512

def set_descent(descent) end

#set_position(pos) ⇒ void Also known as: position=

This method returns an undefined value.

Sets the object position relative to the parent.

Parameters:

• pos (Array(Integer, Integer), Wx::Point)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 496

def set_position(pos) end

#set_range(range) ⇒ void #set_range(from, to) ⇒ void Also known as: range=

Overloads:

• #set_range(range) ⇒ void

  This method returns an undefined value.

  Sets the range associated with this line.

  Parameters:

  • range (Range)
• #set_range(from, to) ⇒ void

  This method returns an undefined value.

  Sets the range associated with this line.

  Parameters:

  • from (Integer)
  • to (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 459

def set_range(*args) end

#set_size(sz) ⇒ void Also known as: size=

This method returns an undefined value.

Sets the line size as calculated by Layout.

Parameters:

• sz (Array(Integer, Integer), Wx::Size)

# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 485

def set_size(sz) end