Functions
Dialog Rectangles

Functions

void mdlDialog_dialogBevelDraw (MSDialogP dbP)
 Draws a bevel around the specified Dialog Box. More...
 
void mdlDialog_rectClearBevel (MSDialogP dbP, BSIRectCP rP)
 Erases the bevel or edge of the rectangle pointed at by rP from the specified Dialog Box. More...
 
void mdlDialog_rectDraw (MSDialogP dbP, BSIRectCP rP, int colorIndex)
 Draws the outline in a Dialog Box in a color specified by a color index. More...
 
void mdlDialog_rectDrawCD (MSDialogP dbP, BSIRectCP rP, BSIRectCP clipRectP, BSIColorDescrCP colorP, RawItemHdrP riP)
 Draws the outline in a Dialog Box in a color specified by a color index. More...
 
void mdlDialog_rectDrawBeveled (MSDialogP dbP, BSIRectCP rP, bool raised, bool wide)
 Draws a bevel around the rectangle pointed at by rP in the specified Dialog Box. More...
 
void mdlDialog_rectDrawBeveledCD (MSDialogP dbP, BSIRectCP rP, bool raised, bool wide, BSIRectCP clipRectP, BSIColorDescrCP topShadowP, BSIColorDescrCP bottomShadowP, RawItemHdrP riP)
 Draws a bevel, using a specified Color Descriptor, around the rectangle pointed at by rP in the specified Dialog Box. More...
 
void mdlDialog_rectDrawDropShadowCD (MSDialogP dbP, BSIRectCP rP, BSIRectCP clipRectP, BSIColorDescrCP frameColorP, BSIColorDescrCP bottomShadowP, RawItemHdrP riP)
 Draws only the bottom lines of a rectangle pointed at by rP in the specified Dialog Box. More...
 
void mdlDialog_rectDrawEdge (MSDialogP dbP, BSIRectCP rP, bool raised)
 The mdlDialog_rectDrawEdge function draws a raised or recessed edge around the rectangle pointed at by rP in the specified Dialog Box. More...
 
void mdlDialog_rectDrawEdgeCD (MSDialogP dbP, BSIRectCP rP, bool raised, BSIRectCP clipRectP, BSIColorDescrCP topShadowP, BSIColorDescrCP bottomShadowP, RawItemHdrP riP)
 The mdlDialog_rectDrawEdgeCD function draws a raised or recessed edge, using a specified Color Descriptor, around the rectangle pointed at by rP in the specified Dialog Box. More...
 
bool mdlRect_equal (BSIRectCP rect1P, BSIRectCP rect2P)
 Checks two rectangle definitions for equality. More...
 
void mdlDialog_rectFill (MSDialogP dbP, BSIRectCP rP, int colorIndex)
 Draws a filled rectangle in a Dialog Box in a color specified by a color index. More...
 
void mdlDialog_rectFillCD (MSDialogP dbP, BSIRectCP rP, BSIRectCP clipRectP, BSIColorDescrCP fillP, RawItemHdrP riP)
 Draws a filled rectangle in a Dialog Box in a color specified by a color index. More...
 
int mdlRect_height (BSIRectCP rP)
 Returns the height of the rectangle pointed at by rP. More...
 
void mdlRect_inset (BSIRectP rP, int deltaX, int deltaY)
 Insets the rectangle pointed at by rP. More...
 
void mdlDialog_rectInvert (MSDialog *dbP, BSIRectCP rP)
 Inverts the color of the rectangle pointed at by rP, in the specified Dialog Box. More...
 
void mdlRect_offset (BSIRectP rP, int dx, int dy)
 Offsets the rectangle pointed at by rP by dx in the x direction and dy in the y direction. More...
 
bool mdlRect_pointInside (BSIRectCP rP, Point2dCP ptP)
 Determines if a given point is within a given rectangle. More...
 
void mdlRect_set (BSIRectP rP, int left, int top, int right, int bottom)
 Sets the rectangle pointed at by rP to have its left, right, top and bottom edges set to left, right, top and bottom, respectively. More...
 
