Functions
SpinBox Item

Functions

StatusInt mdlDialog_spinBoxGetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, int *maxSizeP, WChar *formatToDisplayP, WChar *formatToInternalP, double *minimumP, double *maximumP, double *incAmountP, UInt32 *maskP, UInt32 *attributesP, RawItemHdr *spinBP)
 Retrieves attributes of SpinBox items. More...
 
StatusInt mdlDialog_spinBoxSetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, int *maxSizeP, WCharCP formatToDisplayP, WCharCP formatToInternalP, double *minimumP, double *maximumP, double *incAmountP, UInt32 *maskP, UInt32 *attributesP, bool redraw, RawItemHdr *spinBP)
 Sets attributes in SpinBox items. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_spinBoxGetInfo ( CommandNumber *  commandNumberP,
UInt32 commandSourceP,
int *  maxSizeP,
WChar *  formatToDisplayP,
WChar *  formatToInternalP,
double *  minimumP,
double *  maximumP,
double *  incAmountP,
UInt32 maskP,
UInt32 attributesP,
RawItemHdr spinBP 
)

Retrieves attributes of SpinBox items.

For all of the pointer parameters, NULL indicates the field is not desired.

Parameters
[out]commandNumberPset NULL if don't want cmd number
[out]commandSourcePset NULL if don't want cmd source
[out]maxSizePpoints to a variable indicating the maximum allowable size of the text string that can be contained by the SpinBox item, up to 32K characters.
[out]formatToDisplayPpoints to a sprintf format string to convert the value of the variable associated with the SpinBox item into a displayable string.
[out]formatToInternalPpoints to a sscanf format string to convert from the SpinBox item's string value to the format expected by the variable associated with the SpinBox item.
[out]minimumPpoints to a double that contains the minimum value of the SpinBox item.
[out]maximumPpoints to a double that contains the maximum value of the SpinBox item.
[out]incAmountPpoints to a double that contains the increment (and decrement) value.
[out]maskPset NULL if don't want mask
[out]attributesPpoints to an int that contains the SpinBox item's attributes. The bits that can be included are defined in dlogbox.r.h.
[in]spinBPspinbox item to get indo on
Returns
SUCCESS, or a non-zero value if there is an error.
StatusInt mdlDialog_spinBoxSetInfo ( CommandNumber *  commandNumberP,
UInt32 commandSourceP,
int *  maxSizeP,
WCharCP  formatToDisplayP,
WCharCP  formatToInternalP,
double *  minimumP,
double *  maximumP,
double *  incAmountP,
UInt32 maskP,
UInt32 attributesP,
bool  redraw,
RawItemHdr spinBP 
)

Sets attributes in SpinBox items.

For all of the pointer parameters, NULL indicates the field should not be modified.

Parameters
[in]commandNumberPset NULL if not setting cmd number
[in]commandSourcePset NULL if not setting cmd source
[in]maxSizePpoints to a variable indicating the maximum allowable size of the text string that can be contained by the SpinBox item, up to 32K characters.
[in]formatToDisplayPpoints to a sprintf format string to convert the value of the variable associated with the SpinBox item into a displayable string.
[in]formatToInternalPpoints to a sscanf format string to convert from the SpinBox item's string value to the format expected by the variable associated with the SpinBox item.
[in]minimumPpoints to a double that contains the minimum value of the SpinBox item.
[in]maximumPpoints to a double that contains the maximum value of the SpinBox item.
[out]incAmountPpoints to a double that contains the increment (and decrement) value.
[in]maskPset NULL if not setting mask
[in]attributesPpoints to an int that contains the SpinBox item's attributes. The bits that can be included are defined in dlogbox.r.h.
[in]redrawis a boolean flag indicating whether mdlDialog_spinBoxSetInfo should cause the SpinBox to be redrawn after the information is modified.
[in]spinBPSpinBox item to get info on
Returns
SUCCESS, or a non-zero value if there is an error.

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