Public enumerations

Detailed Description

This group contains all public global enumeration types.

Enumerations
enum	EEditMode
enum	ERenderOptions
enum	EEventType
enum	ERequestType
enum	EFragmentMark
enum	EPointType
enum	EViewType
enum	EImoAttribute
enum	EDataType
enum	EEventFlag
enum	EVisualTrackingMode
enum	EJoinBarlines
enum	EGroupSymbol
enum	EDocObject
enum	EMuteType
enum	EIntervalType
enum	EPixelFormat
enum	ELineStyle
enum	ELineCap
enum	ELineEdge
enum	EVAlign
enum	EHAlign

Enumeration Type Documentation

EDataType

enum EDataType

This enum describes data type for an attribute.

#include <lomse_im_attributes.h>

Enumerator
k_type_bool	Boolean.
k_type_color	Color.
k_type_double	Float number, double precission.
k_type_int	Integer number.
k_type_string	String of characters.

EDocObject

enum EDocObject

This enum describes the API objects that compose a document

The values from this enum are normally used in factory methods, to define the class of the object to be created. For instance, in ADocument::create_object().

#include <lomse_internal_model.h>

Enumerator
k_obj_anonymous_block	An structural block-level container (AAnonymousBlock)
k_obj_button	A button control (AButton)
k_obj_content	A generic block-level container (AContent)
k_obj_control	A user defined GUI control object (AControl)
k_obj_dynamic	A block of external content injected dynamically (ADynamic)
k_obj_heading	A text header (AHeading)
k_obj_image	An image (AImage)
k_obj_inline_wrapper	A generic inline-box container (AInlineWrapper)
k_obj_instrument	An instrument in an score (AInstrument)
k_obj_instr_group	A grouping of instruments in an score (AInstrGroup)
k_obj_link	A hyperlink (ALink)
k_obj_list	A text list (AList)
k_obj_list_item	An item in a text list (AListItem)
k_obj_midi_info	A set of MIDI properties (AMidiInfo)
k_obj_multicolumn	A blocks container subdivided in columns (AMultiColumn)
k_obj_music_data	The musical content for an instrument (AMusicData)
k_obj_paragraph	A paragraph (AParagraph)
k_obj_score	A music score (AScore)
k_obj_score_player	A score player control (AScorePlayer)
k_obj_sound_info	Sound information for an instrument (ASoundInfo)
k_obj_table	A table (ATable)
k_obj_table_cell	A cell in a table (ATableCell)
k_obj_table_row	A row in a table (ATableRow)
k_obj_text_item	A chunk of text (ATextItem)

EEditMode

enum EEditMode

This enum describes the behavior of edition commands related to adding or removing notes and rests.

See Supported edition modes.

#include <lomse_command.h>

Enumerator
k_edit_mode_replace	Replace mode: Notes and rests are not inserted. Instead they overwrite the music so that measure duration is maintained. Also, notes are not deleted but replaced by rests.
k_edit_mode_ripple	Limited ripple mode: when inserting or deleting notes/rests the barlines are also shifted.

EEventFlag

enum EEventFlag

This enum describes the flags for mouse events, indicating which mouse buttons and keyboard keys are pressed when the mouse event takes place.

#include <lomse_interactor.h>

Enumerator
k_mouse_left	0x01. Mouse left button pressed or released
k_mouse_right	0x02. Mouse right button pressed or released
k_mouse_middle	0x04. Mouse middle button pressed or released
k_kbd_shift	0x08. Keyboard Shift key pressed while mouse event
k_kbd_ctrl	0x10. Keyboard Ctrol key pressed while mouse event
k_kbd_alt	0x20. Keyboard Alt key pressed while mouse event

EEventType

enum EEventType

This enum assigns an event type for Lomse events.

#include <lomse_events.h>

Enumerator
k_doc_modified_event	Informs that the Document has been modified.
k_update_window_event	Request to update window with current bitmap.
k_mouse_in_event	mouse enters in an object
k_mouse_out_event	mouse goes out from an object
k_on_click_event	click on object
k_link_clicked_event	left mouse click on a link (ImoLink object)
k_show_contextual_menu_event	right click on object: contextual menu request
k_control_point_moved_event	user moves a handler: handler released event
k_selection_set_change	selected objects changed
k_pointed_object_change	cursor pointing to a different object
k_do_play_score_event	Request to start/resume playback.
k_pause_score_event	Request to pause playback.
k_stop_playback_event	Request to stop playback.
k_tracking_event	Wrapper event containing a list of real events.
k_update_viewport_event	Suggest to change viewport.
k_end_of_playback_event	Playback ended.

EFragmentMark

enum EFragmentMark

This enum describes values for start-end mark type.

#include <lomse_fragment_mark.h>

Enumerator
k_mark_line	Vertical line.
k_mark_open_squared	Squared bracket with horizontal lines at right.
k_mark_close_squared	Squared bracket with horizontal lines at left.
k_mark_open_curly	Curly bracket with curved lines pointing to right.
k_mark_close_curly	Curly bracket with curved lines pointing to left.
k_mark_open_rounded	Rounded bracket with curved lines pointing to right.
k_mark_close_rounded	Rounded bracket with curved lines pointing to left.