int mdlRect_width (BSIRectCP rP)
 Returns the width of the rectangle pointed at by rP. More...
 

Detailed Description

Function Documentation

void mdlDialog_dialogBevelDraw ( MSDialogP  dbP)

Draws a bevel around the specified Dialog Box.

Parameters
[in]dbPMSDialog to draw beveled rectangle in
See also
mdlDialog_rectDraw
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectClearBevel ( MSDialogP  dbP,
BSIRectCP  rP 
)

Erases the bevel or edge of the rectangle pointed at by rP from the specified Dialog Box.

Parameters
[in]dbPMSDialog to clear
[in]rParea to clear
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDraw ( MSDialogP  dbP,
BSIRectCP  rP,
int  colorIndex 
)

Draws the outline in a Dialog Box in a color specified by a color index.

mdlDialog_rectDrawCD draws a rectangle outline in a Dialog Box in a color specified by a color descriptor.

Parameters
[in]dbPindicates the Dialog Box to draw in.
[in]rPdefines the rectangle to be drawn.
[in]colorIndexparameter specifies a color index for drawing. Its usual value is WHITE_INDEX, BLACK_INDEX, LGREY_INDEX or DGREY_INDEX. See msdefs.h for the complete list of possible color indexes.
See also
mdlDialog_rectFill mdlDialog_rectInvert mdlDialog_rectClearBevel mdlDialog_rectDrawBeveled mdlDialog_rectDrawEdge "Color"
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDrawBeveled ( MSDialogP  dbP,
BSIRectCP  rP,
bool  raised,
bool  wide 
)

Draws a bevel around the rectangle pointed at by rP in the specified Dialog Box.

Parameters
[in]dbPMSDialog to draw beveled rectangle in
[in]rPbeveled rectangle
[in]raisedif the parameter is true, the rectangle edge appears raised from the surface of the Dialog Box. Otherwise it appears recessed into the Dialog Box surface. For example, the group box item is drawn with the raised parameter set to false.
[in]wideif the parameter is true, the rectangle will have a two pixel wide bevel. Otherwise, the bevel will only be one pixel wide.
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDrawBeveledCD ( MSDialogP  dbP,
BSIRectCP  rP,
bool  raised,
bool  wide,
BSIRectCP  clipRectP,
BSIColorDescrCP  topShadowP,
BSIColorDescrCP  bottomShadowP,
RawItemHdrP  riP 
)

Draws a bevel, using a specified Color Descriptor, around the rectangle pointed at by rP in the specified Dialog Box.

Parameters
[in]dbPMSDialog to draw beveled rectangle in
[in]rPbeveled rectangle
[in]raisedif the parameter is true, the rectangle edge appears raised from the surface of the Dialog Box. Otherwise it appears recessed into the Dialog Box surface. For example, the group box item is drawn with the raised parameter set to false.
[in]wideif the parameter is true, the rectangle will have a two pixel wide bevel. Otherwise, the bevel will only be one pixel wide.
[in]clipRectPis a clipping rectangle (any drawing outside this rectangle is suppressed).
[in]topShadowPspecifies the Color Descriptor to use when drawing the top shadow
[in]bottomShadowPspecifies the Color Descriptor to use when drawing the bottom shadow
[in]riPis only used if topShadowP or bottomShadowP is NULL. In that case, it indicates a dialog item from which to get the values. The foreground color associated with the item is used.
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDrawCD ( MSDialogP  dbP,
BSIRectCP  rP,
BSIRectCP  clipRectP,
BSIColorDescrCP  colorP,
RawItemHdrP  riP 
)

Draws the outline in a Dialog Box in a color specified by a color index.

mdlDialog_rectDrawCD draws a rectangle outline in a Dialog Box in a color specified by a color descriptor.

