ScaleItem

Functions
StatusInt	mdlDialog_scaleGetInfo (double *minValueP, double *maxValueP, double *incAmountP, double *pageIncAmountP, long *associatedTextIdP, WStringP minLabel, WStringP maxLabel, bool *isVerticalP, bool *showValueP, bool *hasArrowsP, bool *limitsOnSideP, WStringP formatToDisplay, RawItemHdr *scaleP)
	Retrieves information about a Scale dialog item. More...
StatusInt	mdlDialog_scaleSetInfo (double *minValueP, double *maxValueP, double *incAmountP, double *pageIncAmountP, long *associatedTextIdP, WCharCP minLabel, WCharCP maxLabel, bool *isVerticalP, bool *showValueP, bool *hasArrowsP, bool *limitsOnSideP, WCharCP formatToDisplay, bool redraw, RawItemHdr *scaleP)
	Sets information on a Scale dialog item. More...

Detailed Description

Function Documentation

StatusInt mdlDialog_scaleGetInfo	(	double *	minValueP,
		double *	maxValueP,
		double *	incAmountP,
		double *	pageIncAmountP,
		long *	associatedTextIdP,
		WStringP	minLabel,
		WStringP	maxLabel,
		bool *	isVerticalP,
		bool *	showValueP,
		bool *	hasArrowsP,
		bool *	limitsOnSideP,
		WStringP	formatToDisplay,
		RawItemHdr *	scaleP
	)

Retrieves information about a Scale dialog item.

Parameters

[out]	minValueP	is the minimum value for the Scale dialog item. Pass NULL in this argument if you do not want this value returned.
[in,out]	maxValueP	is the maximum value for the Scale dialog item. Pass NULL in this argument if you do not want this value returned.
[in,out]	incAmountP	is the amount by which the Scale slider is incremented if the user clicks on the arrow button. Pass NULL in this argument if you do not want this value returned.
[in,out]	pageIncAmountP	is the amount by which the Scale slider is incremented if the user clicks in the page area of the scale. Pass NULL in this argument if you do not want this value returned.
[in,out]	associatedTextIdP	is the resource ID of a Text item associated with the scaled item. Pass NULL in this argument if you do not want this value returned.
[in,out]	minLabel	is the label showing the minimum value of the scale item. Pass NULL in this argument if you do not want this value returned.
[in,out]	maxLabel	is the label showing the maximum value of the scale item. Pass NULL in this argument if you do not want this value returned.
[in,out]	isVerticalP	is true if the Scale item is in a vertical orientation. Pass NULL in this argument if you do not want this value returned.
[in,out]	showValueP	is true if the Scale item displays the exact value to which the Scale slider is set. Pass NULL in this argument if you do not want this value returned.
[in,out]	hasArrowsP	is true if the Scale item has single step adjustment arrows at either end. Pass NULL in this argument if you do not want this value returned.
[in,out]	limitsOnSideP	is true if the Scale limits are to be displayed on the sides of the scale, a common position for a vertically oriented scale. Pass NULL in this argument if you do not want this value returned.
[in,out]	formatToDisplay	is an sprintf format string used to convert the value of the Scale item into a display value when the value is displayed. Pass NULL in this argument if you do not want this value returned.
[in]	scaleP	is the Scale dialog item about which information will be retrieved.

Returns

SUCCESS, or a non-zero value if an error occurs.

See also

mdlDialog_scaleSetInfo

StatusInt mdlDialog_scaleSetInfo	(	double *	minValueP,
		double *	maxValueP,
		double *	incAmountP,
		double *	pageIncAmountP,
		long *	associatedTextIdP,
		WCharCP	minLabel,
		WCharCP	maxLabel,
		bool *	isVerticalP,
		bool *	showValueP,
		bool *	hasArrowsP,
		bool *	limitsOnSideP,
		WCharCP	formatToDisplay,
		bool	redraw,
		RawItemHdr *	scaleP
	)

Sets information on a Scale dialog item.

Parameters

[in]	minValueP	is the minimum value for the Scale dialog item. Pass NULL in this argument if you do not want to set this value.
[in]	maxValueP	is the maximum value for the Scale dialog item. Pass NULL in this argument if you do not want to set this value.
[in]	incAmountP	is the amount by which the Scale slider is incremented if the user clicks on the arrow button. Pass NULL in this argument if you do not want to set this value.
[in]	pageIncAmountP	is the amount by which the Scale slider is incremented if the user clicks in the page area of the scale. Pass NULL in this argument if you do not want to set this value.
[in]	associatedTextIdP	is the resource ID of a Text item associated with the scaled item. Pass NULL in this argument if you do not want to set this value.
[in]	minLabel	is the label showing the minimum value of the Scale item. Pass NULL in this argument if you do not want to set this value.
[in]	maxLabel	is the label showing the maximum value of the Scale item. Pass NULL in this argument if you do not want to set this value.
[in]	isVerticalP	is true if the Scale item is in a vertical orientation. Pass NULL in this argument if you do not want to set this value.
[in]	showValueP	is true if the Scale item displays the exact value to which the Scale slider is set. Pass NULL in this argument if you do not want to set this value.
[in]	hasArrowsP	is true if the Scale item has single step adjustment arrows at either end. Pass NULL in this argument if you do not want to set this value.
[in]	limitsOnSideP	is true if the Scale limits are to be displayed on the sides of the scale, a common position for a vertically oriented scale. Pass NULL in this argument if you do not want to set this value.
[in]	formatToDisplay	is an sprintf format string used to convert the value of the Scale item into a display value when the value is displayed. Pass NULL in this argument if you do not want to set this value.
[in]	redraw	set true to redraw after setting limits on side
[in]	scaleP	is the Scale dialog item about which information will be retrieved.

Returns

SUCCESS, or a non-zero value if an error occurs.

See also

mdlDialog_scaleGetInfo