Lomse library. API documentation  0.30.0
DocCmdComposite Class Reference

#include <lomse_command.h>

Inheritance diagram for DocCmdComposite:
DocCommand

Detailed Description

Abstract class, base for all composite commands.

Public Member Functions

 DocCmdComposite (const std::string &name)
 
virtual ~DocCmdComposite ()
 
void add_child_command (DocCommand *pCmd)
 
int get_cursor_update_policy () override
 
int get_undo_policy () override
 
int get_selection_update_policy () override
 
bool is_composite () override
 
void mark_as_no_reversible ()
 
void mark_as_no_recordable ()
 
void mark_as_target_set_in_constructor ()
 
- Public Member Functions inherited from DocCommand
virtual ~DocCommand ()
 
std::string get_name ()
 
bool is_reversible ()
 
bool is_recordable ()
 
std::string get_error ()
 

Additional Inherited Members

- Public Types inherited from DocCommand
enum  ECmdCursorPolicy
 
enum  ECmdUndoPolicy
 
enum  ECmdSelectionPolicy
 

Constructor & Destructor Documentation

◆ DocCmdComposite()

DocCmdComposite::DocCmdComposite ( const std::string &  name)

Constructor.

◆ ~DocCmdComposite()

virtual DocCmdComposite::~DocCmdComposite ( )
virtual

Destructor.

Member Function Documentation

◆ add_child_command()

void DocCmdComposite::add_child_command ( DocCommand pCmd)

Add a child command.

◆ get_cursor_update_policy()

int DocCmdComposite::get_cursor_update_policy ( )
inlineoverridevirtual

Returns a value from ECmdCursorPolicy that indicates the update policy followed by this command.

Implements DocCommand.

◆ get_selection_update_policy()

int DocCmdComposite::get_selection_update_policy ( )
inlineoverridevirtual

Returns a value from ECmdSelectionPolicy that indicates the undo policy followed by this command.

Implements DocCommand.

◆ get_undo_policy()

int DocCmdComposite::get_undo_policy ( )
inlineoverridevirtual

Returns a value from ECmdUndoPolicy that indicates the undo policy followed by this command.

Implements DocCommand.

◆ is_composite()

bool DocCmdComposite::is_composite ( )
inlineoverridevirtual

Returns true if the command is composite.

Implements DocCommand.

◆ mark_as_no_recordable()

void DocCmdComposite::mark_as_no_recordable ( )
inline

Change default settings for this command

◆ mark_as_no_reversible()

void DocCmdComposite::mark_as_no_reversible ( )
inline

Change default settings for this command

◆ mark_as_target_set_in_constructor()

void DocCmdComposite::mark_as_target_set_in_constructor ( )
inline

Change default settings for this command