wxRichTextObjectAddress Class Reference

#include <wx/richtext/richtextbuffer.h>

Detailed Description

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

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

Library:  wxRichText

<>< =''>:</>&;&;< =''>\ </></>

See also

wxRichTextCommand

Public Member Functions
	wxRichTextObjectAddress (wxRichTextParagraphLayoutBox *topLevelContainer, wxRichTextObject *obj)
	Creates the address given a container and an object. More...
	wxRichTextObjectAddress ()
	wxRichTextObjectAddress (const wxRichTextObjectAddress &address)
void	Init ()
void	Copy (const wxRichTextObjectAddress &address)
	Copies the address. More...
void	operator= (const wxRichTextObjectAddress &address)
	Assignment operator. More...
wxRichTextObject *	GetObject (wxRichTextParagraphLayoutBox *topLevelContainer) const
	Returns the object specified by the address, given a top level container. More...
bool	Create (wxRichTextParagraphLayoutBox *topLevelContainer, wxRichTextObject *obj)
	Creates the address given a container and an object. More...
wxArrayInt &	GetAddress ()
	Returns the array of integers representing the object address. More...
const wxArrayInt &	GetAddress () const
	Returns the array of integers representing the object address. More...
void	SetAddress (const wxArrayInt &address)
	Sets the address from an array of integers. More...

Protected Attributes
wxArrayInt	m_address

Constructor & Destructor Documentation

wxRichTextObjectAddress() [1/3]

wxRichTextObjectAddress::wxRichTextObjectAddress ( wxRichTextParagraphLayoutBox *  topLevelContainer, wxRichTextObject *  obj  )

inline

Creates the address given a container and an object.

wxRichTextObjectAddress() [2/3]

wxRichTextObjectAddress::wxRichTextObjectAddress ( )

inline

wxRichTextObjectAddress() [3/3]

wxRichTextObjectAddress::wxRichTextObjectAddress ( const wxRichTextObjectAddress &  address )

inline

Member Function Documentation

Copy()

void wxRichTextObjectAddress::Copy ( const wxRichTextObjectAddress &  address )

inline

Copies the address.

Create()

bool wxRichTextObjectAddress::Create	(	wxRichTextParagraphLayoutBox *	topLevelContainer,
		wxRichTextObject *	obj
	)

Creates the address given a container and an object.

GetAddress() [1/2]

wxArrayInt& wxRichTextObjectAddress::GetAddress ( )

inline

Returns the array of integers representing the object address.

GetAddress() [2/2]

const wxArrayInt& wxRichTextObjectAddress::GetAddress ( ) const

inline

Returns the array of integers representing the object address.

GetObject()

wxRichTextObject* wxRichTextObjectAddress::GetObject

(

wxRichTextParagraphLayoutBox *

topLevelContainer

)

const

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

Init()

void wxRichTextObjectAddress::Init ( )

inline

operator=()

void wxRichTextObjectAddress::operator= ( const wxRichTextObjectAddress &  address )

inline

Assignment operator.

SetAddress()

void wxRichTextObjectAddress::SetAddress ( const wxArrayInt &  address )

inline

Sets the address from an array of integers.

Member Data Documentation

m_address

wxArrayInt wxRichTextObjectAddress::m_address

protected