.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2020 by Total Control Software License: wxWindows License .. include:: headings.inc .. _wx.richtext.RichTextObjectAddress: ========================================================================================================================================== |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. .. seealso:: :ref:`wx.richtext.RichTextCommand` | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class RichTextObjectAddress:
| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.richtext.RichTextObjectAddress.__init__` Creates the address given a container and an object. :meth:`~wx.richtext.RichTextObjectAddress.Copy` Copies the address. :meth:`~wx.richtext.RichTextObjectAddress.Create` Creates the address given a container and an object. :meth:`~wx.richtext.RichTextObjectAddress.GetAddress` Returns the array of integers representing the object address. :meth:`~wx.richtext.RichTextObjectAddress.GetObject` Returns the object specified by the address, given a top level container. :meth:`~wx.richtext.RichTextObjectAddress.Init` :meth:`~wx.richtext.RichTextObjectAddress.SetAddress` Sets the address from an array of integers. ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~wx.richtext.RichTextObjectAddress.Address` See :meth:`~wx.richtext.RichTextObjectAddress.GetAddress` and :meth:`~wx.richtext.RichTextObjectAddress.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. .. method:: __init__(self, *args, **kw) |overload| Overloaded Implementations: :html:`

` **__init__** `(self, topLevelContainer, obj)` Creates the address given a container and an object. :param `topLevelContainer`: :type `topLevelContainer`: wx.richtext.RichTextParagraphLayoutBox :param `obj`: :type `obj`: wx.richtext.RichTextObject :html:`

` **__init__** `(self)` :html:`

` **__init__** `(self, address)` :param `address`: :type `address`: wx.richtext.RichTextObjectAddress :html:`

` .. method:: Copy(self, address) Copies the address. :param `address`: :type `address`: wx.richtext.RichTextObjectAddress .. method:: Create(self, topLevelContainer, obj) Creates the address given a container and an object. :param `topLevelContainer`: :type `topLevelContainer`: wx.richtext.RichTextParagraphLayoutBox :param `obj`: :type `obj`: wx.richtext.RichTextObject :rtype: `bool` .. method:: GetAddress(self) Returns the array of integers representing the object address. :rtype: `list of integers` .. method:: GetObject(self, topLevelContainer) Returns the object specified by the address, given a top level container. :param `topLevelContainer`: :type `topLevelContainer`: wx.richtext.RichTextParagraphLayoutBox :rtype: :ref:`wx.richtext.RichTextObject` .. method:: Init(self) .. method:: SetAddress(self, address) Sets the address from an array of integers. :param `address`: :type `address`: list of integers .. attribute:: Address See :meth:`~wx.richtext.RichTextObjectAddress.GetAddress` and :meth:`~wx.richtext.RichTextObjectAddress.SetAddress`