phoenix_title wx.richtext.RichTextContextMenuPropertiesInfo

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


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextContextMenuPropertiesInfo:

method_summary Methods Summary

__init__

Constructor.

AddItem

Adds an item.

AddItems

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

AddMenuItems

Returns the number of menu items that were added.

Clear

Clears the items.

GetCount

Returns the number of items.

GetLabel

Returns the nth label.

GetLabels

Returns the array of labels.

GetObject

Returns the nth object.

GetObjects

Returns the array of objects.

Init

Initialisation.


property_summary Properties Summary

Count

See GetCount

Labels

See GetLabels

Objects

See GetObjects

m_labels

A public C++ attribute of type list of strings.

m_objects

A public C++ attribute of type RichTextObjectPtrArray.


api Class API

class wx.richtext.RichTextContextMenuPropertiesInfo(object)

Possible constructors:

RichTextContextMenuPropertiesInfo()

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

__init__(self)

Constructor.

AddItem(self, label, obj)

Adds an item.

Parameters
Return type

bool

AddItems(self, ctrl, container, obj)

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

Parameters
Return type

int

AddMenuItems(self, menu, startCmd=ID_RICHTEXT_PROPERTIES1)

Returns the number of menu items that were added.

Parameters
  • menu (wx.Menu) –

  • startCmd (int) –

Return type

int

Clear(self)

Clears the items.

GetCount(self)

Returns the number of items.

Return type

int

GetLabel(self, n)

Returns the nth label.

Parameters

n (int) –

Return type

string

GetLabels(self)

Returns the array of labels.

Return type

list of strings

GetObject(self, n)

Returns the nth object.

Parameters

n (int) –

Return type

wx.richtext.RichTextObject

GetObjects(self)

Returns the array of objects.

Return type

RichTextObjectPtrArray

Init(self)

Initialisation.

Count

See GetCount

Labels

See GetLabels

Objects

See GetObjects

m_labels

A public C++ attribute of type list of strings.

m_objects

A public C++ attribute of type RichTextObjectPtrArray.