HALCON 17.12 / HALCON Operator Reference / Graphics / Text
ClassesClasses | | Operators

get_font_extentsget_font_extentsGetFontExtentsGetFontExtents (Operator)

Name

get_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)

void GetFontExtents(const HTuple& WindowHandle, HTuple* MaxAscent, HTuple* MaxDescent, HTuple* MaxWidth, HTuple* MaxHeight)

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

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

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

HTuple HWindow.GetFontExtents(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_extentsGetFontExtentsGetFontExtentsGetFontExtents 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.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window → HWindow, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Window handle.

MaxAscentMaxAscentMaxAscentMaxAscentmaxAscent (output_control)  extent.y → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Maximum height above baseline.

MaxDescentMaxDescentMaxDescentMaxDescentmaxDescent (output_control)  extent.y → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Maximum extension below baseline.

MaxWidthMaxWidthMaxWidthMaxWidthmaxWidth (output_control)  extent.x → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Maximum character width.

MaxHeightMaxHeightMaxHeightMaxHeightmaxHeight (output_control)  extent.y → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Maximum character height.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont

Possible Successors

set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString, read_charread_charReadCharReadCharReadChar

See also

get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents, set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, set_fontset_fontSetFontSetFontSetFont

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 17.12 Copyright © 1996-2017 MVTec Software GmbH