Version: 3.1.2
wxRichTextCommand Class Reference

#include <wx/richtext/richtextbuffer.h>

+ Inheritance diagram for wxRichTextCommand:

Detailed Description

Implements a command on the undo/redo stack.

A wxRichTextCommand object contains one or more wxRichTextAction objects, allowing aggregation of a number of operations into one command.

Library:  wxRichText
Category:  Rich Text
See also
wxRichTextAction

Public Member Functions

 wxRichTextCommand (const wxString &name, wxRichTextCommandId id, wxRichTextBuffer *buffer, wxRichTextParagraphLayoutBox *container, wxRichTextCtrl *ctrl, bool ignoreFirstTime=false)
 Constructor for one action. More...
 
 wxRichTextCommand (const wxString &name)
 Constructor for multiple actions. More...
 
virtual ~wxRichTextCommand ()
 
bool Do ()
 Performs the command. More...
 
bool Undo ()
 Undoes the command. More...
 
void AddAction (wxRichTextAction *action)
 Adds an action to the action list. More...
 
void ClearActions ()
 Clears the action list. More...
 
wxList & GetActions ()
 Returns the action list. More...
 
- Public Member Functions inherited from wxCommand
 wxCommand (bool canUndo=false, const wxString &name=wxEmptyString)
 Constructor. More...
 
virtual ~wxCommand ()
 Destructor. More...
 
virtual bool CanUndo () const
 Returns true if the command can be undone, false otherwise. More...
 
virtual wxString GetName () const
 Returns the command name. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Protected Attributes

wxList m_actions
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 

Constructor & Destructor Documentation

wxRichTextCommand::wxRichTextCommand ( const wxString name,
wxRichTextCommandId  id,
wxRichTextBuffer buffer,
wxRichTextParagraphLayoutBox container,
wxRichTextCtrl ctrl,
bool  ignoreFirstTime = false 
)

Constructor for one action.

wxRichTextCommand::wxRichTextCommand ( const wxString name)

Constructor for multiple actions.

virtual wxRichTextCommand::~wxRichTextCommand ( )
virtual

Member Function Documentation

void wxRichTextCommand::AddAction ( wxRichTextAction action)

Adds an action to the action list.

void wxRichTextCommand::ClearActions ( )

Clears the action list.

bool wxRichTextCommand::Do ( )
virtual

Performs the command.

Implements wxCommand.

wxList& wxRichTextCommand::GetActions ( )
inline

Returns the action list.

bool wxRichTextCommand::Undo ( )
virtual

Undoes the command.

Implements wxCommand.

Member Data Documentation

wxList wxRichTextCommand::m_actions
protected