ScoreProcessing::EditActionFactory Class Reference

A music score editing actions factory. More...

#include <EditActionFactory.h>

List of all members.

Public Types
enum	pitch {   C, D, E, F,   G, A, B }
enum	clef {   C1, C2, C3, C4,   F3, F4, G1, G2 }
enum	octaveConvention { GUIDO, ALT_HELM, ASA }
enum	duration {   kWhole = 1, kHalf = 2, kQuarter = 4, kEight = 8,   k16 = 16, k32 = 32 }
enum	TimeSignature {   k2_2, kc, k4_4, kC,   k3_4, k2_4, k6_8, k3_8,   k9_8, k12_8 }
Public Member Functions
	EditActionFactory ()
virtual	~EditActionFactory ()
Static Public Member Functions
static SAction	newUndoAction ()
	an action to undo the previoous action
static SAction	newRedoAction ()
	an action to redo the previoous action
static SAction	newShowSpaceAction (bool usingRests)
	an action to show empty space
static SAction	newHideSpaceAction ()
	an action to hide empty space
static SAction	newAccidentalAction (bool sharp)
	an action to select and add an accidental to the selected symbols.
static SAction	newStaccatoAction ()
	an action to select and add a staccato to the selected symbols.
static SAction	newAccentAction ()
	an action to select and add an accent to the selected symbols.
static SAction	newBreathMarkAction ()
	an action to select and add a breath mark to the selected symbols.
static SAction	newNoteDurationAction (duration dur)
	an action to select and apply a note duration to the selected symbols.
static SAction	newRestDurationAction (duration dur)
	an action to select and apply a rest duration to the selected symbols.
static SAction	newDotAction ()
	an action to select and add a dot to the selected symbols.
static SAction	newTieAction ()
	an action to select and tie notes.
static SAction	newTripletAction ()
	an action to select and transform the selected durations into a triplet.
static SAction	newSlurAction ()
	an action to select and slur symbols.
static SAction	newTransposeAction (bool up)
	an action to transpose the notes up or down
static SAction	newShiftAction (bool left)
	an action to shift notes to the left or right
static SAction	newNewSymbolAction (int octave, pitch p, long attributes)
	an action to insert a new symbol.
static SAction	newInsertMeasureAction (bool before)
	an action to insert a new measure.
static SAction	newAddMeasureAction ()
	an action to add a measure at the end of the score.
static SAction	newRemoveMeasuresAction ()
	an action to remove the selected measures.
static SAction	newRemoveSymbolsAction (bool packspace)
	an action to remove symbols.
static SAction	newRepeatBarAction (bool begin)
	an action to insert a repeat bar.
static SAction	newKeySignAction (int sign)
	an action to change the score key signature.
static SAction	newMidiInstrAction (int progChange, const char *name)
	an action to change the score midi instrument.
static SAction	newTimeSignAction (TimeSignature sign)
	an action to change the score time signature.
static SAction	newTempoAction (int tempo, duration dur, bool dot)
	an action to specify the tempo indication.

---

Detailed Description

A music score editing actions factory.

Music score edition is in charge of a score edition engine which is a state machine. Most of the actions affects the score or the edition engine state:

• when an action is processed with a non empty score selection, it is applied to the selection content.
• when the score selection is empty, the editing engine switch the corresponding attributes to its next state (see the state transition scheme in ScoreEditorFacade::getEditActionState)

Some actions are global to the score (like TempoAction): they are applied to the whole score, whatever the current selection.

---

Member Enumeration Documentation

enum ScoreProcessing::EditActionFactory::clef

Enumerator:

C1
C2
C3
C4
F3
F4
G1
G2

enum ScoreProcessing::EditActionFactory::duration

Enumerator:

kWhole
kHalf
kQuarter
kEight
k16
k32

enum ScoreProcessing::EditActionFactory::octaveConvention

Enumerator:

GUIDO
ALT_HELM
ASA

enum ScoreProcessing::EditActionFactory::pitch

Enumerator:

C
D
E
F
G
A
B

enum ScoreProcessing::EditActionFactory::TimeSignature

Enumerator:

k2_2
kc
k4_4
kC
k3_4
k2_4
k6_8
k3_8
k9_8
k12_8

---

Constructor & Destructor Documentation

ScoreProcessing::EditActionFactory::EditActionFactory

(

)

[inline]

virtual ScoreProcessing::EditActionFactory::~EditActionFactory

(

)

[inline, virtual]

---

Member Function Documentation

static SAction ScoreProcessing::EditActionFactory::newAccentAction

(

)

[static]

an action to select and add an accent to the selected symbols.

static SAction ScoreProcessing::EditActionFactory::newAccidentalAction

(

bool

sharp

)

[static]

an action to select and add an accidental to the selected symbols.

Parameters:

sharp

true for sharp, false for flat.

static SAction ScoreProcessing::EditActionFactory::newAddMeasureAction

