A UI class that handles an Up/Down control. The control has 2 arrows, one pointing up and one down. More...
#include <ff_dialogs.h>
Inheritance diagram for FCCtrlUpDown:
Public Member Functions | |
| FCCtrlUpDown (twobyte id) | |
| The constructor. | |
| const char * | ClassName () const override |
| Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More... | |
| void | SetValue (int value) |
| Sets the value of the Up/Down control and updates the conneced edit field, if necessary. More... | |
| int | GetValue () |
| Returns the current value of the Up/Down control. More... | |
| void | SetRange (int min, int max) |
| Sets the range of the up/down control. More... | |
| int | GetMinimum () |
| Returns the minimum value of the range for the up/down control. More... | |
| int | GetMaximum () |
| FCCtrlEdit * | GetConnectedEdit () |
| Returns the connected edit control (if any). More... | |
| bool | ConnectIntegerEdit (FCCtrlEdit *pControl, int min, int max) |
| Connects an integer edit field to an up/down control. More... | |
| bool | ConnectMeasurementEdit (FCCtrlEdit *pControl, double min, double max) |
| Connects a measurement edit field to an up/down control. More... | |
 Public Member Functions inherited from FCControl | |
| FCControl (twobyte id, const __FCControlTypedPtr &subclassPtr) | |
| The constructor. More... | |
| FCControl (twobyte id) | |
| The constructor for external C++ subclasses. 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. More... | |
| void | SetFont (const FCFontInfo *fontInfo) |
| Sets the font information for the text of the control. More... | |
| FCFontInfo * | CreateFontInfo () |
| Creates font information from the current text font of the control. More... | |
| 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. More... | |
| void | SetLeft (float pos) |
| Sets the left position of the control. More... | |
| float | GetLeft () |
| Returns the left position of the control. More... | |
| void | SetTop (float pos) |
| Sets the top position of the control. More... | |
| float | GetTop () |
| Returns the top position of the control. More... | |
| float | GetHeight () |
| Returns the height of the control. More... | |
| float | GetWidth () |
| Returns the width of the control. More... | |
| bool | GetVisible () |
| Returns the visibility state of a control. More... | |
| void | SetWidth (float width) |
| Sets the width of the control. More... | |
| void | SetHeight (float height) |
| Sets the height of the control. More... | |
| 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 () const |
| 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... | |
| virtual | ~__FCBase () |
| Virtual destructor, so all inherited classes get the virtual destructor. | |
| void | DebugMsgInt (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. More... | |
| void | Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state) |
| Sets/resets a 32 bit flag, by using a bit mask. 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... | |
| int | GetBitCount (FLAG_32 flag) |
| Returns the total number of set bits in a 32-bit unsigned int. | |
| void | SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state) |
| Sets/resets a single bit in a 32 bit flag, by specifying one specific bit. 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_LYRICSBASELINE , 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_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS , FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD , FCID_BEAMEXTENSIONMOD , 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 | DebugOutInt (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, double 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... | |
| Protected Member Functions inherited from __FCBase | |
| __FCBase () | |
| The constructor. | |
Detailed Description
A UI class that handles an Up/Down control. The control has 2 arrows, one pointing up and one down.
Programmatically created controls of this class defaults to a width of 14 points on Windows and 19 points on Mac.
Member Function Documentation
◆ ClassName()
|
inlineoverridevirtual |
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
Lua-supported.
Reimplemented from FCControl.
◆ ConnectIntegerEdit()
|
inline |
Connects an integer edit field to an up/down control.
Lua-supported.
- Parameters
-
[in] pControl Pointer to the FCCtrlEdit that should be connected. [in] min The minimum integer value. [in] max The maximum integer value.
- Returns
- True on success.
◆ ConnectMeasurementEdit()
|
inline |
Connects a measurement edit field to an up/down control.
Lua-supported.
- Parameters
-
[in] pControl Pointer to the FCCtrlEdit that should be connected. [in] min The minimum value, in EVPUs. [in] max The maximum value, in EVPUs.
- Returns
- True on success.
◆ GetConnectedEdit()
|
inline |
Returns the connected edit control (if any).
Lua-supported.
◆ GetMaximum()
| int FCCtrlUpDown::GetMaximum | ( | ) |
brief Returns the maximum value of the range for the up/down control.
Lua-supported.
◆ GetMinimum()
| int FCCtrlUpDown::GetMinimum | ( | ) |
Returns the minimum value of the range for the up/down control.
Lua-supported.
◆ GetValue()
| int FCCtrlUpDown::GetValue | ( | ) |
Returns the current value of the Up/Down control.
Lua-supported.
◆ SetRange()
| void FCCtrlUpDown::SetRange | ( | int | min, |
| int | max | ||
| ) |
Sets the range of the up/down control.
Lua-supported.
◆ SetValue()
| void FCCtrlUpDown::SetValue | ( | int | value | ) |
Sets the value of the Up/Down control and updates the conneced edit field, if necessary.
Lua-supported.
