| wxgetscreentextextent() | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxgetscreentextextent()
Description
This function determines the height and width of the text passed using the
font passed. The height will not necessarily be the height of the text
but rather the height required for the font. The parameters
width and height must be
pre-initialized integers since the values will be returned in the objects
passed.
Prototype
wxgetscreentextextent (
wxfont fonttextwidthheightdescentextleading
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| font | None | wxfont | The font to be used to evaluate the size of the text. |
| text | None | string | The text for which a size is being requested. |
| width | None | integer | This will return the width in pixels of the text. This must be a pre-initialized object. |
| height | None | integer | This will return the height in pixels of the text. This must be a pre-initialized object. |
| descent | None | integer | This will return the height in pixels of the descent, which is the dimension from the baseline of the font to the bottom of the descender. This is necessary to calculate the full line height. This must be a pre-initialized object. |
| extleading | None | integer | This will return the height in pixels of the external leading, which is any extra vertical space added to the font by the font designer. This is necessary to calculate the full line height. This must be a pre-initialized object. |