Functions
Dialog Box Font

Functions

int mdlDialog_fontGetCurHeight (MSDialogP dbP)
 Returns the height of the font currently associated with a Dialog Box. More...
 
int mdlDialog_fontGetHeight (MSDialogP dbP, int fontIndex)
 Returns the height of a font assuming that it will be used in a specified Dialog Box. More...
 
StatusInt mdlDialog_fontGetInfo (WCharCP *nameP, int *avgWidthP, int *maxWidthP, int *heightP, MSDialogP dbP, int fontIndex)
 Retrieves information about the font specified by fontIndex assuming that it will be used in the specified Dialog Box. More...
 
int mdlDialog_fontIndexGet (MSDialogP dbP)
 Returns the index of the font currently associated with the specified Dialog Box. More...
 
StatusInt mdlDialog_fontIndexSet (MSDialogP dbP, int fontIndex)
 Sets the font associated with the specified Dialog Box to be fontIndex. More...
 
StatusInt mdlDialog_fontNameGet (WCharCP *fontNameP, MSDialogP dbP)
 Retrieves the name of the font specified by fontIndex assuming that it will be used in the specified Dialog Box. More...
 

Detailed Description

Function Documentation

int mdlDialog_fontGetCurHeight ( MSDialogP  dbP)

Returns the height of the font currently associated with a Dialog Box.

Parameters
[in]dbPis the Dialog Box to query.
Returns
The font height currently associated with the specified Dialog Box.
Remarks
The values returned by this function is specified in pixels.
See also
mdlDialog_fontGetInfo mdlDialog_fontIndexGet mdlDialog_fontIndexSet mdlDialog_fontNameGet mdlDialog_textDrawA mdlDialog_textDrawNA mdlDialog_stringWidth
Remarks
Required Library: mdlbltin.lib
int mdlDialog_fontGetHeight ( MSDialogP  dbP,
int  fontIndex 
)

Returns the height of a font assuming that it will be used in a specified Dialog Box.

Parameters
[in]dbPis the Dialog Box to query.
[in]fontIndexis the font whose height to get.
Returns
The height of the font, assuming that it will be used in the specified Dialog Box.
Remarks
The values returned by this function is specified in pixels.
See also
mdlDialog_fontGetInfo mdlDialog_fontIndexGet mdlDialog_fontIndexSet mdlDialog_fontNameGet mdlDialog_textDrawA mdlDialog_textDrawNA mdlDialog_stringWidth
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_fontGetInfo ( WCharCP *  nameP,
int *  avgWidthP,
int *  maxWidthP,
int *  heightP,
MSDialogP  dbP,
int  fontIndex 
)

Retrieves information about the font specified by fontIndex assuming that it will be used in the specified Dialog Box.

Parameters
[out]namePpoints at a WCharCP that will be set to point to the name of the font.
[out]avgWidthPpoints at an integer which will be set to the average width. If the value is NULL, then the caller does not need the corresponding value.
[out]maxWidthPpoints at an integer which will be set to the maximum width. If the value is NULL, then the caller does not need the corresponding value.
[out]heightPpoints at an integer which will be set to the height. If the value is NULL, then the caller does not need the corresponding value.
[in]dbPMSDialog font would be drawn in
[in]fontIndexindex of font, -1 means active
Returns
SUCCESS or ERROR if dbP is not a pointer to a Dialog Box.
See also
mdlDialog_fontIndexGet mdlDialog_fontIndexSet mdlDialog_fontGetCurHeight mdlDialog_fontGetHeight mdlDialog_textDrawA mdlDialog_textDrawNA mdlDialog_stringWidth
Remarks
Required Library: mdlbltin.lib
int mdlDialog_fontIndexGet ( MSDialogP  dbP)

Returns the index of the font currently associated with the specified Dialog Box.

Parameters
[in]dbPMSDialog whose font index we're getting
Returns
The index of the font currently associated with the specified Dialog Box.
See also
mdlDialog_fontGetInfo mdlDialog_fontNameGet mdlDialog_fontGetCurHeight mdlDialog_fontGetHeight mdlDialog_textDrawA mdlDialog_textDrawNA mdlDialog_stringWidth
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_fontIndexSet ( MSDialogP  dbP,
int  fontIndex 
)

Sets the font associated with the specified Dialog Box to be fontIndex.

All subsequent text will be drawn using this font.

Parameters
[in]dbPMSDialog that gets new current font
[in]fontIndexindex of new font to use in MSDialog
Returns
SUCCESS or ERROR if dbP is not a pointer to a Dialog Box.
See also
mdlDialog_fontGetInfo mdlDialog_fontNameGet mdlDialog_fontGetCurHeight mdlDialog_fontGetHeight mdlDialog_textDrawA mdlDialog_textDrawNA mdlDialog_stringWidth
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_fontNameGet ( WCharCP *  fontNameP,
MSDialogP  dbP 
)

Retrieves the name of the font specified by fontIndex assuming that it will be used in the specified Dialog Box.

Parameters
[out]fontNamePpoints at a WCharCP which will be set to point to the name of the font.
[in]dbPMSDialog whose font name we're getting
Returns
SUCCESS or ERROR if invalid dialog.
See also
mdlDialog_fontIndexGet mdlDialog_fontIndexSet mdlDialog_fontGetCurHeight mdlDialog_fontGetHeight mdlDialog_textDrawA mdlDialog_textDrawNA mdlDialog_stringWidth
Remarks
Required Library: mdlbltin.lib

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