Functions

Functions

StatusInt mdlDialog_sashGetInfo (int *topMarginP, int *bottomMarginP, RawItemHdr *sashP)
 Retrieves information about a Sash dialog item. More...
 
StatusInt mdlDialog_sashSetInfo (int *topMarginP, int *bottomMarginP, RawItemHdr *sashP)
 Sets information about a Sash dialog item. More...
 
StatusInt mdlDialog_sashGetInfoEx (int *topMarginP, int *bottomMarginP, UInt32 *attributesP, RawItemHdr *sashP)
 Retrieves information about a Sash dialog item. More...
 
StatusInt mdlDialog_sashSetInfoEx (int *topMarginP, int *bottomMarginP, UInt32 *attributesP, bool redraw, RawItemHdr *sashP)
 Sets information about a Sash dialog item. More...
 
bool mdlDialog_sashIsVertical (RawItemHdr *sashP)
 Determines whether the specified Sash item is oriented vertically. More...
 
StatusInt mdlDialog_sashSetSplitterHandle (RawItemHdr *sashP, GuiSplitterHandleP layoutHandle)
 Sets the GuiSplitterHandle associated with this Sash for layout purposes. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_sashGetInfo ( int *  topMarginP,
int *  bottomMarginP,
RawItemHdr sashP 
)

Retrieves information about a Sash dialog item.

Parameters
[in,out]topMarginPis the top margin value of the sash, returned in pixels. Pass NULL in this argument if you do not want to get this value.
[in,out]bottomMarginPis the bottom margin value of the sash, returned in pixels. Pass NULL in this argument if you do not want to get this value.
[in]sashPSash to get info from
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_sashSetInfo mdlDialog_sashGetInfoEx
StatusInt mdlDialog_sashGetInfoEx ( int *  topMarginP,
int *  bottomMarginP,
UInt32 attributesP,
RawItemHdr sashP 
)

Retrieves information about a Sash dialog item.

Parameters
[in,out]topMarginPis the top margin value of the sash, returned in pixels. Pass NULL in this argument if you do not want to get this value.
[in,out]bottomMarginPis the bottom margin value of the sash, returned in pixels. Pass NULL in this argument if you do not want to get this value.
[in,out]attributesPis the list of returned attributes that have been set for the Sash item.
[in]sashPis a pointer to the Sash item to get the information from.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_sashSetInfoEx mdlDialog_sashGetInfo
bool mdlDialog_sashIsVertical ( RawItemHdr sashP)

Determines whether the specified Sash item is oriented vertically.

Parameters
[in]sashPis the Sash item to test.
Returns
true if the item is vertical, false otherwise.
See also
mdlDialog_sashGetInfo
StatusInt mdlDialog_sashSetInfo ( int *  topMarginP,
int *  bottomMarginP,
RawItemHdr sashP 
)

Sets information about a Sash dialog item.

Parameters
[in]topMarginPis the top margin value for the Sash in pixels. Pass NULL in this argument if not setting this value.
[in]bottomMarginPis the bottom margin value for the Sash in pixels. Pass NULL in this argument if not setting this value.
[in]sashPis the Sash item to set the values on.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_sashGetInfo mdlDialog_sashSetInfoEx
StatusInt mdlDialog_sashSetInfoEx ( int *  topMarginP,
int *  bottomMarginP,
UInt32 attributesP,
bool  redraw,
RawItemHdr sashP 
)

Sets information about a Sash dialog item.

Parameters
[in]topMarginPis the top margin value for the Sash in pixels. Pass NULL in this argument if not setting this value.
[in]bottomMarginPis the bottom margin value for the Sash in pixels. Pass NULL in this argument if not setting this value.
[in]attributesPis a list of attributes to set for the Sash item. Pass NULL in this argument if not setting the attributes.
[in]redrawindicates whether the Sash item should be redrawn after updating.
[in]sashPis the Sash item to set the values on.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_sashGetInfoEx mdlDialog_sashSetInfo
StatusInt mdlDialog_sashSetSplitterHandle ( RawItemHdr sashP,
GuiSplitterHandleP  layoutHandle 
)

Sets the GuiSplitterHandle associated with this Sash for layout purposes.

Parameters
[in]sashPis the Sash item to set the SplitterHandle on.
[in]layoutHandleis the GuiSplitterHandle associated with this Sash.
Returns
SUCCESS, or a non-zero value if an error occurs.

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