wx.richtext.RichTextObjectAddress¶

A class for specifying an object anywhere in an object hierarchy, without using a pointer, necessary since RTC commands may delete and recreate sub-objects so physical object addresses change.

An array of positions (one per hierarchy level) is used.

Class Hierarchy¶

Inheritance diagram for class RichTextObjectAddress:

Methods Summary¶

`__init__`	Creates the address given a container and an object.
`Copy`	Copies the address.
`Create`	Creates the address given a container and an object.
`GetAddress`	Returns the array of integers representing the object address.
`GetObject`	Returns the object specified by the address, given a top level container.
`Init`
`SetAddress`	Sets the address from an array of integers.

Properties Summary¶

Address

See GetAddress and SetAddress

Class API¶

class wx.richtext.RichTextObjectAddress(object)¶

Possible constructors:

RichTextObjectAddress(topLevelContainer : RichTextParagraphLayoutBox,
                      obj : RichTextObject) -> None

RichTextObjectAddress() -> None

RichTextObjectAddress(address : RichTextObjectAddress) -> None

A class for specifying an object anywhere in an object hierarchy, without using a pointer, necessary since RTC commands may delete and recreate sub-objects so physical object addresses change.

Methods¶

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

Overloaded Implementations:

__init__ (self, topLevelContainer : RichTextParagraphLayoutBox, obj : RichTextObject)

Creates the address given a container and an object.

Parameters:

topLevelContainer (wx.richtext.RichTextParagraphLayoutBox)
obj (wx.richtext.RichTextObject)

Return type:

None

__init__ (self)

Return type:: None

__init__ (self, address : RichTextObjectAddress)

Parameters:: address (wx.richtext.RichTextObjectAddress)
Return type:: None

Copy(self, address: RichTextObjectAddress)¶

Copies the address.

Parameters:: address (wx.richtext.RichTextObjectAddress)
Return type:: None

Create(self, topLevelContainer: RichTextParagraphLayoutBox, obj: RichTextObject)¶

Creates the address given a container and an object.

Parameters:

topLevelContainer (wx.richtext.RichTextParagraphLayoutBox)
obj (wx.richtext.RichTextObject)

Return type:

bool

GetAddress(self)¶

Returns the array of integers representing the object address.

Return type:: List[int]

GetObject(self, topLevelContainer: RichTextParagraphLayoutBox)¶

Returns the object specified by the address, given a top level container.

Parameters:: topLevelContainer (wx.richtext.RichTextParagraphLayoutBox)
Return type:: wx.richtext.RichTextObject

Init(self)¶

Return type:: None

SetAddress(self, address: List[int])¶

Sets the address from an array of integers.

Parameters:: address (list of integers)
Return type:: None

Properties¶

Address¶: See GetAddress and SetAddress

Navigation