Inheritance diagram for AInstrGroup:

Detailed Description

AInstrGroup is the API object for interacting with the internal model Bla,bla bla...

Warning: This documentation is incomplete. The user API for the document internal model is currently being defined and, thus, for this class, only some methods have been defined.

Public Member Functions
ImoInstrGroup *	internal_object () const

Access to group properties
EJoinBarlines	barlines_mode () const

EGroupSymbol	symbol () const

const std::string &	name_string () const

const std::string &	abbreviation_string () const

Group properties modification
void	set_symbol (EGroupSymbol symbol)

void	set_barlines_mode (EJoinBarlines value)

void	set_name_string (const std::string &name)

void	set_abbreviation_string (const std::string &abbrev)

Instruments in the group
int	num_instruments () const

AInstrument	instrument_at (int pos) const

AInstrument	first_instrument () const

AInstrument	last_instrument () const

int	index_to_first_instrument () const

int	index_to_last_instrument () const

bool	set_range (int iFirstInstr, int iLastInstr)

Public Member Functions inherited from AObject
	AObject ()

bool	is_valid () const

ImoObj *	internal_object () const

ImoId	object_id () const

const std::string &	object_name () const

ADocument	owner_document () const

ADynamic	downcast_to_dynamic () const

AInstrument	downcast_to_instrument () const

AInstrGroup	downcast_to_instr_group () const

ALink	downcast_to_link () const

AList	downcast_to_list () const

AParagraph	downcast_to_paragraph () const

AScore	downcast_to_score () const

ATextItem	downcast_to_text_item () const

bool	is_anonymous_block () const

bool	is_button () const

bool	is_content () const

bool	is_control () const

bool	is_dynamic () const

bool	is_heading () const

bool	is_image () const

bool	is_inline_wrapper () const

bool	is_instrument () const

bool	is_instr_group () const

bool	is_link () const

bool	is_list () const

bool	is_list_item () const

bool	is_midi_info () const

bool	is_multicolumn () const

bool	is_music_data () const

bool	is_paragraph () const

bool	is_score () const

bool	is_sound_info () const

bool	is_table () const

bool	is_table_cell () const

bool	is_table_body () const

bool	is_table_head () const

bool	is_table_row () const

bool	is_text_item () const

Member Function Documentation

◆ abbreviation_string()

const std::string & abbreviation_string ( ) const

Returns the short, abbreviated name of the group. This is the string for the group that appears on every system other than the first system.

◆ barlines_mode()

EJoinBarlines barlines_mode ( ) const

Returns a value from enum EJoinBarlines indicating how the barlines for the instruments in the group will be displayed.

◆ first_instrument()

AInstrument first_instrument ( ) const

Returns the first instrument included in the group.

◆ index_to_first_instrument()

int index_to_first_instrument ( ) const

Returns the index, referred to the score, of the first instrument included in the group. The returned index is the position occupied by this instrument in the score (0 based: 0 .. num.instrs - 1)

◆ index_to_last_instrument()

int index_to_last_instrument ( ) const

Returns the index, referred to the score, of the last instrument included in the group. The returned index is the position occupied by this instrument in the score (0 based: 0 .. num.instrs - 1)

◆ instrument_at()

AInstrument instrument_at ( int pos ) const

Returns the instrument at position pos in the group. First instrument in the group is position 0.

◆ internal_object()

ImoInstrGroup * internal_object ( ) const

Transitional, to facilitate migration to the new public API. Notice that this method will be removed in future so, please, if you need to use this method open an issue at https://github.com/lenmus/lomse/issues explaining the need, so that the public API could be fixed and your app. would not be affected in future when this method is removed.

◆ last_instrument()

AInstrument last_instrument ( ) const

Returns the last instrument included in the group.

◆ name_string()

const std::string & name_string ( ) const

Returns the name of the group, that is the string for the group that is placed at the start of the first system in the score.

◆ num_instruments()

int num_instruments ( ) const

Returns the number of instruments included in the group.

◆ set_abbreviation_string()

void set_abbreviation_string ( const std::string & abbrev )

Sets the short, abbreviated name for the group that appears on every system other than the first one.

◆ set_barlines_mode()

void set_barlines_mode ( EJoinBarlines value )

Defines how the barlines for the instruments in the group will be displayed. Parameter must be a value from enum EJoinBarlines.

◆ set_name_string()

void set_name_string ( const std::string & name )

Sets the name of the group, that is the string for the group that is placed at the start of the first system in the score.

◆ set_range()

bool set_range	(	int	iFirstInstr,
		int	iLastInstr
	)

Defines the instruments that will be included in the group. Returns false if any error.

Parameters

iFirstInstr	Position in the score of the first instrument to be included in the group: 0 .. num.instrs - 1
iLastInstr	Position in the score of the last instrument to be included in the group: 0 .. num.instrs - 1

Notice that iFirstInstr must be lower than iLastInstr. Otherwise this method will do nothing.

◆ set_symbol()

void set_symbol ( EGroupSymbol symbol )

Sets the symbol that will be displayed for marking the instruments that form the group. Must be a value from enum EGroupSymbol.

◆ symbol()

EGroupSymbol symbol ( ) const

Returns a value from enum EGroupSymbol indicating what symbol will be displayed for marking the instruments that form the group.