HALCON Reference Manual 10.0.2
Table of Contents / Graphics / Text ClassesClassesClasses | | | Operators

get_font_extentsget_font_extentsget_font_extentsGetFontExtentsGetFontExtents (Operator)

Name

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

Signature

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

Herror get_font_extents(const Hlong WindowHandle, Hlong* MaxAscent, Hlong* MaxDescent, Hlong* MaxWidth, Hlong* MaxHeight)

Herror T_get_font_extents(const Htuple WindowHandle, Htuple* MaxAscent, Htuple* MaxDescent, Htuple* MaxWidth, Htuple* MaxHeight)

Herror get_font_extents(const HTuple& WindowHandle, Hlong* MaxAscent, Hlong* MaxDescent, Hlong* MaxWidth, Hlong* MaxHeight)

Hlong HWindow::GetFontExtents(HTuple* MaxDescent, HTuple* MaxWidth, HTuple* MaxHeight) const

void HOperatorSetX.GetFontExtents(
[in] VARIANT WindowHandle, [out] VARIANT* MaxAscent, [out] VARIANT* MaxDescent, [out] VARIANT* MaxWidth, [out] VARIANT* MaxHeight)

Hlong HWindowX.GetFontExtents(
[out] Hlong* MaxDescent, [out] Hlong* MaxWidth, [out] Hlong* MaxHeight)

static void HOperatorSet.GetFontExtents(HTuple windowHandle, out HTuple maxAscent, out HTuple maxDescent, out HTuple maxWidth, out HTuple maxHeight)

int HWindow.GetFontExtents(out int maxDescent, out int maxWidth, out int maxHeight)

Description

get_font_extentsget_font_extentsget_font_extentsGetFontExtentsGetFontExtents queries the maximum width (MaxWidthMaxWidthMaxWidthMaxWidthmaxWidth), height (MaxHeightMaxHeightMaxHeightMaxHeightmaxHeight), and extension above and below the baseline (MaxAscentMaxAscentMaxAscentMaxAscentmaxAscent and MaxDescentMaxDescentMaxDescentMaxDescentmaxDescent, respectively) of the font that is currently set for the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. The sizes are measured in pixels.

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window → HWindow, HTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

Window identifier.

MaxAscentMaxAscentMaxAscentMaxAscentmaxAscent (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Maximum height above baseline.

MaxDescentMaxDescentMaxDescentMaxDescentmaxDescent (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Maximum extension below baseline.

MaxWidthMaxWidthMaxWidthMaxWidthmaxWidth (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Maximum character width.

MaxHeightMaxHeightMaxHeightMaxHeightmaxHeight (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Maximum character height.

Result

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

Possible Predecessors

open_windowopen_windowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontset_fontSetFontSetFont

Possible Successors

set_tpositionset_tpositionset_tpositionSetTpositionSetTposition, write_stringwrite_stringwrite_stringWriteStringWriteString, read_stringread_stringread_stringReadStringReadString, read_charread_charread_charReadCharReadChar

See also

get_string_extentsget_string_extentsget_string_extentsGetStringExtentsGetStringExtents, set_tpositionset_tpositionset_tpositionSetTpositionSetTposition, set_fontset_fontset_fontSetFontSetFont

Module

Foundation

Table of Contents / Graphics / Text ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH