denigma 4.0.0
Loading...
Searching...
No Matches
denigma::classify::text::Insert Struct Reference

The Enigma text insert a run was substituted for. More...

#include <formatted_text.h>

Public Types

enum class  Kind {
  Other , Accidental , PlaybackValue , PlaybackController ,
  PlaybackPass , RehearsalMark
}
 The insert's meaning, for the inserts the classifier names. More...
 

Public Attributes

Kind kind {Kind::Other}
 The insert's meaning.
 
std::string command
 The insert as written, without the leading caret.
 
std::vector< std::string > parameters
 The insert's parameters as written.
 

Detailed Description

The Enigma text insert a run was substituted for.

The run's text is the substitution musxdom made, so a consumer that has nothing better can use the run as it stands. One that can render the insert itself (a live page number, its own playback value) replaces the run as a whole.

Member Enumeration Documentation

◆ Kind

The insert's meaning, for the inserts the classifier names.

Enumerator
Other 

An insert the classifier does not name; command and parameters still identify it.

Accidental 

An accidental symbol: ^flat, ^sharp, ^natural, ^dbflat, ^dbsharp.

PlaybackValue 

The expression's playback value: ^value.

PlaybackController 

The expression's playback controller value: ^control.

PlaybackPass 

The expression's repeat pass: ^pass.

RehearsalMark 

The rehearsal mark's sequence text: ^rehearsal.


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