EGroupSymbol

enum EGroupSymbol

In a music score, when several instruments form a group, this enum indicates if a symbol for the group should be displayed in the score and what symbol to use.

Enumerator
k_group_symbol_none	Do not display a symbol.
k_group_symbol_brace	Use a brace.
k_group_symbol_bracket	Use a bracket.
k_group_symbol_line	Use a vertical a line.

EHAlign

enum EHAlign

This enum describes the different object justification possibilities.

#include <lomse_shape_base.h>

Enumerator
k_halign_default	Alignment is not specified.
k_halign_right	Object aligned on left side
k_halign_justify	Object aligned on right side
k_halign_center	Object justified on both sides

EImoAttribute

enum EImoAttribute

This enum describes values for valid attributes for CmdChangeAttribute commands, as well as valid attribute indexes for AttrObj.

#include <lomse_im_attributes.h>

Enumerator
k_attr_barline	Barline type.
k_attr_color	Color value.
k_attr_dots	Number of dots (dotted notes & rests)
k_attr_notated_accidentals	Notated accidentals for notes.
k_attr_note_type	Note type.
k_attr_octave	Octave (note pitch)
k_attr_staff_num	Number of staff.
k_attr_stem_type	Stem type.
k_attr_step	Step (note pitch)
k_attr_style	Style.
k_attr_time_modifier_bottom	Value for time modifier, bottom number (tuplets)
k_attr_time_modifier_top	Value for time modifier, top number (tuplets)
k_attr_visible	Visible (display or hide the element)
k_attr_voice	Voice (for notes & rests)
k_attr_xpos	X position (to place an element)
k_attr_ypos	Y position (to place an element)

EIntervalType

enum EIntervalType

This enum describes valid interval types.

#include <lomse_pitch.h>

Enumerator
k_double_diminished	Double diminished.
k_diminished	Diminished.
k_minor	Minor.
k_major	Major.
k_perfect	Perfect.
k_augmented	Augmented.
k_double_augmented	Double augmented.

EJoinBarlines

enum EJoinBarlines

In a music score, when several instruments form a group, this enum indicates how the barlines for the instruments should be displayed.

Enumerator
k_non_joined_barlines	Independent barlines for each instrument in the group.
k_joined_barlines	Barlines joined across all instruments in the group.
k_mensurstrich_barlines	Barlines only in the gaps between instruments in the group, but not on the staves of each instrument.

ELineCap

enum ELineCap

This enum describes the different terminal symbols for lines.

#include <lomse_shape_base.h>

ELineEdge

enum ELineEdge

This enum describes the different possibilities for ending a line stroke.

#include <lomse_shape_base.h>

Enumerator
k_edge_normal	Edge is perpendicular to line.
k_edge_vertical	Edge is always a vertical line.
k_edge_horizontal	Edge is always a horizontal line.

ELineStyle

enum ELineStyle

This enum describes the different supported styles for lines.

#include <lomse_shape_base.h>

EMuteType

enum EMuteType

This enum describes the valid values for muting playback for different instruments. A mute is a device attached to a musical instrument which changes the instrument's tone quality (timbre) or lowers its volume. Mutes are commonly used on string and brass instruments, especially the trumpet and trombone, and are occasionally used on woodwinds. Muting can also be done by hand, as in the case of palm muting a guitar or grasping a triangle to dampen its sound. The on value is used to totally remove playback. See: https://en.wikipedia.org/wiki/Mute_(music)

Enumerator
k_mute_off	Not muted.
k_mute_on	Total mute. No playback.
k_mute_bucket	Bucket mute, also known as the velvetone or velvet-tone.
k_mute_cup	Cup mute. Similar to strait but includes an extra inverted cone.
k_mute_echo	Mute echo not main sound.
k_mute_harmon_no_stem	Harmon mute, also known as the wa-wa, wow-wow, or wah-wah mute .
k_mute_harmon_stem	Harmon mute, with a small tube inserted into the mute.
k_mute_hat	Derby or hat mute is done with a bowler hat or similar object.
k_mute_palm	Palm mute, a playing technique for guitar and bass guitar,.
k_mute_plunger	Muted with a plunger held in front of the bell.
k_mute_practice	Muted with absorbent material. Used during practice to prevent bothering others.
k_mute_solotone	Solotone mute (two telescoping cones and a small tube in the center).
k_mute_stop_hand	Stop mute using the hand.
k_mute_stop_mute	Stop mute using a physical stop mute.
k_mute_straight	Strait mute using a truncated cone.

EPixelFormat

enum EPixelFormat

This enum describes the supported formats for the rendering buffer.

#include <lomse_pixel_formats.h>

