1 \section{\class{wxFont
}}\label{wxfont
}
3 A font is an object which determines the appearance of text. Fonts are
4 used for drawing text to a device context, and setting the appearance of
7 This class uses
\helpref{reference counting and copy-on-write
}{trefcount
}
8 internally so that assignments between two instances of this class are very
9 cheap. You can therefore use actual objects instead of pointers without
10 efficiency problems. If an instance of this class is changed it will create
11 its own data internally so that other instances, which previously shared the
12 data using the reference counting, are not affected.
14 You can retrieve the current system font settings with
\helpref{wxSystemSettings
}{wxsystemsettings
}.
16 \helpref{wxSystemSettings
}{wxsystemsettings
}
18 \wxheading{Derived from
}
20 \helpref{wxGDIObject
}{wxgdiobject
}\\
21 \helpref{wxObject
}{wxobject
}
23 \wxheading{Include files
}
29 The possible values for the
\arg{family
} parameter of
\helpref{wxFont
30 constructor
}{wxfontctor
} are (the old names are for compatibility only):
35 wxFONTFAMILY_DEFAULT = wxDEFAULT,
36 wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
37 wxFONTFAMILY_ROMAN = wxROMAN,
38 wxFONTFAMILY_SCRIPT = wxSCRIPT,
39 wxFONTFAMILY_SWISS = wxSWISS,
40 wxFONTFAMILY_MODERN = wxMODERN,
41 wxFONTFAMILY_TELETYPE = wxTELETYPE,
46 The possible values for the
\arg{weight
} parameter are (the old names
47 are for compatibility only):
52 wxFONTWEIGHT_NORMAL = wxNORMAL,
53 wxFONTWEIGHT_LIGHT = wxLIGHT,
54 wxFONTWEIGHT_BOLD = wxBOLD,
59 The font flags which can be used during the font creation are:
64 // no special flags: font with default weight/slant/anti-aliasing
65 wxFONTFLAG_DEFAULT =
0,
67 // slant flags (default: no slant)
68 wxFONTFLAG_ITALIC =
1 <<
0,
69 wxFONTFLAG_SLANT =
1 <<
1,
71 // weight flags (default: medium)
72 wxFONTFLAG_LIGHT =
1 <<
2,
73 wxFONTFLAG_BOLD =
1 <<
3,
75 // anti-aliasing flag: force on or off (default: the current system default)
76 wxFONTFLAG_ANTIALIASED =
1 <<
4,
77 wxFONTFLAG_NOT_ANTIALIASED =
1 <<
5,
79 // underlined/strikethrough flags (default: no lines)
80 wxFONTFLAG_UNDERLINED =
1 <<
6,
81 wxFONTFLAG_STRIKETHROUGH =
1 <<
7,
85 The known font encodings are:
90 wxFONTENCODING_SYSTEM = -
1, // system default
91 wxFONTENCODING_DEFAULT, // current default encoding
93 // ISO8859 standard defines a number of single-byte charsets
94 wxFONTENCODING_ISO8859_1, // West European (Latin1)
95 wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
96 wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
97 wxFONTENCODING_ISO8859_4, // Baltic (old) (Latin4)
98 wxFONTENCODING_ISO8859_5, // Cyrillic
99 wxFONTENCODING_ISO8859_6, // Arabic
100 wxFONTENCODING_ISO8859_7, // Greek
101 wxFONTENCODING_ISO8859_8, // Hebrew
102 wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
103 wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
104 wxFONTENCODING_ISO8859_11, // Thai
105 wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
106 // here anyhow to make all ISO8859
107 // consecutive numbers
108 wxFONTENCODING_ISO8859_13, // Baltic (Latin7)
109 wxFONTENCODING_ISO8859_14, // Latin8
110 wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
111 wxFONTENCODING_ISO8859_MAX,
113 // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
114 wxFONTENCODING_KOI8, // we don't support any of KOI8 variants
115 wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
116 wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
118 // what would we do without Microsoft? They have their own encodings
120 wxFONTENCODING_CP437, // original MS-DOS codepage
121 wxFONTENCODING_CP850, // CP437 merged with Latin1
122 wxFONTENCODING_CP852, // CP437 merged with Latin2
123 wxFONTENCODING_CP855, // another cyrillic encoding
124 wxFONTENCODING_CP866, // and another one
126 wxFONTENCODING_CP874, // WinThai
127 wxFONTENCODING_CP1250, // WinLatin2
128 wxFONTENCODING_CP1251, // WinCyrillic
129 wxFONTENCODING_CP1252, // WinLatin1
130 wxFONTENCODING_CP1253, // WinGreek (
8859-
7)
131 wxFONTENCODING_CP1254, // WinTurkish
132 wxFONTENCODING_CP1255, // WinHebrew
133 wxFONTENCODING_CP1256, // WinArabic
134 wxFONTENCODING_CP1257, // WinBaltic (same as Latin
7)
135 wxFONTENCODING_CP12_MAX,
137 wxFONTENCODING_UTF7, // UTF-
7 Unicode encoding
138 wxFONTENCODING_UTF8, // UTF-
8 Unicode encoding
140 wxFONTENCODING_UNICODE, // Unicode - currently used only by
141 // wxEncodingConverter class
147 \wxheading{Predefined objects
}
155 {\bf wxNORMAL
\_FONT\\
162 \helpref{wxFont overview
}{wxfontoverview
},
\helpref{wxDC::SetFont
}{wxdcsetfont
},
\rtfsp
163 \helpref{wxDC::DrawText
}{wxdcdrawtext
},
\helpref{wxDC::GetTextExtent
}{wxdcgettextextent
},
\rtfsp
164 \helpref{wxFontDialog
}{wxfontdialog
},
\helpref{wxSystemSettings
}{wxsystemsettings
}
166 \latexignore{\rtfignore{\wxheading{Members
}}}
169 \membersection{wxFont::wxFont
}\label{wxfontctor
}
171 \func{}{wxFont
}{\void}
175 \func{}{wxFont
}{\param{const wxFont\&
}{ font
}}
177 Copy constructor, uses
\helpref{reference counting
}{trefcount
}.
179 \func{}{wxFont
}{\param{int
}{ pointSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
180 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
181 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
183 \func{}{wxFont
}{\param{const wxSize\&
}{ pixelSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
184 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
185 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
187 Creates a font object with the specified attributes.
189 \wxheading{Parameters
}
191 \docparam{pointSize
}{Size in points.
}
193 \docparam{pixelSize
}{Size in pixels: this is directly supported only under MSW
194 currently where this constructor can be used directly, under other platforms a
195 font with the closest size to the given one is found using binary search and
196 the static
\helpref{New
}{wxfontnew
} method must be used.
}
198 \docparam{family
}{Font family, a generic way of referring to fonts without specifying actual facename. One of:
201 \begin{twocollist
}\itemsep=
0pt
202 \twocolitem{{\bf wxFONTFAMILY
\_DEFAULT}}{Chooses a default font.
}
203 \twocolitem{{\bf wxFONTFAMILY
\_DECORATIVE}}{A decorative font.
}
204 \twocolitem{{\bf wxFONTFAMILY
\_ROMAN}}{A formal, serif font.
}
205 \twocolitem{{\bf wxFONTFAMILY
\_SCRIPT}}{A handwriting font.
}
206 \twocolitem{{\bf wxFONTFAMILY
\_SWISS}}{A sans-serif font.
}
207 \twocolitem{{\bf wxFONTFAMILY
\_MODERN}}{A fixed pitch font.
}
208 \twocolitem{{\bf wxFONTFAMILY
\_TELETYPE}}{A teletype font.
}
211 \docparam{style
}{One of
{\bf wxFONTSTYLE
\_NORMAL},
{\bf wxFONTSTYLE
\_SLANT} and
{\bf wxFONTSTYLE
\_ITALIC}.
}
213 \docparam{weight
}{Font weight, sometimes also referred to as font boldness. One of:
216 \begin{twocollist
}\itemsep=
0pt
217 \twocolitem{{\bf wxFONTWEIGHT
\_NORMAL}}{Normal font.
}
218 \twocolitem{{\bf wxFONTWEIGHT
\_LIGHT}}{Light font.
}
219 \twocolitem{{\bf wxFONTWEIGHT
\_BOLD}}{Bold font.
}
222 \docparam{underline
}{The value can be true or false. At present this has an effect on Windows and Motif
2.x only.
}
224 \docparam{faceName
}{An optional string specifying the actual typeface to be used. If it is an empty string,
225 a default typeface will be chosen based on the family.
}
227 \docparam{encoding
}{An encoding which may be one of
229 \begin{twocollist
}\itemsep=
0pt
230 \twocolitem{{\bf wxFONTENCODING
\_SYSTEM}}{Default system encoding.
}
231 \twocolitem{{\bf wxFONTENCODING
\_DEFAULT}}{Default application encoding: this
232 is the encoding set by calls to
233 \helpref{SetDefaultEncoding
}{wxfontsetdefaultencoding
} and which may be set to,
234 say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
235 default application encoding is the same as default system encoding.
}
236 \twocolitem{{\bf wxFONTENCODING
\_ISO8859\_1..
.15}}{ISO8859 encodings.
}
237 \twocolitem{{\bf wxFONTENCODING
\_KOI8}}{The standard Russian encoding for Internet.
}
238 \twocolitem{{\bf wxFONTENCODING
\_CP1250..
.1252}}{Windows encodings similar to ISO8859 (but not identical).
}
240 If the specified encoding isn't available, no font is created
241 (see also
\helpref{font encoding overview
}{wxfontencodingoverview
}).
246 If the desired font does not exist, the closest match will be chosen.
247 Under Windows, only scalable TrueType fonts are used.
249 See also
\helpref{wxDC::SetFont
}{wxdcsetfont
},
\helpref{wxDC::DrawText
}{wxdcdrawtext
}
250 and
\helpref{wxDC::GetTextExtent
}{wxdcgettextextent
}.
253 \membersection{wxFont::
\destruct{wxFont
}}\label{wxfontdtor
}
255 \func{}{\destruct{wxFont
}}{\void}
258 See
\helpref{reference-counted object destruction
}{refcountdestruct
} for more info.
262 Although all remaining fonts are deleted when the application exits,
263 the application should try to clean up all fonts itself. This is because
264 wxWidgets cannot know if a pointer to the font object is stored in an
265 application data structure, and there is a risk of double deletion.
268 \membersection{wxFont::IsFixedWidth
}\label{wxfontisfixedwidth
}
270 \constfunc{bool
}{IsFixedWidth
}{\void}
272 Returns
{\tt true
} if the font is a fixed width (or monospaced) font,
273 {\tt false
} if it is a proportional one or font is invalid.
276 \membersection{wxFont::GetDefaultEncoding
}\label{wxfontgetdefaultencoding
}
278 \func{static wxFontEncoding
}{GetDefaultEncoding
}{\void}
280 Returns the current application's default encoding.
284 \helpref{Font encoding overview
}{wxfontencodingoverview
},
285 \helpref{SetDefaultEncoding
}{wxfontsetdefaultencoding
}
288 \membersection{wxFont::GetFaceName
}\label{wxfontgetfacename
}
290 \constfunc{wxString
}{GetFaceName
}{\void}
292 Returns the typeface name associated with the font, or the empty string if there is no
293 typeface information.
297 \helpref{wxFont::SetFaceName
}{wxfontsetfacename
}
300 \membersection{wxFont::GetFamily
}\label{wxfontgetfamily
}
302 \constfunc{wxFontFamily
}{GetFamily
}{\void}
304 Gets the font family. See
\helpref{wxFont::SetFamily
}{wxfontsetfamily
} for a list of valid
309 \helpref{wxFont::SetFamily
}{wxfontsetfamily
}
312 \membersection{wxFont::GetNativeFontInfoDesc
}\label{wxfontgetnativefontinfodesc
}
314 \constfunc{wxString
}{GetNativeFontInfoDesc
}{\void}
316 Returns the platform-dependent string completely describing this font.
317 Returned string is always non-empty.
318 Note that the returned string is not meant to be shown or edited by the user: a typical
319 use of this function is for serializing in string-form a wxFont object.
323 \helpref{wxFont::SetNativeFontInfo
}{wxfontsetnativefontinfo
},
\helpref{wxFont::GetNativeFontInfoUserDesc
}{wxfontgetnativefontinfouserdesc
}
326 \membersection{wxFont::GetNativeFontInfoUserDesc
}\label{wxfontgetnativefontinfouserdesc
}
328 \func{wxString
}{GetNativeFontInfoUserDesc
}{\void}
330 Returns a user-friendly string for this font object. Returned string is always non-empty.
331 Some examples of the formats of returned strings (which are platform-dependent) are in
\helpref{SetNativeFontInfoUserDesc
}{wxfontsetnativefontinfouserdesc
}.
335 \helpref{wxFont::GetNativeFontInfoDesc
}{wxfontgetnativefontinfodesc
}
338 \membersection{wxFont::GetPointSize
}\label{wxfontgetpointsize
}
340 \constfunc{int
}{GetPointSize
}{\void}
346 \helpref{wxFont::SetPointSize
}{wxfontsetpointsize
}
349 \membersection{wxFont::GetStyle
}\label{wxfontgetstyle
}
351 \constfunc{int
}{GetStyle
}{\void}
353 Gets the font style. See
\helpref{wxFont::wxFont
}{wxfontctor
} for a list of valid
358 \helpref{wxFont::SetStyle
}{wxfontsetstyle
}
361 \membersection{wxFont::GetUnderlined
}\label{wxfontgetunderlined
}
363 \constfunc{bool
}{GetUnderlined
}{\void}
365 Returns true if the font is underlined, false otherwise.
369 \helpref{wxFont::SetUnderlined
}{wxfontsetunderlined
}
372 \membersection{wxFont::GetWeight
}\label{wxfontgetweight
}
374 \constfunc{wxFontWeight
}{GetWeight
}{\void}
376 Gets the font weight. See
\helpref{wxFont::wxFont
}{wxfontctor
} for a list of valid
381 \helpref{wxFont::SetWeight
}{wxfontsetweight
}
384 \membersection{wxFont::New
}\label{wxfontnew
}
386 \func{static wxFont *
}{New
}{\param{int
}{ pointSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
387 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
388 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
390 \func{static wxFont *
}{New
}{\param{int
}{ pointSize
},
\param{wxFontFamily
}{ family
},
391 \param{int
}{ flags =
\texttt{wxFONTFLAG
\_DEFAULT}},
\param{const wxString\&
}{faceName = ""
},
392 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
394 \func{static wxFont *
}{New
}{\param{const wxSize\&
}{ pixelSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
395 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
396 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
398 \func{static wxFont *
}{New
}{\param{const wxSize\&
}{ pixelSize
},
\param{wxFontFamily
}{ family
},
399 \param{int
}{ flags =
\texttt{wxFONTFLAG
\_DEFAULT}},
\param{const wxString\&
}{faceName = ""
},
400 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
402 These functions take the same parameters as
\helpref{wxFont
403 constructor
}{wxfontctor
} and return a new font object allocated on the heap.
405 Using
\texttt{New()
} is currently the only way to directly create a font with
406 the given size in pixels on platforms other than wxMSW.
409 \membersection{wxFont::IsOk
}\label{wxfontisok
}
411 \constfunc{bool
}{IsOk
}{\void}
413 Returns
{\tt true
} if this object is a valid font,
{\tt false
} otherwise.
416 \membersection{wxFont::SetDefaultEncoding
}\label{wxfontsetdefaultencoding
}
418 \func{static void
}{SetDefaultEncoding
}{\param{wxFontEncoding
}{encoding
}}
420 Sets the default font encoding.
424 \helpref{Font encoding overview
}{wxfontencodingoverview
},
425 \helpref{GetDefaultEncoding
}{wxfontgetdefaultencoding
}
428 \membersection{wxFont::SetFaceName
}\label{wxfontsetfacename
}
430 \func{bool
}{SetFaceName
}{\param{const wxString\&
}{faceName
}}
432 Sets the facename for the font.
433 Returns
\true if the given face name exists;
\false otherwise.
435 \wxheading{Parameters
}
437 \docparam{faceName
}{A valid facename, which should be on the end-user's system.
}
441 To avoid portability problems, don't rely on a specific face, but specify the font family
442 instead or as well. A suitable font will be found on the end-user's system. If both the
443 family and the facename are specified, wxWidgets will first search for the specific face,
444 and then for a font belonging to the same family.
448 \helpref{wxFont::GetFaceName
}{wxfontgetfacename
},
\helpref{wxFont::SetFamily
}{wxfontsetfamily
}
451 \membersection{wxFont::SetFamily
}\label{wxfontsetfamily
}
453 \func{void
}{SetFamily
}{\param{wxFontFamily
}{ family
}}
455 Sets the font family.
457 \wxheading{Parameters
}
459 \docparam{family
}{One of:
462 \begin{twocollist
}\itemsep=
0pt
463 \twocolitem{{\bf wxFONTFAMILY
\_DEFAULT}}{Chooses a default font.
}
464 \twocolitem{{\bf wxFONTFAMILY
\_DECORATIVE}}{A decorative font.
}
465 \twocolitem{{\bf wxFONTFAMILY
\_ROMAN}}{A formal, serif font.
}
466 \twocolitem{{\bf wxFONTFAMILY
\_SCRIPT}}{A handwriting font.
}
467 \twocolitem{{\bf wxFONTFAMILY
\_SWISS}}{A sans-serif font.
}
468 \twocolitem{{\bf wxFONTFAMILY
\_MODERN}}{A fixed pitch font.
}
469 \twocolitem{{\bf wxFONTFAMILY
\_TELETYPE}}{A teletype font.
}
474 \helpref{wxFont::GetFamily
}{wxfontgetfamily
},
\helpref{wxFont::SetFaceName
}{wxfontsetfacename
}
477 \membersection{wxFont::SetNativeFontInfo
}\label{wxfontsetnativefontinfo
}
479 \func{bool
}{SetNativeFontInfo
}{\param{const wxString\&
}{info
}}
481 Creates the font corresponding to the given native font description string and returns
\true if
482 the creation was successful.
483 which must have been previously returned by
484 \helpref{GetNativeFontInfoDesc
}{wxfontgetnativefontinfodesc
}. If the string is
485 invalid, font is unchanged. This function is typically used for de-serializing a wxFont
486 object previously saved in a string-form.
490 \helpref{wxFont::SetNativeFontInfoUserDesc
}{wxfontsetnativefontinfouserdesc
}
493 \membersection{wxFont::SetNativeFontInfoUserDesc
}\label{wxfontsetnativefontinfouserdesc
}
495 \func{bool
}{SetNativeFontInfoUserDesc
}{\param{const wxString\&
}{info
}}
497 Creates the font corresponding to the given native font description string and returns
\true if
498 the creation was successful.
499 Unlike
\helpref{SetNativeFontInfo
}{wxfontsetnativefontinfo
}, this function accepts
500 strings which are user-friendly.
501 Examples of accepted string formats are:
504 \begin{twocollist
}\itemsep=
0pt
505 \twocolitem{Generic syntax
}{Example
}
506 \twocolitem{on
{\bf wxGTK2
}:
{\tt $
[FACE-NAME
]$ $
[bold
]$ $
[oblique|italic
]$ $
[POINTSIZE
]$
}}{Monospace bold
10}
507 \twocolitem{on
{\bf wxMSW
}:
{\tt $
[light|bold
]$ $
[italic
]$ $
[FACE-NAME
]$ $
[POINTSIZE
]$ $
[ENCODING
]$
}}{Tahoma
10 WINDOWS-
1252}
508 \twocolitem{on
{\bf wxMac
}: FIXME
}{FIXME
}
511 For more detailed information about the allowed syntaxes you can look at the documentation of the native API used for font-rendering (e.g.
\urlref{pango
\_font\_description\_from\_string}{http://developer.gnome.org/doc/API/
2.0/pango/pango-Fonts.html\#pango-font-description-from-string
}).
515 \helpref{wxFont::SetNativeFontInfo
}{wxfontsetnativefontinfo
}
519 \membersection{wxFont::SetPointSize
}\label{wxfontsetpointsize
}
521 \func{void
}{SetPointSize
}{\param{int
}{ pointSize
}}
525 \wxheading{Parameters
}
527 \docparam{pointSize
}{Size in points.
}
531 \helpref{wxFont::GetPointSize
}{wxfontgetpointsize
}
534 \membersection{wxFont::SetStyle
}\label{wxfontsetstyle
}
536 \func{void
}{SetStyle
}{\param{int
}{ style
}}
540 \wxheading{Parameters
}
542 \docparam{style
}{One of
{\bf wxFONTSTYLE
\_NORMAL},
{\bf wxFONTSTYLE
\_SLANT} and
{\bf wxFONTSTYLE
\_ITALIC}.
}
546 \helpref{wxFont::GetStyle
}{wxfontgetstyle
}
549 \membersection{wxFont::SetUnderlined
}\label{wxfontsetunderlined
}
551 \func{void
}{SetUnderlined
}{\param{const bool
}{ underlined
}}
555 \wxheading{Parameters
}
557 \docparam{underlining
}{true to underline, false otherwise.
}
561 \helpref{wxFont::GetUnderlined
}{wxfontgetunderlined
}
564 \membersection{wxFont::SetWeight
}\label{wxfontsetweight
}
566 \func{void
}{SetWeight
}{\param{wxFontWeight
}{ weight
}}
568 Sets the font weight.
570 \wxheading{Parameters
}
572 \docparam{weight
}{One of:
575 \begin{twocollist
}\itemsep=
0pt
576 \twocolitem{{\bf wxFONTWEIGHT
\_NORMAL}}{Normal font.
}
577 \twocolitem{{\bf wxFONTWEIGHT
\_LIGHT}}{Light font.
}
578 \twocolitem{{\bf wxFONTWEIGHT
\_BOLD}}{Bold font.
}
583 \helpref{wxFont::GetWeight
}{wxfontgetweight
}
586 \membersection{wxFont::operator $=$
}\label{wxfontassignment
}
588 \func{wxFont\&
}{operator $=$
}{\param{const wxFont\&
}{font
}}
590 Assignment operator, using
\helpref{reference counting
}{trefcount
}.
593 \membersection{wxFont::operator $==$
}\label{wxfontequals
}
595 \func{bool
}{operator $==$
}{\param{const wxFont\&
}{font
}}
598 See
\helpref{reference-counted object comparison
}{refcountequality
} for more info.
601 \membersection{wxFont::operator $!=$
}\label{wxfontnotequals
}
603 \func{bool
}{operator $!=$
}{\param{const wxFont\&
}{font
}}
606 See
\helpref{reference-counted object comparison
}{refcountequality
} for more info.