Class that handles a contol with multiple lines of data, arranged in columns. More...

#include <ff_dialogs.h>

Inheritance diagram for FCCtrlDataList:

Public Member Functions
virtual const char *	ClassName ()
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...

	FCCtrlDataList (twobyte id)
	The constructor.

void	SetFontSize (int fontsize)
	Sets the font size for the data list. This affects Cocoa only. More...

void	SetColumnTitle (int columnindex, FCString *pTitle)
	Changes the title for an existing column. More...

bool	AddColumn (FCString *pTitle, float columnwidth)
	Adds a column to the data list view. More...

int	AddRow (FCDataListRow *pRow)
	Adds a row to the data list view. The data list view is responsible for deleting the FCDataListRow object. More...

bool	InsertRowAt (FCDataListRow *pRow, int)
	Inserts a row at a specific place in the list view. More...

FCDataListRow *	CreateRow ()
	Creates a new row and adds it to the end of the data list view. The columns should be added before this method is called. More...

bool	DeleteRow (int lineindex)
	Deletes a row. More...

void	DeleteAll ()
	Removes all items from a data list. More...

void	DeleteAllColumns ()
	removes all columns from the data list

bool	GetUseCheckboxes () const
	Returns if checkboxes should be used for the data list. More...

void	SetUseCheckboxes (bool state)
	Sets if checkboxes should be used for the data list. To have any effect, this must be called before the dialog is created. More...

bool	UseLeftCheckboxColumn ()
	Indicate that there should be a check mark column at the left side. More...

void	UseGrid ()
	Indicate that the data list should use grid lines around the cells. More...

void	UseFullRowSelect ()
	Set that the list view (on Windows) should use full row selects. More...

int	GetCount ()
	Returns the number of rows in the list. More...

FCDataListRow *	GetItemAt (int lineindex)
	Returns the row object at the indexed (0-based) row. More...

void	Redraw ()
	Updates the data list control visually.

bool	SelectLine (int lineindex, bool ensurevisible)
	Selects a 0-based line index. More...

void	ScrollToTop ()
	Scrolls the view to show the top item.

void	ExpandLastColumn ()
	Expands the last column to fit the view exactly. More...

int	GetSelectedLine ()
	Returns the selected line. More...

virtual void	HandleSelectChange (int lineindex)
	Called every time there's a user row selection change on any of the items. More...

virtual void	HandleUnselect ()
	Called every time nothing is selected. More...

virtual void	HandleCheckChange (int lineindex, bool state)
	Called every time there's a user check change on any of the items. More...

virtual void	HandleDoubleClick ()
	Called every time there's a double-click inside the data list.

void	ReconnectAll ()
	Reconnects FCDataListRow objects to the objects. Use after delete/insert/rearrange/etc.

bool	HasCheckboxes ()
	Returns true if the data list has check boxes, through the UseLeftCheckboxColumn() method.

int	GetDetailedColumnCount (bool includecheckboxcolumn)
	Returns the number of columns. Platform-specific version. More...

int	GetColumnCount ()
	Returns the number of columns. More...

float	GetColumnWidth (int columnindex)
	Returns the width of a column. More...

bool	Swap (int rowindex1, int rowindex2, bool redraw)
	Swaps two rows. More...

Public Member Functions inherited from FCControl
	FCControl (twobyte id)
	The constructor. More...

virtual	~FCControl ()
	Destructor.

bool	GetPointsMeasurement ()
	Returns if the measurements and positioning is in points or in a system-native unit. More...

__FCUserWindow *	GetParent ()
	Returns the parent window object for the control.

bool	WindowExists ()
	Returns true if a valid parent window handle (and control handle) is available.

HWND	_GetWinControlHandle ()
	For internal use only. Returns to handle for the control.

virtual void	Repaint ()
	Force a visual update of the control. More...

int	GetControlID ()
	Returns the control ID for the control. More...

int	GetAssignedID ()
	Gets the connected ID regardless of platform. More...

CONTROL_ACTIONS	GetAction ()
	Returns the dialog acction assigned to the control. More...

void	SetAction (CONTROL_ACTIONS action)
	Sets the dialog acction assigned to the control. More...

virtual void	SetEnable (bool state)
	Sets the enable/grayed state of the control (if user input should be allowed or not). More...

virtual bool	GetEnable ()
	Returns the enable/grayed state of the control (if user input should be allowed or not). More...

virtual void	SetVisible (bool bShow)
	Sets the visibility of the control. More...

virtual void	SetBold (bool state)
	Sets the boldface appearance for the control.

virtual void	SetKeyboardFocus ()
	Sets the keyboard focus to the control. More...

