Win32Forth

gdiFont -- Class for GDI Fonts.

Version 1.0

This GDI class library was written and placed in the Public Domain in 2005 by Dirk Busch

Glossary

:Class gdiFont  <Super GdiObject

GDI Font class

:M SetHeight:         ( n1 -- )

Set the height, in logical units, of the font's character cell or character. The character height value (also known as the em height) is the character cell height value minus the internal-leading value. The font mapper interprets the value specified in lfHeight in the following manner.

For all height comparisons, the font mapper looks for the largest font that does not exceed the requested size. This mapping occurs when the font is used for the first time.

:M SetWidth:          ( n1 -- )

Specifies the average width, in logical units, of characters in the font. If lfWidth is zero, the aspect ratio of the device is matched against the digitization aspect ratio of the available fonts to find the closest match, determined by the absolute value of the difference.

:M SetEscapement:     ( n1 -- )

Set the angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the base line of a row of text.
Windows NT/ 2000: When the graphics mode is set to GM_ADVANCED, you can specify the escapement angle of the string independently of the orientation angle of the string's characters.
When the graphics mode is set to GM_COMPATIBLE, lfEscapement specifies both the escapement and orientation. You should set lfEscapement and lfOrientation to the same value.
Windows 95: The lfEscapement member specifies both the escapement and orientation. You should set lfEscapement and lfOrientation to the same value.

:M SetOrientation:    ( n1 -- )

Set the angle, in tenths of degrees, between each character's base line and the x-axis of the device.

:M SetWeight:         ( n1 -- )

Specifies the weight of the font in the range 0 through 1000. For example, 400 is normal and 700 is bold. If this value is zero, a default weight is used. The following values are defined for convenience.

:M SetItalic:         ( f1 -- )

Specifies an italic font if set to TRUE.

:M SetUnderline:      ( f1 -- )

Specifies an underlined font if set to TRUE.

:M SetStrikeOut:      ( f1 -- )

Specifies a strikeout font if set to TRUE.

:M SetCharSet:        ( n1 -- )

Specifies the character set. The following values are predefined.

Windows NT/ 2000 or Middle-Eastern Windows 3.1 or later:

Windows NT/ 2000 or Thai Windows 3.1 or later:

The OEM_CHARSET value specifies a character set that is operating-system dependent. Windows 95/98: You can use the DEFAULT_CHARSET value to allow the name and size of a font to fully describe the logical font. If the specified font name does not exist, a font from any character set can be substituted for the specified font, so you should use DEFAULT_CHARSET sparingly to avoid unexpected results.
Windows NT/ 2000: DEFAULT_CHARSET is set to a value based on the current system locale. For example, when the system locale is English (United States), it is set as ANSI_CHARSET.
Fonts with other character sets may exist in the operating system. If an application uses a font with an unknown character set, it should not attempt to translate or interpret strings that are rendered with that font.
This parameter is important in the font mapping process. To ensure consistent results, specify a specific character set. If you specify a typeface name in the lfFaceName member, make sure that the lfCharSet value matches the character set of the typeface specified in lfFaceName.

:M SetOutPrecision:   ( n1 -- )

Specifies the output precision. The output precision defines how closely the output must match the requested font's height, width, character orientation, escapement, pitch, and font type. It can be one of the following values.

Applications can use the OUT_DEVICE_PRECIS, OUT_RASTER_PRECIS, and OUT_TT_PRECIS values to control how the font mapper chooses a font when the operating system contains more than one font with a specified name. For example, if an operating system contains a font named Symbol in raster and TrueType form, specifying OUT_TT_PRECIS forces the font mapper to choose the TrueType version. Specifying OUT_TT_ONLY_PRECIS forces the font mapper to choose a TrueType font, even if it must substitute a TrueType font of another name.

:M SetClipPrecision:  ( n1 -- )

Specifies the clipping precision. The clipping precision defines how to clip characters that are partially outside the clipping region. It can be one or more of the following values.

For more information about the orientation of coordinate systems, see the description of the nOrientation parameter |

:M SetQuality:        ( n1 -- )

Specifies the output quality. The output quality defines how carefully the graphics device interface (GDI) must attempt to match the logical-font attributes to those of an actual physical font. It can be one of the following values.

If neither ANTIALIASED_QUALITY nor NONANTIALIASED_QUALITY is selected, the font is antialiased only if the user chooses smooth screen fonts in Control Panel.

:M SetPitchAndFamily: ( n1 -- )

Specifies the pitch and family of the font. The two low-order bits specify the pitch of the font and can be one of the following values.

Bits 4 through 7 of the member specify the font family and can be one of the following values.

The proper value can be obtained by using the Boolean OR operator to join one pitch constant with one family constant.

Font families describe the look of a font in a general way. They are intended for specifying fonts when the exact typeface desired is not available. The values for font families are as follows.

:M SetFaceName: ( a1 n1 -- )

Specifies the typeface name of the font. The length of this string must not exceed 32 characters, including the null terminator. The EnumFontFamilies function can be used to enumerate the typeface names of all currently available fonts. If lfFaceName is an empty string, GDI uses the first font that matches the other specified attributes.

:M GetHeight:         ( -- n1 )

Fet the height, in logical units, of the font's character cell or character

:M GetWidth:          ( -- n1 )

Get the average width, in logical units, of characters in the font

:M GetEscapement:     ( -- n1 )

Get the angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the base line of a row of text.

:M GetOrientation:    ( -- n1 )

Get the angle, in tenths of degrees, between each character's base line and the x-axis of the device.

:M GetWeight:         ( -- n1 )

Get the weight of the font

:M GetItalic:         ( -- f1 )

TRUE if it's an italic font.

:M GetUnderline:      ( -- f1 )

TRUE if it's a underlined font.

:M GetStrikeOut:      ( -- f1 )

TRUE if it's a strikeout font.

:M GetCharSet:        ( -- n1 )

Get the character set.

:M GetOutPrecision:   ( -- n1 )

Get the output precision.

:M GetClipPrecision:  ( -- n1 )

Get the clipping precision

:M GetQuality:        ( -- n1 )

Get the output quality.

:M GetPitchAndFamily: ( -- n1 )

Get the pitch and family of the font.

:M GetFaceName: ( -- a1 n1 )

Get the typeface name of the font.

:M GetLogfont:        ( -- n1 )

Get the address of the LOGFONT structure

:M Create:      ( -- f )

Create a new font. If the current font handle is valid, the font will be destroyed.

:M Choose:      ( hWnd -- f )

Open a dialog to choose a Screen font. If the dialog is closed with OK, the font will be created.

:M ChoosePrinter: ( hWnd hDC -- f )

Open a dialog to choose a Printer font for the PrinterDC hDC. If the dialog is closed with OK, the fontwill be created.

;Class

End of gdiFont class

Document $Id: gdiFont.htm,v 1.12 2007/05/26 10:24:13 dbu_de Exp $