(

)

[static]

an action to add a measure at the end of the score.

static SAction ScoreProcessing::EditActionFactory::newBreathMarkAction

(

)

[static]

an action to select and add a breath mark to the selected symbols.

static SAction ScoreProcessing::EditActionFactory::newDotAction

(

)

[static]

an action to select and add a dot to the selected symbols.

static SAction ScoreProcessing::EditActionFactory::newHideSpaceAction

(

)

[static]

an action to hide empty space

static SAction ScoreProcessing::EditActionFactory::newInsertMeasureAction

(

bool

before

)

[static]

an action to insert a new measure.

Parameters:

before

a bool value to insert before (true) or after (false) the current position.

static SAction ScoreProcessing::EditActionFactory::newKeySignAction

(

int

sign

)

[static]

an action to change the score key signature.

Parameters:

sign

the key signature expressed as a number of sharps (when > 0) or flats (when < 0)

static SAction ScoreProcessing::EditActionFactory::newMidiInstrAction	(	int	progChange,
		const char *	name
	)			[static]

an action to change the score midi instrument.

Parameters:

	progChange	the midi programm change
	name	an optional midi instrument name

static SAction ScoreProcessing::EditActionFactory::newNewSymbolAction	(	int	octave,
		pitch	p,
		long	attributes
	)			[static]

an action to insert a new symbol.

Parameters:

	octave	the note octave number
	p	the note pitch
	attributes	the note attributes

Note that octave and pitch values are part of the new symbol, even if the symbol type may be rest. Note also that the symbol will carry the current selected duration.

static SAction ScoreProcessing::EditActionFactory::newNoteDurationAction

(

duration

dur

)

[static]

an action to select and apply a note duration to the selected symbols.

static SAction ScoreProcessing::EditActionFactory::newRedoAction

(

)

[static]

an action to redo the previoous action

static SAction ScoreProcessing::EditActionFactory::newRemoveMeasuresAction

(

)

[static]

an action to remove the selected measures.

static SAction ScoreProcessing::EditActionFactory::newRemoveSymbolsAction

(

bool

packspace

)

[static]

an action to remove symbols.

Parameters:

packspace

control empty space reorganization

Note that the action removes the selected symbols or the symbol preceding the cursor position when the selection is empty.

static SAction ScoreProcessing::EditActionFactory::newRepeatBarAction

(

bool

begin

)

[static]

an action to insert a repeat bar.

Parameters:

begin

a bool value to insert begin repeat (true) or end repeat (false) at the current position.

static SAction ScoreProcessing::EditActionFactory::newRestDurationAction

(

duration

dur

)

[static]

an action to select and apply a rest duration to the selected symbols.

static SAction ScoreProcessing::EditActionFactory::newShiftAction

(

bool

left

)

[static]

an action to shift notes to the left or right

Parameters:

left

left or right shift control

Shifting is a graphic operation : selected notes are graphically shifted to the left or right inside a measure. The value of the shift duration depends on the available empty space in the target direction.

static SAction ScoreProcessing::EditActionFactory::newShowSpaceAction

(

bool

usingRests

)

[static]

an action to show empty space

Empty space in a measure can be made visible using gray notes or rests.

Parameters:

usingRests

control the use of notes or rests to display empty space.

static SAction ScoreProcessing::EditActionFactory::newSlurAction

(

)

[static]

an action to select and slur symbols.

static SAction ScoreProcessing::EditActionFactory::newStaccatoAction

(

)

[static]

an action to select and add a staccato to the selected symbols.

static SAction ScoreProcessing::EditActionFactory::newTempoAction	(	int	tempo,
		duration	dur,
		bool	dot
	)			[static]

an action to specify the tempo indication.

Parameters:

	tempo	the tempo expressed as a number of beats per minute
	dur	the beat duration
	dot	set to true for dotted beat durations

static SAction ScoreProcessing::EditActionFactory::newTieAction

(

)

[static]

an action to select and tie notes.

static SAction ScoreProcessing::EditActionFactory::newTimeSignAction

(

TimeSignature

sign

)

[static]

an action to change the score time signature.

Parameters:

sign

the new time signature.

static SAction ScoreProcessing::EditActionFactory::newTransposeAction

(

bool

up

)

[static]

an action to transpose the notes up or down

Parameters:

up

up or down transposition control

Transposition is a graphic operation : selected notes are graphically shifted one half-space up or down, depending on the tranposition direction.

static SAction ScoreProcessing::EditActionFactory::newTripletAction

(

)

[static]

an action to select and transform the selected durations into a triplet.

static SAction ScoreProcessing::EditActionFactory::newUndoAction

(

)

[static]

an action to undo the previoous action

---

The documentation for this class was generated from the following file:

• E:/VEMUS/Vemus/include/ScoreViewer/ScoreProcessing/editor/EditActionFactory.h