Parameters
[in]dbPindicates the Dialog Box to draw in.
[in]rPdefines the rectangle to be drawn.
[in]clipRectPis a clipping rectangle (any drawing outside this rectangle is suppressed).
[in]clipRectPclip rect
[in]colorPis a BSIColorDescr pointer, usually obtained from a DgnPlatform::BSIColorPalette.
[in]riPis only used if colorP is NULL. In that case, it indicates a dialog item from which to get the value of colorP. The foreground color associated with the item is used.
See also
mdlDialog_rectFill mdlDialog_rectInvert mdlDialog_rectClearBevel mdlDialog_rectDrawBeveled mdlDialog_rectDrawEdge
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDrawDropShadowCD ( MSDialogP  dbP,
BSIRectCP  rP,
BSIRectCP  clipRectP,
BSIColorDescrCP  frameColorP,
BSIColorDescrCP  bottomShadowP,
RawItemHdrP  riP 
)

Draws only the bottom lines of a rectangle pointed at by rP in the specified Dialog Box.

Parameters
[in]dbPMSDialog to draw beveled rectangle in
[in]rPbeveled rectangle
[in]clipRectPis a clipping rectangle (any drawing outside this rectangle is suppressed).
[in]frameColorPspecifies the Color Descriptor to use when drawing the frame of the bottom line
[in]bottomShadowPspecifies the Color Descriptor to use when drawing the bottom shadow
[in]riPis only used if frameColorP or bottomShadowP is NULL. In that case, it indicates a dialog item from which to get the values.
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDrawEdge ( MSDialogP  dbP,
BSIRectCP  rP,
bool  raised 
)

The mdlDialog_rectDrawEdge function draws a raised or recessed edge around the rectangle pointed at by rP in the specified Dialog Box.

Parameters
[in]dbPMSDialog to draw 3D rectangular edge in
[in]rPrectangular edge
[in]raisedif the parameter is true, the rectangle edge appears raised from the surface of the Dialog Box. Otherwise it appears recessed into the dialog box surface. For example, the group box item is drawn with the raised parameter set to false.
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectDrawEdgeCD ( MSDialogP  dbP,
BSIRectCP  rP,
bool  raised,
BSIRectCP  clipRectP,
BSIColorDescrCP  topShadowP,
BSIColorDescrCP  bottomShadowP,
RawItemHdrP  riP 
)

The mdlDialog_rectDrawEdgeCD function draws a raised or recessed edge, using a specified Color Descriptor, around the rectangle pointed at by rP in the specified Dialog Box.

Parameters
[in]dbPMSDialog to draw 3D rectangular edge in
[in]rPrectangular edge
[in]raisedif the parameter is true, the rectangle edge appears raised from the surface of the Dialog Box. Otherwise it appears recessed into the dialog box surface. For example, the group box item is drawn with the raised parameter set to false.
[in]clipRectPis a clipping rectangle (any drawing outside this rectangle is suppressed).
[in]topShadowPspecifies the Color Descriptor to use when drawing the top shadow
[in]bottomShadowPspecifies the Color Descriptor to use when drawing the bottom shadow
[in]riPis only used if topShadowP or bottomShadowP is NULL. In that case, it indicates a dialog item from which to get the values. The foreground color associated with the item is used.
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectFill ( MSDialogP  dbP,
BSIRectCP  rP,
int  colorIndex 
)

Draws a filled rectangle in a Dialog Box in a color specified by a color index.

mdlDialog_rectFillCD draws a filled rectangle in a Dialog Box in a color specified by a color descriptor.

Parameters
[in]dbPindicates the Dialog Box to draw in.
[in]rPdefines the rectangle to be drawn.
[in]colorIndexparameter specifies a color index for drawing. Its usual value is WHITE_INDEX, BLACK_INDEX, LGREY_INDEX or DGREY_INDEX. See msdefs.h for the complete list of possible color indexes.
See also
mdlDialog_rectDraw mdlDialog_rectInvert mdlDialog_rectClearBevel mdlDialog_rectDrawBeveled mdlDialog_rectDrawEdge
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectFillCD ( MSDialogP  dbP,
BSIRectCP  rP,
BSIRectCP  clipRectP,
BSIColorDescrCP  fillP,
RawItemHdrP  riP 
)

