Functions

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]minValuePis the minimum value for the Scale dialog item. Pass NULL in this argument if you do not want this value returned.
[in,out]maxValuePis the maximum value for the Scale dialog item. Pass NULL in this argument if you do not want this value returned.
[in,out]incAmountPis 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]pageIncAmountPis 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]associatedTextIdPis 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]minLabelis 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]maxLabelis 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]isVerticalPis 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]showValuePis 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]hasArrowsPis 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]limitsOnSidePis 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]formatToDisplayis 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]scalePis 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]minValuePis the minimum value for the Scale dialog item. Pass NULL in this argument if you do not want to set this value.
[in]maxValuePis the maximum value for the Scale dialog item. Pass NULL in this argument if you do not want to set this value.
[in]incAmountPis 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]pageIncAmountPis 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]associatedTextIdPis 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]minLabelis 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]maxLabelis 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]isVerticalPis 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]showValuePis 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]hasArrowsPis 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]limitsOnSidePis 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]formatToDisplayis 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]redrawset true to redraw after setting limits on side
[in]scalePis 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

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.