Font

Description The GdkFont data type represents a font for drawing on the screen. These functions provide support for loading fonts, and also for determining the dimensions of characters and strings when drawn with a particular font. Fonts in X are specified by a X Logical Font Description. The following description is considerably simplified. For definitive information about XLFD's see the X reference documentation. A X Logical Font Description (XLFD) consists of a sequence of fields separated (and surrounded by) '-' characters. For example, Adobe Helvetica Bold 12 pt, has the full description: The fields in the XLFD are: Foundry the company or organization where the font originated. Family the font family (a group of related font designs). Weight A name for the font's typographic weight For example, 'bold' or 'medium'). Slant The slant of the font. Common values are 'R' for Roman, 'I' for italoc, and 'O' for oblique. Set Width A name for the width of the font. For example, 'normal' or 'condensed'. Add Style Additional information to distinguish a font from other fonts of the same family. Pixel Size The body size of the font in pixels. Point Size The body size of the font in 10ths of a point. (A point is 1/72.27 inch) Resolution X The horizontal resolution that the font was designed for. Resolution Y The vertical resolution that the font was designed for . Spacing The type of spacing for the font - can be 'p' for proportional, 'm' for monospaced or 'c' for charcell. Average Width The average width of a glyph in the font. For monospaced and charcell fonts, all glyphs in the font have this width Charset Registry The registration authority that owns the encoding for the font. Together with the Charset Encoding field, this defines the character set for the font. Charset Encoding An identifier for the particular character set encoding. When specifying a font via a X logical Font Description, '*' can be used as a wildcard to match any portion of the XLFD. For instance, the above example could also be specified as It is generally a good idea to use wildcards for any portion of the XLFD that your program does not care about specifically, since that will improve the chances of finding a matching font. A fontset is a list of fonts that is used for drawing international text that may contain characters from a number of different character sets. It is represented by a list of XLFD's. The font for a given character set is determined by going through the list of XLFD's in order. For each one, if the registry and and encoding fields match the desired character set, then that font is used, otherwise if the XLFD contains wild-cards for the registry and encoding fields, the registry and encoding for the desired character set are substituted in and a lookup is done. If a match is found that font is used. Otherwise, processing continues on to the next font in the list. The functions for determining the metrics of a string come in several varieties that can take a number of forms of string input: 8-bit string When using functions like gdk_string_width() that take a gchar *, if the font is of type GDK_FONT_FONT and is an 8-bit font, then each gchar indexes the glyphs in the font directly. 16-bit string For functions taking a gchar *, if the font is of type GDK_FONT_FONT, and is a 16-bit font, then the gchar * argument is interpreted as a guint16 * cast to a gchar * and each guint16 indexes the glyphs in the font directly. Multibyte string For functions taking a gchar *, if the font is of type GDK_FONT_FONTSET, then the input string is interpreted as a multibyte encoded according to the current locale. (A multibyte string is one in which each character may consist of one or more bytes, with different lengths for different characters in the string). They can be converted to and from wide character strings (see below) using gdk_wcstombs() and gdk_mbstowcs().) The string will be rendered using one or more different fonts from the fontset. Wide character string For a number of the text-measuring functions, GDK provides a variant (such as gdk_text_width_wc()) which takes a GdkWChar * instead of a gchar *. The input is then taken to be a wide character string in the encoding of the current locale. (A wide character string is a string in which each character consists of several bytes, and the width of each character in the string is constant.) GDK provides functions to determine a number of different measurements (metrics) for a given string. (Need diagram here). ascent The vertical distance from the origin of the drawing opereration to the top of the drawn character. descent The vertical distance from the origin of the drawing opereration to the bottom of the drawn character. left bearing The horizontal distance from the origin of the drawing operation to the left-most part of the drawn character. right bearing The horizontal distance from the origin of the drawing operation to the right-most part of the drawn character. width bearing The horizontal distance from the origin of the drawing operation to the correct origin for drawing another string to follow the current one. Depending on the font, this could be greater than or less than the right bearing.

Constructors

this
this(GdkFont* gdkFont)

Sets our main struct and passes it to the parent class

this
this(string fontName)

Create and loads a font

Members

Functions

charHeight
int charHeight(char character)

Warning gdk_char_height has been deprecated since version 2.2 and should not be used in newly-written code. Use gdk_text_extents() instead. Determines the total height of a given character. This value is not generally useful, because you cannot determine how this total height will be drawn in relation to the baseline. See gdk_text_extents().

charMeasure
int charMeasure(char character)

Warning gdk_char_measure is deprecated and should not be used in newly-written code. Determines the distance from the origin to the rightmost portion of a character when drawn. This is not the correct value for determining the origin of the next portion when drawing text in multiple pieces.

charWidth
int charWidth(char character)

Warning gdk_char_width has been deprecated since version 2.2 and should not be used in newly-written code. Use gdk_text_extents() instead. Determines the width of a given character.

charWidthWc
int charWidthWc(GdkWChar character)

Warning gdk_char_width_wc is deprecated and should not be used in newly-written code. Determines the width of a given wide character. (Encoded in the wide-character encoding of the current locale).

doref
Font doref()

Warning gdk_font_ref is deprecated and should not be used in newly-written code. Increases the reference count of a font by one.

equal
int equal(Font fontb)

Warning gdk_font_equal is deprecated and should not be used in newly-written code. Compares two fonts for equality. Single fonts compare equal if they have the same X font ID. This operation does not currently work correctly for fontsets.

