Phoenix Logo

phoenix_title 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 Class Hierarchy

Inheritance diagram for class RichTextObjectAddress:


method_summary 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.

property_summary Properties Summary

Address See GetAddress and SetAddress

api Class API



class wx.richtext.RichTextObjectAddress(object)

Possible constructors:

RichTextObjectAddress(topLevelContainer, obj)

RichTextObjectAddress()

RichTextObjectAddress(address)

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)

overload Overloaded Implementations:



__init__ (self, topLevelContainer, obj)

Creates the address given a container and an object.

Parameters:



__init__ (self)



__init__ (self, address)

Parameters:address (wx.richtext.RichTextObjectAddress) –





Copy(self, address)

Copies the address.

Parameters:address (wx.richtext.RichTextObjectAddress) –


Create(self, topLevelContainer, obj)

Creates the address given a container and an object.

Parameters:
Return type:

bool



GetAddress(self)

Returns the array of integers representing the object address.

Return type:list of integers


GetObject(self, topLevelContainer)

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

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


Init(self)


SetAddress(self, address)

Sets the address from an array of integers.

Parameters:address (list of integers) –

Properties



Address

See GetAddress and SetAddress