void	SetTextAndResize (FCString *pString)
	Cocoa only: Sets the text and resizes the view inside a NSScrollView.

virtual void	SetText (FCString *pString)
	Sets the text for the control. More...

virtual void	GetText (FCString *pString)
	Gets the text of the control.

void	SetLeft (float pos)
	Sets the left position of the control.

float	GetLeft ()
	Returns the left position of the control.

void	SetTop (float pos)
	Sets the top position of the control.

float	GetTop ()
	Returns the top position of the control.

float	GetHeight ()
	Returns the height of the control.

float	GetWidth ()
	Returns the width of the control.

bool	GetVisible ()
	Returns the visibility state of a control.

void	SetWidth (float width)
	Sets the width of the control.

void	SetHeight (float height)
	Sets the height of the control.

void	MoveRelative (float horizmove, float vertmove)
	Moves the control relatively to the current position. More...

void	MoveAbsolute (float x, float y)
	Moves the control in absolute coordinates. More...

virtual void	ResizeRelative (float horizresize, float vertresize)
	Resizes the control relatively to the current size. Top left corner will stay fixed. More...

Public Member Functions inherited from __FCBase
virtual const PDKFRAMEWORK_CLASSID	GetClassID ()
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects. More...

	__FCBase ()
	The constructor.

virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor. More...

void	DebugMsgDigit (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...

void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...

void	DebugMsgString (const char pszPrefixText, const char thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...

void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string. More...

void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes. More...

int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax. More...

virtual void	DebugDump ()
	Outputs the class data/information for debugging purposes. More...

virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes. More...

virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag in the data block. More...

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets a 32 bit flag in the data block. More...

bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set. More...

void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object. More...

void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object. More...

void *	GetUserData () const
	Gets the user data attached to the instance of an object. More...

void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object. More...

virtual bool	IsIdentical (__FCBase *pCompareObject)
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...

void	StoreXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file. More...

void	StoreXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int value)
	Helper function to store integer objects in the XML file. More...

void	StoreXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool value)
	Helper function to store boolean objects in the XML file. More...

void	StoreXML_StringAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node. More...

void	StoreXML_IntegerAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node. More...

void	StoreXML_BoolAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node. More...

void	StoreXML_FloatAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node. More...

virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data. More...

bool	ReadXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file. More...

bool	ReadXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int *pValue)
	Helper method to read integer objects from the XML file. More...

bool	ReadXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file. More...

bool	ReadXML_StringAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node. More...

bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node. More...

bool	ReadXML_BoolAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node. More...

bool	ReadXML_FloatAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node. More...

virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data. More...

