Class containing printing settings (and the ability to print documents). More...

#include <ff_base.h>

Inheritance diagram for FCPrintSettings:

Public Types
enum	PRINTODDEVENMODES { PRINTODDEVEN_ALL = 0 , PRINTODDEVEN_ODD = 1 , PRINTODDEVEN_EVEN = 2 }
	Constants used for printing odd/even pages. Used with the GetOddEvenMode() and SetOddEvenMode() methods. More...

Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID { FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT , FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE , FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , 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_ENIGMATEXTSTYLE , 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_KEYMODEDEF , 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...

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

	FCPrintSettings ()
	The constructor.

twobyte	GetCopyCount () const
	Returns the number of copies to print.

bool	GetColor () const
	Returns true if color printing should be used.

twobyte	GetStartPage () const
	Returns the 1-based start page for printing.

twobyte	GetEndPage () const
	Returns the 1-based end page for printing.

bool	GetReverse () const
	Returns if the pages should be printed in reverse order.

bool	GetDrawCropMarks () const
	Returns if crop marks should be printed.

bool	GetDrawRegistrationMarks () const
	Returns if registration marks should be printed.

bool	GetDrawFileName () const
	Returns if the file name should be printed.

bool	GetTile () const
	Returns if the document should be tited if bigger than specified page.

twobyte	GetLayoutCount () const
	Returns the n-Up layout value. Can be 0, 1, 2, 4.

Evpu32	GetTileOverlap () const
	Returns the user overlap for tiled pages.

bool	GetFitWithinMargins () const
	Returns whether to use the printer margins when fitting a page to print.

PRINTODDEVENMODES	GetOddEvenMode () const
	Returns the odd/even printing mode.

const char *	GetPageRangeString () const
	Returns the page range string as a C-style string.

void	SetCopyCount (twobyte copies)
	Sets the number of copies to print.

void	SetColor (bool state)
	Sets if color printing should be used.

void	SetStartPage (twobyte startpage)
	Sets the 1-based start page.

void	SetEndPage (twobyte endpage)
	Sets the 1-based end page.

void	SetReverse (bool state)
	Sets if the pages should be printed in reverse order.

void	SetDrawCropMarks (bool state)
	Sets if crop marks should be printed.

void	SetDrawRegistrationMarks (twobyte state)
	Sets if registration marks should be printed.

void	SetDrawFileName (bool state)
	Sets if the file name should be printed.

void	SetTile (bool state)
	Sets if the document should be tited if bigger than specified page.

void	SetLayoutCount (twobyte count)
	Sets the n-Up layout value. Can be 0, 1, 2, 4.

void	SetTileOverlap (Evpu32 value)
	Sets the user overlap for tiled pages.

void	SetFitWithinMargins (bool state)
	Sets whether to use the printer margins when fitting a page to print.

void	SetOddEvenMode (PRINTODDEVENMODES value)
	Sets the odd/even printing mode.

void	SetPageRangeString (const char *pszString)
	Returns the page range string as a C-style string.

bool	PrintCurrent ()
	Prints the current document. The current printer will be used. The document's current list of selected parts for printing will be used.

bool	PrintDocument (FCDocument *pDocument)
	Prints a specific document. The current printer will be used. The document's current list of selected parts for printing will be used.

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.

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.

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.

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.

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

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

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

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

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

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

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.

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.

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.

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

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

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

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

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

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

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

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

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.

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.

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.

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.

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

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

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

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

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.

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.

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.

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.

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

Additional Inherited Members
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.

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.

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.

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.

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.

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.

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.

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.

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".

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.

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.

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

Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

Detailed Description

Class containing printing settings (and the ability to print documents).

These settings can only be used printing for directly. They can't be used for loading/saving the settings from/to Finale.

Member Enumeration Documentation

◆ PRINTODDEVENMODES

enum FCPrintSettings::PRINTODDEVENMODES

Constants used for printing odd/even pages. Used with the GetOddEvenMode() and SetOddEvenMode() methods.

Lua-supported.

Enumerator
PRINTODDEVEN_ALL	Print both odd and even pages.
PRINTODDEVEN_ODD	Print only odd pages.
PRINTODDEVEN_EVEN	Printe only even pages.

Constructor & Destructor Documentation

◆ FCPrintSettings()

FCPrintSettings::FCPrintSettings ( )

inline

The constructor.

The default setup is printing 1 copy between page 1 and 1000;

Lua-supported.

Member Function Documentation

◆ ClassName()

const char * FCPrintSettings::ClassName ( ) const

inlineoverridevirtual

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

Lua-supported.

Implements __FCBase.

◆ GetColor()

bool FCPrintSettings::GetColor ( ) const

inline

Returns true if color printing should be used.

Lua-supported (also as property).

◆ GetCopyCount()

twobyte FCPrintSettings::GetCopyCount ( ) const

inline

Returns the number of copies to print.

Lua-supported (also as property).

◆ GetDrawCropMarks()

bool FCPrintSettings::GetDrawCropMarks ( ) const

inline

Returns if crop marks should be printed.

Lua-supported (also as property).

◆ GetDrawFileName()

bool FCPrintSettings::GetDrawFileName ( ) const

inline

Returns if the file name should be printed.

Lua-supported (also as property).

◆ GetDrawRegistrationMarks()

bool FCPrintSettings::GetDrawRegistrationMarks ( ) const

inline

Returns if registration marks should be printed.

Lua-supported (also as property).

◆ GetEndPage()

twobyte FCPrintSettings::GetEndPage ( ) const

inline

Returns the 1-based end page for printing.

Lua-supported (also as property).

◆ GetFitWithinMargins()

bool FCPrintSettings::GetFitWithinMargins ( ) const

inline

Returns whether to use the printer margins when fitting a page to print.

Lua-supported (also as property).

◆ GetLayoutCount()

twobyte FCPrintSettings::GetLayoutCount ( ) const

inline

Returns the n-Up layout value. Can be 0, 1, 2, 4.

Lua-supported (also as property).

◆ GetOddEvenMode()

PRINTODDEVENMODES FCPrintSettings::GetOddEvenMode ( ) const

inline

Returns the odd/even printing mode.

Lua-supported (also as property).

Returns: Any of the PRINTODDEVEN_ constants.

◆ GetPageRangeString()

const char * FCPrintSettings::GetPageRangeString ( ) const

inline

Returns the page range string as a C-style string.

Lua-supported (also as property).

◆ GetReverse()

bool FCPrintSettings::GetReverse ( ) const

inline

Returns if the pages should be printed in reverse order.

Lua-supported (also as property).

◆ GetStartPage()

twobyte FCPrintSettings::GetStartPage ( ) const

inline

Returns the 1-based start page for printing.

Lua-supported (also as property).

◆ GetTile()

bool FCPrintSettings::GetTile ( ) const

inline

Returns if the document should be tited if bigger than specified page.

Lua-supported (also as property).

◆ GetTileOverlap()

Evpu32 FCPrintSettings::GetTileOverlap ( ) const

inline

Returns the user overlap for tiled pages.

Lua-supported (also as property).

◆ PrintCurrent()

bool FCPrintSettings::PrintCurrent ( )

Prints the current document. The current printer will be used. The document's current list of selected parts for printing will be used.

Lua-supported.

Returns: True on success.

◆ PrintDocument()

bool FCPrintSettings::PrintDocument ( FCDocument * pDocument )

Prints a specific document. The current printer will be used. The document's current list of selected parts for printing will be used.

Lua-supported.

Parameters

pDocument Pointer to a FCDocument object to print.

Returns: True on success.

◆ SetColor()

void FCPrintSettings::SetColor ( bool state )

inline

Sets if color printing should be used.

Lua-supported (also as property).

◆ SetCopyCount()

void FCPrintSettings::SetCopyCount ( twobyte copies )

inline

Sets the number of copies to print.

Lua-supported (also as property).

Parameters

copies A range between 0 and 100 is allowed.

◆ SetDrawCropMarks()

void FCPrintSettings::SetDrawCropMarks ( bool state )

inline

Sets if crop marks should be printed.

Lua-supported (also as property).

◆ SetDrawFileName()

void FCPrintSettings::SetDrawFileName ( bool state )

inline

Sets if the file name should be printed.

Lua-supported (also as property).

◆ SetDrawRegistrationMarks()

void FCPrintSettings::SetDrawRegistrationMarks ( twobyte state )

inline

Sets if registration marks should be printed.

Lua-supported (also as property).

◆ SetEndPage()

void FCPrintSettings::SetEndPage ( twobyte endpage )

inline

Sets the 1-based end page.

Lua-supported (also as property).

◆ SetFitWithinMargins()

void FCPrintSettings::SetFitWithinMargins ( bool state )

inline

Sets whether to use the printer margins when fitting a page to print.

Lua-supported (also as property).

◆ SetLayoutCount()

void FCPrintSettings::SetLayoutCount ( twobyte count )

inline

Sets the n-Up layout value. Can be 0, 1, 2, 4.

Lua-supported (also as property).

Parameters

count Either 0, 1, 2 or 4. 0 and 1 gives identical results.

◆ SetOddEvenMode()

void FCPrintSettings::SetOddEvenMode ( PRINTODDEVENMODES value )

inline

Sets the odd/even printing mode.

Lua-supported (also as property).

Parameters

value Any of the PRINTODDEVEN_ constants.

◆ SetPageRangeString()

void FCPrintSettings::SetPageRangeString ( const char * pszString )

inline

Returns the page range string as a C-style string.

Lua-supported (also as property).

◆ SetReverse()

void FCPrintSettings::SetReverse ( bool state )

inline

Sets if the pages should be printed in reverse order.

Lua-supported (also as property).

◆ SetStartPage()

void FCPrintSettings::SetStartPage ( twobyte startpage )

inline

Sets the 1-based start page.

Lua-supported (also as property).

◆ SetTile()

void FCPrintSettings::SetTile ( bool state )

inline

Sets if the document should be tited if bigger than specified page.

Lua-supported (also as property).

◆ SetTileOverlap()

void FCPrintSettings::SetTileOverlap ( Evpu32 value )

inline

Sets the user overlap for tiled pages.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PRINTODDEVENMODES

Constructor & Destructor Documentation

◆ FCPrintSettings()

Member Function Documentation

◆ ClassName()

◆ GetColor()

◆ GetCopyCount()

◆ GetDrawCropMarks()

◆ GetDrawFileName()

◆ GetDrawRegistrationMarks()

◆ GetEndPage()

◆ GetFitWithinMargins()

◆ GetLayoutCount()

◆ GetOddEvenMode()

◆ GetPageRangeString()

◆ GetReverse()

◆ GetStartPage()

◆ GetTile()

◆ GetTileOverlap()

◆ PrintCurrent()

◆ PrintDocument()

◆ SetColor()

◆ SetCopyCount()

◆ SetDrawCropMarks()

◆ SetDrawFileName()

◆ SetDrawRegistrationMarks()

◆ SetEndPage()

◆ SetFitWithinMargins()

◆ SetLayoutCount()

◆ SetOddEvenMode()

◆ SetPageRangeString()

◆ SetReverse()

◆ SetStartPage()

◆ SetTile()

◆ SetTileOverlap()