Enumerator
k_pix_format_undefined	By default. No conversions are applied.
k_pix_format_gray8	Simple 256 level grayscale.
k_pix_format_gray16	Simple 65535 level grayscale.
k_pix_format_rgb555	15 bit rgb. Architecture dependent due to byte ordering!
k_pix_format_rgb565	16 bit rgb. Architecture dependent due to byte ordering!
k_pix_format_rgbAAA	30 bit rgb. Architecture dependent due to byte ordering!
k_pix_format_rgbBBA	32 bit rgb. Architecture dependent due to byte ordering!
k_pix_format_bgrAAA	30 bit bgr. Architecture dependent due to byte ordering!
k_pix_format_bgrABB	32 bit bgr. Architecture dependent due to byte ordering!
k_pix_format_rgb24	R-G-B, one byte per color component.
k_pix_format_bgr24	B-G-R, native win32 BMP format.
k_pix_format_rgba32	R-G-B-A, one byte per color component.
k_pix_format_argb32	A-R-G-B, native MAC format.
k_pix_format_abgr32	A-B-G-R, one byte per color component.
k_pix_format_bgra32	B-G-R-A, native win32 BMP format.
k_pix_format_rgb48	R-G-B, 16 bits per color component.
k_pix_format_bgr48	B-G-R, native win32 BMP format.
k_pix_format_rgba64	R-G-B-A, 16 bits byte per color component.
k_pix_format_argb64	A-R-G-B, native MAC format.
k_pix_format_abgr64	A-B-G-R, one byte per color component.
k_pix_format_bgra64	B-G-R-A, native win32 BMP format.

EPointType

enum EPointType

This enum describes the flags for mouse events, indicating which regions of the score are valid for mouse interaction.

#include <lomse_graphical_model.h>

Enumerator
k_point_unknown	not yet determined
k_point_on_staff	pointing to an staff shape
k_point_above_staff	pointing to top margin of GmoBoxSliceInstr
k_point_below_staff	pointing to bottom margin of GmoBoxSliceInstr
k_point_on_other_shape	pointing to a shape other than staff
k_point_on_other_box	pointing to a box, other cases
k_point_on_other	pointing to other place (score paper)
k_point_on_note_or_rest	pointing to a note or a rest
k_point_on_any	any region is valid (all score is valid)

ERenderOptions

enum ERenderOptions

This enum describes valid values for method GraphicView::set_rendering_option(), mainly used for debug purposes.

#include <lomse_drawer.h>

Enumerator
k_option_draw_box_doc_page_content	Draw borders around all DocPage boxes.
k_option_draw_box_container	Draw borders around all DocPageContent boxes.
k_option_draw_box_system	Draw borders around all System boxes.
k_option_draw_box_slice	Draw borders around all SystemSlice boxes.
k_option_draw_box_slice_instr	Draw borders around all InstrSlice boxes.
k_option_draw_box_inline_flag	Draw borders around all Inline boxes.
k_option_display_voices_in_colours	Display each music voice in a different color.

ERequestType

enum ERequestType

This enum assigns an request type for Lomse requests.

#include <lomse_events.h>

Enumerator
k_get_font_filename	request for dynamic content creation

EVAlign

enum EVAlign

This enum describes the different possibilities for vertical alignment of an object within a block.

#include <lomse_shape_base.h>

EViewType

enum EViewType

This enum describes the available view types for displaying a document.

• k_view_simple means that the document will be displayed not paginated, in a single page. It was developed to create small images for controls (e.g., a combobox) by rendering small scores (just one measure) without margins and grey areas (gaps between pages). [DEPRECATED]
• k_view_vertical_book means that the document will be displayed as book pages, one page after the other in a vertical layout. The user will have to scroll down for advancing.
• k_view_horizontal_book means that the document will be displayed as book pages, one page after the other in a horizontal layout. The user will have to scroll right for advancing.
• k_view_single_system is for rendering documents that only contain one score (e.g. LDP files, LMD files with just one score, and score files imported from other formats such as MusicXML). It will display the score in a single system, as if the paper had infinite width. And for viewing the end of the score the user will have to scroll to the right. See SingleSystemView.
• k_view_single_page is similar to an HTML page. All the document is rendered in a single page having the required height to contain the full document. Is a kind of k_view_vertical_book but without gaps in the content for separting pages. As with k_view_vertical_book the user will have to scroll down for advancing.
• k_view_free_flow is for rendering documents in a single page as high as necessary. It is similar to how an HTML page with unconstrained body width is displayed in a browser.
• k_view_half_page is a view that has a double behaviour. In normal mode (no playback) it behaves as SinglePageView, that is the score is rendered on a single page as high as necessary to contain all the score. But when in playback mode, the bitmap to be rendered in the application window is split horizontally in two halves. See HalfPageView for detail.

#include <lomse_graphic_view.h>

EVisualTrackingMode

enum EVisualTrackingMode

This enum describes the valid modes for visual tracking during playback.

#include <lomse_interactor.h>

Enumerator
k_tracking_none	Do not add any visual tracking effect.
k_tracking_highlight_notes	Highlight the notes and rest being played back.
k_tracking_tempo_line	Display a vertical line at beat start.