get_font_extentsget_font_extentsGetFontExtentsget_font_extentsGetFontExtentsGetFontExtents (Operator)

Name

get_font_extentsget_font_extentsGetFontExtentsget_font_extentsGetFontExtentsGetFontExtents — Get the maximum size of all characters of a font.

Signature

get_font_extents( : : WindowHandle : MaxAscent, MaxDescent, MaxWidth, MaxHeight)

Description

get_font_extentsget_font_extentsGetFontExtentsget_font_extentsGetFontExtentsGetFontExtents queries the maximum width (MaxWidthMaxWidthMaxWidthMaxWidthMaxWidthmaxWidth), height (MaxHeightMaxHeightMaxHeightMaxHeightMaxHeightmaxHeight), and extension above and below the baseline (MaxAscentMaxAscentMaxAscentMaxAscentMaxAscentmaxAscent and MaxDescentMaxDescentMaxDescentMaxDescentMaxDescentmaxDescent, respectively) of the font that is currently set for the window WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. The sizes are measured in pixels.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window identifier.

MaxAscentMaxAscentMaxAscentMaxAscentMaxAscentmaxAscent (output_control) integer → (integer)

Maximum height above baseline.

MaxDescentMaxDescentMaxDescentMaxDescentMaxDescentmaxDescent (output_control) integer → (integer)

Maximum extension below baseline.

MaxWidthMaxWidthMaxWidthMaxWidthMaxWidthmaxWidth (output_control) integer → (integer)

Maximum character width.

MaxHeightMaxHeightMaxHeightMaxHeightMaxHeightmaxHeight (output_control) integer → (integer)

Maximum character height.

Result

get_font_extentsget_font_extentsGetFontExtentsget_font_extentsGetFontExtentsGetFontExtents returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontSetFontset_fontSetFontSetFont

Possible Successors

set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition, write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString, read_charread_charReadCharread_charReadCharReadChar

Module

Foundation

Operators