Additional Inherited Members
Public Types inherited from FCControl
enum	CONTROL_ACTIONS { ACTION_NONE = 0, ACTION_OK = 1, ACTION_CLOSE = 2, ACTION_CANCEL = 3 }
	Predefined actions for controls. More...

Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID { FCID_UNKNOWN = 0, FCID_ACCIDENTALMOD, FCID_ALLOTMENT, FCID_ARTICULATION, FCID_ARTICULATIONDEF, FCID_BACKWARDREPEAT, FCID_BASELINE, FCID_BEAMMOD, FCID_BEATCHARTELEMENT, FCID_BROKENBEAMMOD, FCID_CATEGORYDEF, FCID_CELLCLEFCHANGE, FCID_CELLFRAMEHOLD, FCID_CELLGRAPHIC, FCID_CELLTEXT, FCID_CENTERSMARTSHAPE, FCID_CHORD, FCID_CHORDPREFS, FCID_CHORDSUFFIXELEMENT, FCID_CHORUSSYLLABLE, FCID_CLEFDEF, FCID_COMPOSITETIMESIGBOTTOMELEMENT, FCID_COMPOSITETIMESIGTOPELEMENT, FCID_CROSSSTAFFMOD, FCID_CUSTOMSMARTLINEDEF, FCID_CUSTOMSTEMMOD, FCID_DISTANCEPREFS, FCID_DOTMOD, FCID_ENCLOSURE, FCID_ENDINGREPEAT, FCID_ENTRYALTERMOD, FCID_EXECUTABLESHAPEDEF, FCID_EXPRESSION, FCID_FONTINFO, FCID_FONTPREFS, FCID_FREEZESYSTEM, FCID_FRETBOARDSTYLEDEF, FCID_FRETBOARDSTYLEDEFS, FCID_FRETBOARDGROUPDEF, FCID_FRETBOARDGROUPDEFS, FCID_FRETINSTRUMENTDEF, FCID_GENERALPREFS, FCID_GRIDSGUIDESPREFS, FCID_GROUP, FCID_GROUPNAMEPOSITIONPREFS, FCID_HUMANPLAYBACKPREFS, FCID_INDEPENDENTCELLDETAIL, FCID_INSTRUMENTDEF, FCID_INSTRUMENTPLAYBACKDATA, FCID_KEYSIGNATURE, FCID_LAYERPREFS, FCID_LYRICSPREFS, FCID_MEASURE, FCID_MEASURENUMBERREGION, FCID_METATOOLASSIGNMENT, FCID_MIDIEXPRESSION, FCID_MISCDOCPREFS, FCID_MULTIMEASUREREST, FCID_MULTIMEASURERESTPREFS, FCID_MULTISTAFFINSTRUMENT, FCID_MULTISTAFFINSTRUMENTS, FCID_MUSICCHARACTERPREFS, FCID_MUSICSPACINGPREFS, FCID_NUMBER, FCID_NOTEHEADMOD, FCID_OTHERINCI, FCID_PERCUSSIONLAYOUTNOTE, FCID_PERCUSSIONSTAFF, FCID_PERFORMANCEMOD, FCID_PAGE, FCID_PAGEFORMATPREFS, FCID_PAGEGRAPHIC, FCID_PAGETEXT, FCID_PART, FCID_PARTEXTRACTPREFS, FCID_PARTSCOPEPREFS, FCID_PERCUSSIONNOTEMOD, FCID_PIANOBRACEPREFS, FCID_PLAYBACKPREFS, FCID_RAWTEXT, FCID_REPEATPREFS, FCID_SECONDARYBEAMBREAKMOD, FCID_SECTIONSYLLABLE, FCID_SEPARATEMEASURENUMBER, FCID_SEPARATEPLACEMENT, FCID_SHAPEDEF, FCID_SHAPEEXPRESSIONDEF, FCID_SLURCONTOURPREFS, FCID_SIZEPREFS, FCID_SMARTSHAPE, FCID_SMARTSHAPEENTRYMARK, FCID_SMARTSHAPEMEASUREMARK, FCID_SMARTSHAPEPREFS, FCID_STAFF, FCID_STAFFLIST, FCID_STAFFNAMEPOSITION, FCID_STAFFNAMEPOSITIONPREFS, FCID_STAFFSTYLEASSIGN, FCID_STAFFSTYLEDEF, FCID_STAFFSYSTEM, FCID_STEMCONNECTIONTABLE, FCID_STEMMOD, FCID_STRING, FCID_SYLLABLEENTRYMOD, FCID_SYSTEMSTAFF, FCID_TABLATURENOTEMOD, FCID_TEMPOELEMENT, FCID_TEXTBLOCK, FCID_TEXTEXPRESSIONDEF, FCID_TEXTREPEAT, FCID_TEXTREPEATDEF, FCID_TIEMOD, FCID_TIEPREFS, FCID_TIECONTOURPREFS, FCID_TIEPLACEMENTPREFS, FCID_TIMESIGNATURE, FCID_TUPLET, FCID_TUPLETPREFS, FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...

enum	MEASUREMENTUNITS { MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT, MEASUREMENTUNIT_EVPUS = UNIT_EVPUS, MEASUREMENTUNIT_INCHES = UNIT_INCHES, MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS, MEASUREMENTUNIT_POINTS = UNIT_POINTS, MEASUREMENTUNIT_PICAS = UNIT_PICAS, MEASUREMENTUNIT_SPACES = UNIT_SPACES, MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...

Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char pszPrefixText, void ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards. More...

static void	DebugOutDigit (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...

static void	DebugOutFloat (const char *pszPrefixText, float f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...

static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards. More...

static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards. More...

static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards. More...

static void	DebugOutString (const char pszPrefixText, const char thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards. More...

static void	DebugOutString (const char pszPrefixText, FCString pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards. More...

static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE". More...

static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped. More...

static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped. More...

static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes. More...

Detailed Description

Class that handles a contol with multiple lines of data, arranged in columns.

Each row of data is handled by the FCDataListRow class, which basically is a FCStrings collection. The data in the left-most column is at index 0, the next column data is at column 1, etc.

Programmatically created controls of this class defaults to a width of 200 points and a height of 150 points.

Member Function Documentation

bool FCCtrlDataList::AddColumn	(	FCString *	pTitle,
		float	columnwidth
	)

Adds a column to the data list view.

Lua-supported.

int FCCtrlDataList::AddRow ( FCDataListRow * pRow )

Adds a row to the data list view. The data list view is responsible for deleting the FCDataListRow object.

Parameters

[in] pRow The row to add, as a FCDataListRow object.

Returns: -1 on error. Otherwise, the 0-based index of the added row.

virtual const char* FCCtrlDataList::ClassName ( )

inlinevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Reimplemented from FCControl.

FCDataListRow * FCCtrlDataList::CreateRow ( )

Creates a new row and adds it to the end of the data list view. The columns should be added before this method is called.

Lua-supported.

void FCCtrlDataList::DeleteAll ( )

Removes all items from a data list.

Lua-supported.

bool FCCtrlDataList::DeleteRow ( int lineindex )

Deletes a row.

Lua-supported.

Parameters

[in] lineindex The 0-based index of the row to delete.

Returns: True on success.

void FCCtrlDataList::ExpandLastColumn ( )

Expands the last column to fit the view exactly.

Currently only supported on Mac/Cocoa.

int FCCtrlDataList::GetColumnCount ( )

inline

Returns the number of columns.

Returns: -1 on error

float FCCtrlDataList::GetColumnWidth ( int columnindex )

Returns the width of a column.

Parameters

columnindex The 0-based index to a column.

Returns: -1 on error

int FCCtrlDataList::GetCount ( )

Returns the number of rows in the list.

Lua-supported.

int FCCtrlDataList::GetDetailedColumnCount ( bool includecheckboxcolumn )

Returns the number of columns. Platform-specific version.

Parameters

includecheckboxcolumn If true, include the check box column in the counting on the Mac. In Windows, check boxes are implemented through an attribute, so this parameter doesn't do anything on Windows.

Returns: -1 on error

FCDataListRow * FCCtrlDataList::GetItemAt ( int lineindex )

Returns the row object at the indexed (0-based) row.

Lua-supported.

int FCCtrlDataList::GetSelectedLine ( )

Returns the selected line.

Please be aware that the combination HandleUnselect, HandleSelectChange, GetSelectedLine behaves a bit differently between Windows and Mac.

    Lua-supported.

Returns: -1 if no selection

bool FCCtrlDataList::GetUseCheckboxes ( ) const

inline

Returns if checkboxes should be used for the data list.

This setting is used for programmatically-created dialog boxes only.

(Lua-supported (also as property).

virtual void FCCtrlDataList::HandleCheckChange	(	int	lineindex,
		bool	state
	)

inlinevirtual

Called every time there's a user check change on any of the items.

Any inherited class must call the parent class' implementation first

virtual void FCCtrlDataList::HandleSelectChange ( int lineindex )

inlinevirtual

Called every time there's a user row selection change on any of the items.

Unselection and selection must be handled separately due to Windows weirdness...

Please be aware that the combination HandleUnselect, HandleSelectChange, GetSelectedLine behaves a bit differently between Windows and Mac.

Any inherited class must call the parent class' implementation first

virtual void FCCtrlDataList::HandleUnselect ( )

inlinevirtual

Called every time nothing is selected.

Unselection and selection must be handled separately due to Windows weirdness...

Please be aware that the combination HandleUnselect, HandleSelectChange, GetSelectedLine behaves a bit differently between Windows and Mac.

Any inherited class must call the parent class' implementation first

bool FCCtrlDataList::InsertRowAt	(	FCDataListRow *	pRow,
		int	lineindex
	)

Inserts a row at a specific place in the list view.

bool FCCtrlDataList::SelectLine	(	int	lineindex,
		bool	ensurevisible
	)

Selects a 0-based line index.

Lua-supported.

void FCCtrlDataList::SetColumnTitle	(	int	columnindex,
		FCString *	pTitle
	)

Changes the title for an existing column.

columnindex is 0-based. If the Mac version has a checkbox at the first column, the column index will differ between Windows and Mac.

void FCCtrlDataList::SetFontSize ( int fontsize )

inline

Sets the font size for the data list. This affects Cocoa only.

The font size must be set before the column is added to have any effect.

void FCCtrlDataList::SetUseCheckboxes ( bool state )

inline

Sets if checkboxes should be used for the data list. To have any effect, this must be called before the dialog is created.

This setting is used for programmatically-created dialog boxes only.

Lua-supported (also as property).

bool FCCtrlDataList::Swap	(	int	rowindex1,
		int	rowindex2,
		bool	redraw
	)

Swaps two rows.

This method doesn't update the control visually.

Returns: True if a swap was made.

void FCCtrlDataList::UseFullRowSelect ( )

Set that the list view (on Windows) should use full row selects.

This method should be called when the window has been created. It will do nothing on Mac.

void FCCtrlDataList::UseGrid ( )

Indicate that the data list should use grid lines around the cells.

This method should be called when the window has been created, but before any rows are added.

bool FCCtrlDataList::UseLeftCheckboxColumn ( )

Indicate that there should be a check mark column at the left side.

This method should be called when the window has been created, but before any rows are added.

Returns: True if the configuration was set up correctly.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation