Functions
ScrollBar Item

Functions

StatusInt mdlDialog_scrollBarSetRange (RawItemHdr *sbarP, double sliderSize, int minValue, int maxValue, int incAmount, int pageIncAmount)
 Sets the range information associated with the Scroll Bar item specified by the sbarP parameter. More...
 
StatusInt mdlDialog_scrollBarSetRangeRedraw (RawItemHdr *sbarP, double sliderSize, int minValue, int maxValue, int incAmount, int pageIncAmount, bool redraw)
 Sets the range information associated with the Scroll Bar item specified by the sbarP parameter. More...
 
StatusInt mdlDialog_scrollBarGetInfo (long *minValueP, long *maxValueP, long *incAmountP, long *pageIncAmountP, double *sliderSizeP, bool *isVerticalP, RawItemHdr *sbarP)
 Gets information on Scroll Bar items. More...
 
StatusInt mdlDialog_scrollBarSetInfo (long *minValueP, long *maxValueP, long *incAmountP, long *pageIncAmountP, double *sliderSizeP, bool *isVerticalP, bool redraw, RawItemHdr *sbarP)
 Sets information on Scroll Bar items. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_scrollBarGetInfo ( long *  minValueP,
long *  maxValueP,
long *  incAmountP,
long *  pageIncAmountP,
double *  sliderSizeP,
bool *  isVerticalP,
RawItemHdr sbarP 
)

Gets information on Scroll Bar items.

For each of the pointer variables below except sbarP, NULL indicates the information is not desired.

Parameters
[out]minValuePpoints to a variable indicating the minimum possible value of the variable associated with the Scroll Bar.
[out]maxValuePpoints to a variable indicating the maximum possible value of the variable associated with the Scroll Bar.
[out]incAmountPpoints to a variable indicating the amount by which to increase or decrease the associated variable when the user clicks on the arrows in the Scroll Bar to single-step.
[out]pageIncAmountPpoints to a variable indicating the amount by which to increase or decrease the associated variable when the user clicks on the areas between the slider and the arrows in the Scroll Bar.
[out]sliderSizePpoints to a variable indicating the size of the slider to be displayed in the Scroll Bar. Values between 0 and 1 are valid. The slider is never smaller than a square inside the Scroll Bar.
[out]isVerticalPIf isVerticalP is true, the Scroll Bar is displayed vertically. Otherwise, it is horizontal.
[in]sbarPpoints to the RawItemHdr of the Scroll Bar for which to get or set information.
Returns
SUCCESS if successful, or non-zero if an error occurred.
See also
mdlDialog_scrollBarSetInfo
StatusInt mdlDialog_scrollBarSetInfo ( long *  minValueP,
long *  maxValueP,
long *  incAmountP,
long *  pageIncAmountP,
double *  sliderSizeP,
bool *  isVerticalP,
bool  redraw,
RawItemHdr sbarP 
)

Sets information on Scroll Bar items.

For each of the pointer variables below except sbarP, NULL indicates the Scroll Bar information is not to be changed.

Parameters
[in]minValuePpoints to a variable indicating the minimum possible value of the variable associated with the Scroll Bar.
[in]maxValuePpoints to a variable indicating the maximum possible value of the variable associated with the Scroll Bar.
[in]incAmountPpoints to a variable indicating the amount by which to increase or decrease the associated variable when the user clicks on the arrows in the Scroll Bar to single-step.
[in]pageIncAmountPpoints to a variable indicating the amount by which to increase or decrease the associated variable when the user clicks on the areas between the slider and the arrows in the Scroll Bar.
[in]sliderSizePpoints to a variable indicating the size of the slider to be displayed in the Scroll Bar. Values between 0 and 1 are valid. The slider is never smaller than a square inside the Scroll Bar.
[in]isVerticalPIf isVerticalP is true, the Scroll Bar is displayed vertically. Otherwise, it is horizontal.
[in]redrawIf redraw is true, the Scroll Bar is redrawn after mdlDialog_scrollBarSetInfo is finished.
[in]sbarPpoints to the RawItemHdr of the Scroll Bar for which to get or set information.
Returns
SUCCESS if successful, or non-zero if an error occurred.
StatusInt mdlDialog_scrollBarSetRange ( RawItemHdr sbarP,
double  sliderSize,
int  minValue,
int  maxValue,
int  incAmount,
int  pageIncAmount 
)

Sets the range information associated with the Scroll Bar item specified by the sbarP parameter.

Parameters
[in]sbarPScroll Bar item
[in]sliderSizerelative size of slider
[in]minValuemin value of Scroll Bar
[in]maxValuemax value of Scroll Bar
[in]incAmountarrow click scroll amount
[in]pageIncAmountpage scroll amount
Remarks
The parameters other than sbarP are analogous to those found in the DItem_ScrollBarRsc structure. See the "Scroll Bar Item" section of the "Standard Dialog Items" chapter for more information on the DItem_ScrollBarRsc structure.
Returns
SUCCESS, or non-zero value if an error occurs. This means that sbarP does not point to a Scroll Bar item.
See also
mdlDialog_scrollArrowDraw
StatusInt mdlDialog_scrollBarSetRangeRedraw ( RawItemHdr sbarP,
double  sliderSize,
int  minValue,
int  maxValue,
int  incAmount,
int  pageIncAmount,
bool  redraw 
)

Sets the range information associated with the Scroll Bar item specified by the sbarP parameter.

Parameters
[in]sbarPScroll Bar item
[in]sliderSizerelative size of slider
[in]minValuemin value of Scroll Bar
[in]maxValuemax value of Scroll Bar
[in]incAmountarrow click of scroll amount
[in]pageIncAmountpage scroll amount
[in]redrawtrue means redraw
Remarks
The parameters other than sbarP are analogous to those found in the DItem_ScrollBarRsc structure. See the "Scroll Bar Item" section of the "Standard Dialog Items" chapter for more information on the DItem_ScrollBarRsc structure. The redraw parameter, if true, forces the Scroll Bar to be redrawn when the function ends.
Returns
SUCCESS, or non-zero value if an error occurs. This means that sbarP does not point to a Scroll Bar item.

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