wxRichTextContextMenuPropertiesInfo Class Reference

#include <wx/richtext/richtextctrl.h>

Detailed Description

wxRichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu, whose properties are available to be edited.

Public Member Functions
	wxRichTextContextMenuPropertiesInfo ()
	Constructor.
void	Init ()
	Initialisation.
bool	AddItem (const wxString &label, wxRichTextObject *obj)
	Adds an item.
int	AddMenuItems (wxMenu *menu, int startCmd=wxID_RICHTEXT_PROPERTIES1) const
	Returns the number of menu items that were added.
int	AddItems (wxRichTextCtrl *ctrl, wxRichTextObject *container, wxRichTextObject *obj)
	Adds appropriate menu items for the current container and clicked on object (and container's parent, if appropriate).
void	Clear ()
	Clears the items.
wxString	GetLabel (int n) const
	Returns the nth label.
wxRichTextObject *	GetObject (int n) const
	Returns the nth object.
wxRichTextObjectPtrArray &	GetObjects ()
	Returns the array of objects.
const wxRichTextObjectPtrArray &	GetObjects () const
	Returns the array of objects.
wxArrayString &	GetLabels ()
	Returns the array of labels.
const wxArrayString &	GetLabels () const
	Returns the array of labels.
int	GetCount () const
	Returns the number of items.

Public Attributes
wxRichTextObjectPtrArray	m_objects
wxArrayString	m_labels

Constructor & Destructor Documentation

wxRichTextContextMenuPropertiesInfo::wxRichTextContextMenuPropertiesInfo

(

)

Constructor.

Member Function Documentation

bool wxRichTextContextMenuPropertiesInfo::AddItem	(	const wxString &	label,
		wxRichTextObject *	obj
	)

Adds an item.

int wxRichTextContextMenuPropertiesInfo::AddItems	(	wxRichTextCtrl *	ctrl,
		wxRichTextObject *	container,
		wxRichTextObject *	obj
	)

Adds appropriate menu items for the current container and clicked on object (and container's parent, if appropriate).

int wxRichTextContextMenuPropertiesInfo::AddMenuItems	(	wxMenu *	menu,
		int	startCmd = wxID_RICHTEXT_PROPERTIES1
	)		const

Returns the number of menu items that were added.

void wxRichTextContextMenuPropertiesInfo::Clear

(

)

Clears the items.

int wxRichTextContextMenuPropertiesInfo::GetCount

(

)

const

Returns the number of items.

wxString wxRichTextContextMenuPropertiesInfo::GetLabel

(

int

n

)

const

Returns the nth label.

wxArrayString& wxRichTextContextMenuPropertiesInfo::GetLabels

(

)

Returns the array of labels.

const wxArrayString& wxRichTextContextMenuPropertiesInfo::GetLabels

(

)

const

Returns the array of labels.

wxRichTextObject* wxRichTextContextMenuPropertiesInfo::GetObject

(

int

n

)

const

Returns the nth object.

wxRichTextObjectPtrArray& wxRichTextContextMenuPropertiesInfo::GetObjects

(

)

Returns the array of objects.

const wxRichTextObjectPtrArray& wxRichTextContextMenuPropertiesInfo::GetObjects

(

)

const

Returns the array of objects.

void wxRichTextContextMenuPropertiesInfo::Init

(

)

Initialisation.

Member Data Documentation

wxArrayString wxRichTextContextMenuPropertiesInfo::m_labels

wxRichTextObjectPtrArray wxRichTextContextMenuPropertiesInfo::m_objects