Draws a filled rectangle in a Dialog Box in a color specified by a color index.

mdlDialog_rectFillCD draws a filled rectangle in a Dialog Box in a color specified by a color descriptor.

Parameters
[in]dbPindicates the Dialog Box to draw in.
[in]rPdefines the rectangle to be drawn.
[in]clipRectPis a clipping rectangle (any drawing outside this rectangle is suppressed).
[in]fillPis a BSIColorDescr pointer, usually obtained from a DgnPlatform::BSIColorPalette.
[in]riPis only used if fillP is NULL. In that case, it indicates a dialog item from which to get the value of fillP. The foreground color associated with the item is used.
See also
mdlDialog_rectDraw mdlDialog_rectInvert mdlDialog_rectClearBevel mdlDialog_rectDrawBeveled mdlDialog_rectDrawEdge
Remarks
Required Library: mdlbltin.lib
void mdlDialog_rectInvert ( MSDialog dbP,
BSIRectCP  rP 
)

Inverts the color of the rectangle pointed at by rP, in the specified Dialog Box.

Parameters
[in]dbPMSDialog to affect
[in]rParea to invert color of
See also
mdlDialog_rectDraw mdlDialog_rectFill
Remarks
Required Library: mdlbltin.lib
bool mdlRect_equal ( BSIRectCP  rect1P,
BSIRectCP  rect2P 
)

Checks two rectangle definitions for equality.

Two rectangles are equal if they have identical coordinates at all four corners.

Parameters
[in]rect1Pfirst rectangle to compare.
[in]rect2Psecond rectangle to compare.
Returns
true if the rectangles are identical, or false if not.
Remarks
Required Library: mdlbltin.lib
int mdlRect_height ( BSIRectCP  rP)

Returns the height of the rectangle pointed at by rP.

Parameters
[in]rPrectangle to get the height of
Returns
The width of the rectangle pointed to by rP, mdlRect_height returns the height of the rectangle pointed at by rP.
Remarks
Required Library: mdlbltin.lib
void mdlRect_inset ( BSIRectP  rP,
int  deltaX,
int  deltaY 
)

Insets the rectangle pointed at by rP.

The deltaX parameter specifies the distance the left and right edges are moved in by. The deltaY parameter specifies the distance the top and bottom edges are moved in by.

Parameters
[in]rPrectangle to inset
[in]deltaXpositve moves in
[in]deltaYpostive moves in
Remarks
Required Library: mdlbltin.lib
void mdlRect_offset ( BSIRectP  rP,
int  dx,
int  dy 
)

Offsets the rectangle pointed at by rP by dx in the x direction and dy in the y direction.

Parameters
[in]rPrectangle to offset
[in]dxx offset amount
[in]dyy offset amount
Remarks
Required Library: mdlbltin.lib
bool mdlRect_pointInside ( BSIRectCP  rP,
Point2dCP  ptP 
)

Determines if a given point is within a given rectangle.

Parameters
[in]rPpoints to the rectangle to check, and ptP points to the point to check.
[in]ptPpoint to check
Returns
true if the point pointed to by ptP is within the rectangle pointed to by rP, otherwise false.
Remarks
Required Library: mdlbltin.lib
void mdlRect_set ( BSIRectP  rP,
int  left,
int  top,
int  right,
int  bottom 
)

Sets the rectangle pointed at by rP to have its left, right, top and bottom edges set to left, right, top and bottom, respectively.

Parameters
[in]rPrectangle to set
[in]leftnew left edge of rect
[in]topnew top edge of rect
[in]rightnew right edge of rect
[in]bottomnew bottom edge of rect
Remarks
Required Library: mdlbltin.lib
int mdlRect_width ( BSIRectCP  rP)

Returns the width of the rectangle pointed at by rP.

Parameters
[in]rPrectangle to get width of
Returns
The width of the rectangle pointed at by rP.
Remarks
Required Library: mdlbltin.lib

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