Phoenix Logo

phoenix_title wx.richtext.RichTextLine

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.


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextLine:

method_summary Methods Summary

__init__  
Clone  
Copy Copies from obj.
GetAbsolutePosition Returns the absolute object position.
GetAbsoluteRange Returns the absolute range.
GetDescent Returns the stored descent.
GetParent Returns the parent paragraph.
GetPosition Returns the object position relative to the parent.
GetRange Returns the range.
GetRect Returns the rectangle enclosing the line.
GetSize Returns the line size as calculated by Layout.
Init Initialises the object.
SetDescent Sets the stored descent.
SetPosition Sets the object position relative to the parent.
SetRange Sets the range associated with this line.
SetSize Sets the line size as calculated by Layout.

api Class API



class wx.richtext.RichTextLine(object)

Possible constructors:

RichTextLine(parent)

RichTextLine(obj)

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.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, parent)

Parameters:parent (wx.richtext.RichTextParagraph) –



__init__ (self, obj)

Parameters:obj (wx.richtext.RichTextLine) –





Clone(self)
Return type: wx.richtext.RichTextLine


Copy(self, obj)

Copies from obj.

Parameters:obj (wx.richtext.RichTextLine) –


GetAbsolutePosition(self)

Returns the absolute object position.

Return type:Point


GetAbsoluteRange(self)

Returns the absolute range.

Return type: wx.richtext.RichTextRange


GetDescent(self)

Returns the stored descent.

Return type:int


GetParent(self)

Returns the parent paragraph.

Return type: wx.richtext.RichTextParagraph


GetPosition(self)

Returns the object position relative to the parent.

Return type:Point


GetRange(self)

Returns the range.

Return type: wx.richtext.RichTextRange


GetRect(self)

Returns the rectangle enclosing the line.

Return type:Rect


GetSize(self)

Returns the line size as calculated by Layout.

Return type:Size


Init(self, parent)

Initialises the object.

Parameters:parent (wx.richtext.RichTextParagraph) –


SetDescent(self, descent)

Sets the stored descent.

Parameters:descent (int) –


SetPosition(self, pos)

Sets the object position relative to the parent.

Parameters:pos (wx.Point) –


SetRange(self, *args, **kw)

Sets the range associated with this line.

overload Overloaded Implementations:



SetRange (self, range)

Parameters:range (wx.richtext.RichTextRange) –



SetRange (self, from_, to_)

Parameters:
  • from_ (long) –
  • to_ (long) –





SetSize(self, sz)

Sets the line size as calculated by Layout.

Parameters:sz (wx.Size) –

Properties



AbsolutePosition

See GetAbsolutePosition



AbsoluteRange

See GetAbsoluteRange



Descent

See GetDescent and SetDescent



Parent

See GetParent



Position

See GetPosition and SetPosition



Range

See GetRange and SetRange



Rect

See GetRect



Size

See GetSize and SetSize