wx.richtext.RichTextCommand¶

Implements a command on the undo/redo stack.

A wx.richtext.RichTextCommand object contains one or more wx.richtext.RichTextAction objects, allowing aggregation of a number of operations into one command.

Class Hierarchy¶

Inheritance diagram for class RichTextCommand:

Methods Summary¶

`__init__`	Constructor for one action.
`AddAction`	Adds an action to the action list.
`ClearActions`	Clears the action list.
`Do`	Performs the command.
`GetActions`	Returns the action list.
`Undo`	Undoes the command.

Properties Summary¶

Actions

See GetActions

Class API¶

class wx.richtext.RichTextCommand(Command)¶

Possible constructors:

RichTextCommand(name, id, buffer, container, ctrl,
                ignoreFirstTime=False) -> None

RichTextCommand(name) -> None

Implements a command on the undo/redo stack.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self, name, id, buffer, container, ctrl, ignoreFirstTime=False)

Constructor for one action.

Parameters:

name (string)
id (RichTextCommandId)
buffer (wx.richtext.RichTextBuffer)
container (wx.richtext.RichTextParagraphLayoutBox)
ctrl (wx.richtext.RichTextCtrl)
ignoreFirstTime (bool)

Return type:

None

__init__ (self, name)

Constructor for multiple actions.

Parameters:: name (string)
Return type:: None

AddAction(self, action)¶

Adds an action to the action list.

Parameters:: action (wx.richtext.RichTextAction)
Return type:: None

ClearActions(self)¶

Clears the action list.

Return type:: None

Do(self)¶

Performs the command.

Return type:: bool

GetActions(self)¶

Returns the action list.

Return type:: RichTextActionList

Undo(self)¶

Undoes the command.

Return type:: bool

Properties¶

Actions¶: See GetActions