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.

See also

wx.richtext.RichTextBuffer, wx.richtext.RichTextCtrl

Class Hierarchy¶

Inheritance diagram for class RichTextLine:

Inheritance diagram of RichTextLine

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.

Properties Summary¶

`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`

Class API¶

class wx.richtext.RichTextLine(object)¶

Possible constructors:

RichTextLine(parent) -> None

RichTextLine(obj) -> None

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)¶

Overloaded Implementations:

__init__ (self, parent)

Parameters:: parent (wx.richtext.RichTextParagraph)
Return type:: None

__init__ (self, obj)

Parameters:: obj (wx.richtext.RichTextLine)
Return type:: None

Clone(self)¶

Return type:: wx.richtext.RichTextLine

Copy(self, obj)¶

Copies from obj.

Parameters:: obj (wx.richtext.RichTextLine)
Return type:: None

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)
Return type:: None

SetDescent(self, descent)¶

Sets the stored descent.

Parameters:: descent (int)
Return type:: None

SetPosition(self, pos)¶

Sets the object position relative to the parent.

Parameters:: pos (wx.Point)
Return type:: None

SetRange(self, *args, **kw)¶

Sets the range associated with this line.

Overloaded Implementations:

SetRange (self, range)

Parameters:: range (wx.richtext.RichTextRange)
Return type:: None

SetRange (self, from_, to_)

Parameters:

from_ (long)
to_ (long)

Return type:

None

SetSize(self, sz)¶

Sets the line size as calculated by Layout.

Parameters:: sz (wx.Size)
Return type:: None

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