CmdChangeDots Class Reference

#include <lomse_command.h>

Inheritance diagram for CmdChangeDots:

Detailed Description

A command for changing the number of dots in the selected notes and rests.

See constructor for details.

Public Member Functions
	CmdChangeDots (int dots, const std::string &name="Change dots")
int	get_cursor_update_policy () override
int	get_undo_policy () override
int	get_selection_update_policy () override
Public Member Functions inherited from DocCmdSimple
virtual	~DocCmdSimple ()
bool	is_composite () override
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

CmdChangeDots()

CmdChangeDots::CmdChangeDots	(	int	dots,
		const std::string &	name = "Change dots"
	)

This command changes the number of dots in the selected notes and rests.

Parameters

dots	The new number of dots (0..n) to put in the notes and rests+.
name	The displayable name for the command. If not specified will default to "Change dots".

Remarks

• If the selection is empty or does not contain notes or rests, the command will not be executed and will return a failure code.
• After executing the command:
  • the selection will not be changed.
  • the cursor will not change its position.

Example

void CommandHandler::change_dots(int dots)
{
    //change dots for current selected notes/rests

    if (SpInteractor spInteractor = m_pPresenter->get_interactor(0).lock())
    {
        string name = gettext("Change note/rest dots");
        SpInteractor->exec_command( new CmdChangeDots(dots, name) );
    }
}

Member Function Documentation

get_cursor_update_policy()

int CmdChangeDots::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 CmdChangeDots::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 CmdChangeDots::get_undo_policy ( )

inlineoverridevirtual

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

Implements DocCommand.