getDisplay
Display getDisplay()

Warning gdk_font_get_display is deprecated and should not be used in newly-written code. Returns the GdkDisplay for font. Since 2.2

getFontStruct
GdkFont* getFontStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

id
int id()

Warning gdk_font_id is deprecated and should not be used in newly-written code. Returns the X Font ID for the given font.

stringExtents
void stringExtents(string string, int lbearing, int rbearing, int width, int ascent, int descent)

Warning gdk_string_extents is deprecated and should not be used in newly-written code. Gets the metrics of a nul-terminated string.

stringHeight
int stringHeight(string string)

Warning gdk_string_height is deprecated and should not be used in newly-written code. Determines the total height of a given nul-terminated string. This value is not generally useful, because you cannot determine how this total height will be drawn in relation to the baseline. See gdk_string_extents().

stringMeasure
int stringMeasure(string string)

Warning gdk_string_measure is deprecated and should not be used in newly-written code. Determines the distance from the origin to the rightmost portion of a nul-terminated string when drawn. This is not the correct value for determining the origin of the next portion when drawing text in multiple pieces. See gdk_string_width().

stringWidth
int stringWidth(string string)

Warning gdk_string_width is deprecated and should not be used in newly-written code. Determines the width of a nul-terminated string. (The distance from the origin of the string to the point where the next string in a sequence of strings should be drawn)

textExtents
void textExtents(string text, int textLength, int lbearing, int rbearing, int width, int ascent, int descent)

Warning gdk_text_extents is deprecated and should not be used in newly-written code. Gets the metrics of a string.

textExtentsWc
void textExtentsWc(GdkWChar[] text, int lbearing, int rbearing, int width, int ascent, int descent)

Warning gdk_text_extents_wc is deprecated and should not be used in newly-written code. Gets the metrics of a string of wide characters.

textHeight
int textHeight(string text, int textLength)

Warning gdk_text_height is deprecated and should not be used in newly-written code. Determines the total height of a given string. This value is not generally useful, because you cannot determine how this total height will be drawn in relation to the baseline. See gdk_text_extents().

textMeasure
int textMeasure(string text, int textLength)

Warning gdk_text_measure is deprecated and should not be used in newly-written code. Determines the distance from the origin to the rightmost portion of a string when drawn. This is not the correct value for determining the origin of the next portion when drawing text in multiple pieces. See gdk_text_width().

textWidth
int textWidth(string text, int textLength)

Warning gdk_text_width is deprecated and should not be used in newly-written code. Determines the width of a given string.

textWidthWc
int textWidthWc(GdkWChar[] text)

Warning gdk_text_width_wc is deprecated and should not be used in newly-written code. Determines the width of a given wide-character string.

unref
void unref()

Warning gdk_font_unref is deprecated and should not be used in newly-written code. Decreases the reference count of a font by one. If the result is zero, destroys the font.

Static functions

fontsetLoad
Font fontsetLoad(string fontsetName)

Warning gdk_fontset_load is deprecated and should not be used in newly-written code. Loads a fontset. The fontset may be newly loaded or looked up in a cache. You should make no assumptions about the initial reference count.

fontsetLoadForDisplay
Font fontsetLoadForDisplay(Display display, string fontsetName)

Warning gdk_fontset_load_for_display is deprecated and should not be used in newly-written code. Loads a fontset for use on display. The fontset may be newly loaded or looked up in a cache. You should make no assumptions about the initial reference count. Since 2.2

fromDescription
Font fromDescription(PgFontDescription fontDesc)

Warning gdk_font_from_description is deprecated and should not be used in newly-written code. Load a GdkFont based on a Pango font description. This font will only be an approximation of the Pango font, and internationalization will not be handled correctly. This function should only be used for legacy code that cannot be easily converted to use Pango. Using Pango directly will produce better results.

fromDescriptionForDisplay
Font fromDescriptionForDisplay(Display display, PgFontDescription fontDesc)

Warning gdk_font_from_description_for_display is deprecated and should not be used in newly-written code. Loads a GdkFont based on a Pango font description for use on display. This font will only be an approximation of the Pango font, and internationalization will not be handled correctly. This function should only be used for legacy code that cannot be easily converted to use Pango. Using Pango directly will produce better results. Since 2.2

load
Font load(string fontName)

Warning gdk_font_load is deprecated and should not be used in newly-written code. Loads a font. The font may be newly loaded or looked up the font in a cache. You should make no assumptions about the initial reference count.

loadForDisplay
Font loadForDisplay(Display display, string fontName)

Warning gdk_font_load_for_display is deprecated and should not be used in newly-written code. Loads a font for use on display. The font may be newly loaded or looked up the font in a cache. You should make no assumptions about the initial reference count. Since 2.2

mbstowcs
int mbstowcs(GdkWChar* dest, string src, int destMax)

Warning gdk_mbstowcs is deprecated and should not be used in newly-written code. Converts a multi-byte string to a wide character string. (The function name comes from an acronym of 'Multi-Byte String TO Wide Character String').

wcstombs
string wcstombs(GdkWChar* src)

Warning gdk_wcstombs is deprecated and should not be used in newly-written code. Converts a wide character string to a multi-byte string. (The function name comes from an acronym of 'Wide Character String TO Multi-Byte String').

Variables

gdkFont
GdkFont* gdkFont;

the main Gtk struct

Meta