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 You can retrieve the current system font settings with
\helpref{wxSystemSettings
}{wxsystemsettings
}.
9 \helpref{wxSystemSettings
}{wxsystemsettings
}
11 \wxheading{Derived from
}
13 \helpref{wxGDIObject
}{wxgdiobject
}\\
14 \helpref{wxObject
}{wxobject
}
16 \wxheading{Include files
}
22 The possible values for the
\arg{family
} parameter of
\helpref{wxFont
23 constructor
}{wxfontctor
} are (the old names are for compatibility only):
28 wxFONTFAMILY_DEFAULT = wxDEFAULT,
29 wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
30 wxFONTFAMILY_ROMAN = wxROMAN,
31 wxFONTFAMILY_SCRIPT = wxSCRIPT,
32 wxFONTFAMILY_SWISS = wxSWISS,
33 wxFONTFAMILY_MODERN = wxMODERN,
34 wxFONTFAMILY_TELETYPE = wxTELETYPE,
39 The possible values for the
\arg{weight
} parameter are (the old names
40 are for compatibility only):
45 wxFONTWEIGHT_NORMAL = wxNORMAL,
46 wxFONTWEIGHT_LIGHT = wxLIGHT,
47 wxFONTWEIGHT_BOLD = wxBOLD,
52 The font flags which can be used during the font creation are:
57 // no special flags: font with default weight/slant/anti-aliasing
58 wxFONTFLAG_DEFAULT =
0,
60 // slant flags (default: no slant)
61 wxFONTFLAG_ITALIC =
1 <<
0,
62 wxFONTFLAG_SLANT =
1 <<
1,
64 // weight flags (default: medium)
65 wxFONTFLAG_LIGHT =
1 <<
2,
66 wxFONTFLAG_BOLD =
1 <<
3,
68 // anti-aliasing flag: force on or off (default: the current system default)
69 wxFONTFLAG_ANTIALIASED =
1 <<
4,
70 wxFONTFLAG_NOT_ANTIALIASED =
1 <<
5,
72 // underlined/strikethrough flags (default: no lines)
73 wxFONTFLAG_UNDERLINED =
1 <<
6,
74 wxFONTFLAG_STRIKETHROUGH =
1 <<
7,
78 The known font encodings are:
83 wxFONTENCODING_SYSTEM = -
1, // system default
84 wxFONTENCODING_DEFAULT, // current default encoding
86 // ISO8859 standard defines a number of single-byte charsets
87 wxFONTENCODING_ISO8859_1, // West European (Latin1)
88 wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
89 wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
90 wxFONTENCODING_ISO8859_4, // Baltic (old) (Latin4)
91 wxFONTENCODING_ISO8859_5, // Cyrillic
92 wxFONTENCODING_ISO8859_6, // Arabic
93 wxFONTENCODING_ISO8859_7, // Greek
94 wxFONTENCODING_ISO8859_8, // Hebrew
95 wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
96 wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
97 wxFONTENCODING_ISO8859_11, // Thai
98 wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
99 // here anyhow to make all ISO8859
100 // consecutive numbers
101 wxFONTENCODING_ISO8859_13, // Baltic (Latin7)
102 wxFONTENCODING_ISO8859_14, // Latin8
103 wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
104 wxFONTENCODING_ISO8859_MAX,
106 // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
107 wxFONTENCODING_KOI8, // we don't support any of KOI8 variants
108 wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
109 wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
111 // what would we do without Microsoft? They have their own encodings
113 wxFONTENCODING_CP437, // original MS-DOS codepage
114 wxFONTENCODING_CP850, // CP437 merged with Latin1
115 wxFONTENCODING_CP852, // CP437 merged with Latin2
116 wxFONTENCODING_CP855, // another cyrillic encoding
117 wxFONTENCODING_CP866, // and another one
119 wxFONTENCODING_CP874, // WinThai
120 wxFONTENCODING_CP1250, // WinLatin2
121 wxFONTENCODING_CP1251, // WinCyrillic
122 wxFONTENCODING_CP1252, // WinLatin1
123 wxFONTENCODING_CP1253, // WinGreek (
8859-
7)
124 wxFONTENCODING_CP1254, // WinTurkish
125 wxFONTENCODING_CP1255, // WinHebrew
126 wxFONTENCODING_CP1256, // WinArabic
127 wxFONTENCODING_CP1257, // WinBaltic (same as Latin
7)
128 wxFONTENCODING_CP12_MAX,
130 wxFONTENCODING_UTF7, // UTF-
7 Unicode encoding
131 wxFONTENCODING_UTF8, // UTF-
8 Unicode encoding
133 wxFONTENCODING_UNICODE, // Unicode - currently used only by
134 // wxEncodingConverter class
140 \wxheading{Predefined objects
}
148 {\bf wxNORMAL
\_FONT\\
155 \helpref{wxFont overview
}{wxfontoverview
},
\helpref{wxDC::SetFont
}{wxdcsetfont
},
\rtfsp
156 \helpref{wxDC::DrawText
}{wxdcdrawtext
},
\helpref{wxDC::GetTextExtent
}{wxdcgettextextent
},
\rtfsp
157 \helpref{wxFontDialog
}{wxfontdialog
},
\helpref{wxSystemSettings
}{wxsystemsettings
}
159 \latexignore{\rtfignore{\wxheading{Members
}}}
162 \membersection{wxFont::wxFont
}\label{wxfontctor
}
164 \func{}{wxFont
}{\void}
168 \func{}{wxFont
}{\param{int
}{ pointSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
169 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
170 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
172 \func{}{wxFont
}{\param{const wxSize\&
}{ pixelSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
173 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
174 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
176 Creates a font object with the specified attributes.
178 \wxheading{Parameters
}
180 \docparam{pointSize
}{Size in points.
}
182 \docparam{pixelSize
}{Size in pixels: this is directly supported only under MSW
183 currently where this constructor can be used directly, under other platforms a
184 font with the closest size to the given one is found using binary search and
185 the static
\helpref{New
}{wxfontnew
} method must be used.
}
187 \docparam{family
}{Font family, a generic way of referring to fonts without specifying actual facename. One of:
190 \begin{twocollist
}\itemsep=
0pt
191 \twocolitem{{\bf wxFONTFAMILY
\_DEFAULT}}{Chooses a default font.
}
192 \twocolitem{{\bf wxFONTFAMILY
\_DECORATIVE}}{A decorative font.
}
193 \twocolitem{{\bf wxFONTFAMILY
\_ROMAN}}{A formal, serif font.
}
194 \twocolitem{{\bf wxFONTFAMILY
\_SCRIPT}}{A handwriting font.
}
195 \twocolitem{{\bf wxFONTFAMILY
\_SWISS}}{A sans-serif font.
}
196 \twocolitem{{\bf wxFONTFAMILY
\_MODERN}}{A fixed pitch font.
}
197 \twocolitem{{\bf wxFONTFAMILY
\_TELETYPE}}{A teletype font.
}
200 \docparam{style
}{One of
{\bf wxFONTSTYLE
\_NORMAL},
{\bf wxFONTSTYLE
\_SLANT} and
{\bf wxFONTSTYLE
\_ITALIC}.
}
202 \docparam{weight
}{Font weight, sometimes also referred to as font boldness. One of:
205 \begin{twocollist
}\itemsep=
0pt
206 \twocolitem{{\bf wxFONTWEIGHT
\_NORMAL}}{Normal font.
}
207 \twocolitem{{\bf wxFONTWEIGHT
\_LIGHT}}{Light font.
}
208 \twocolitem{{\bf wxFONTWEIGHT
\_BOLD}}{Bold font.
}
211 \docparam{underline
}{The value can be true or false. At present this has an effect on Windows and Motif
2.x only.
}
213 \docparam{faceName
}{An optional string specifying the actual typeface to be used. If it is an empty string,
214 a default typeface will be chosen based on the family.
}
216 \docparam{encoding
}{An encoding which may be one of
218 \begin{twocollist
}\itemsep=
0pt
219 \twocolitem{{\bf wxFONTENCODING
\_SYSTEM}}{Default system encoding.
}
220 \twocolitem{{\bf wxFONTENCODING
\_DEFAULT}}{Default application encoding: this
221 is the encoding set by calls to
222 \helpref{SetDefaultEncoding
}{wxfontsetdefaultencoding
} and which may be set to,
223 say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
224 default application encoding is the same as default system encoding.
}
225 \twocolitem{{\bf wxFONTENCODING
\_ISO8859\_1..
.15}}{ISO8859 encodings.
}
226 \twocolitem{{\bf wxFONTENCODING
\_KOI8}}{The standard Russian encoding for Internet.
}
227 \twocolitem{{\bf wxFONTENCODING
\_CP1250..
.1252}}{Windows encodings similar to ISO8859 (but not identical).
}
229 If the specified encoding isn't available, no font is created
230 (see also
\helpref{font encoding overview
}{wxfontencodingoverview
}).
235 If the desired font does not exist, the closest match will be chosen.
236 Under Windows, only scalable TrueType fonts are used.
238 See also
\helpref{wxDC::SetFont
}{wxdcsetfont
},
\helpref{wxDC::DrawText
}{wxdcdrawtext
}
239 and
\helpref{wxDC::GetTextExtent
}{wxdcgettextextent
}.
242 \membersection{wxFont::
\destruct{wxFont
}}\label{wxfontdtor
}
244 \func{}{\destruct{wxFont
}}{\void}
250 The destructor may not delete the underlying font object of the native windowing
251 system, since wxFont uses a reference counting system for efficiency.
253 Although all remaining fonts are deleted when the application exits,
254 the application should try to clean up all fonts itself. This is because
255 wxWidgets cannot know if a pointer to the font object is stored in an
256 application data structure, and there is a risk of double deletion.
259 \membersection{wxFont::IsFixedWidth
}\label{wxfontisfixedwidth
}
261 \constfunc{bool
}{IsFixedWidth
}{\void}
263 Returns
{\tt true
} if the font is a fixed width (or monospaced) font,
264 {\tt false
} if it is a proportional one or font is invalid.
267 \membersection{wxFont::GetDefaultEncoding
}\label{wxfontgetdefaultencoding
}
269 \func{static wxFontEncoding
}{GetDefaultEncoding
}{\void}
271 Returns the current application's default encoding.
275 \helpref{Font encoding overview
}{wxfontencodingoverview
},
276 \helpref{SetDefaultEncoding
}{wxfontsetdefaultencoding
}
279 \membersection{wxFont::GetFaceName
}\label{wxfontgetfacename
}
281 \constfunc{wxString
}{GetFaceName
}{\void}
283 Returns the typeface name associated with the font, or the empty string if there is no
284 typeface information.
288 \helpref{wxFont::SetFaceName
}{wxfontsetfacename
}
291 \membersection{wxFont::GetFamily
}\label{wxfontgetfamily
}
293 \constfunc{wxFontFamily
}{GetFamily
}{\void}
295 Gets the font family. See
\helpref{wxFont::SetFamily
}{wxfontsetfamily
} for a list of valid
300 \helpref{wxFont::SetFamily
}{wxfontsetfamily
}
303 \membersection{wxFont::GetNativeFontInfoDesc
}\label{wxfontgetnativefontinfodesc
}
305 \constfunc{wxString
}{GetNativeFontInfoDesc
}{\void}
307 Returns the platform-dependent string completely describing this font or an
308 empty string if the font wasn't constructed using the native font description.
312 \helpref{wxFont::SetNativeFontInfo
}{wxfontsetnativefontinfo
}
315 \membersection{wxFont::GetPointSize
}\label{wxfontgetpointsize
}
317 \constfunc{int
}{GetPointSize
}{\void}
323 \helpref{wxFont::SetPointSize
}{wxfontsetpointsize
}
326 \membersection{wxFont::GetStyle
}\label{wxfontgetstyle
}
328 \constfunc{int
}{GetStyle
}{\void}
330 Gets the font style. See
\helpref{wxFont::wxFont
}{wxfontctor
} for a list of valid
335 \helpref{wxFont::SetStyle
}{wxfontsetstyle
}
338 \membersection{wxFont::GetUnderlined
}\label{wxfontgetunderlined
}
340 \constfunc{bool
}{GetUnderlined
}{\void}
342 Returns true if the font is underlined, false otherwise.
346 \helpref{wxFont::SetUnderlined
}{wxfontsetunderlined
}
349 \membersection{wxFont::GetWeight
}\label{wxfontgetweight
}
351 \constfunc{wxFontWeight
}{GetWeight
}{\void}
353 Gets the font weight. See
\helpref{wxFont::wxFont
}{wxfontctor
} for a list of valid
358 \helpref{wxFont::SetWeight
}{wxfontsetweight
}
361 \membersection{wxFont::New
}\label{wxfontnew
}
363 \func{static wxFont *
}{New
}{\param{int
}{ pointSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
364 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
365 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
367 \func{static wxFont *
}{New
}{\param{int
}{ pointSize
},
\param{wxFontFamily
}{ family
},
368 \param{int
}{ flags =
\texttt{wxFONTFLAG
\_DEFAULT}},
\param{const wxString\&
}{faceName = ""
},
369 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
371 \func{static wxFont *
}{New
}{\param{const wxSize\&
}{ pixelSize
},
\param{wxFontFamily
}{ family
},
\param{int
}{ style
},
\param{wxFontWeight
}{ weight
},
372 \param{const bool
}{ underline = false
},
\param{const wxString\&
}{faceName = ""
},
373 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
375 \func{static wxFont *
}{New
}{\param{const wxSize\&
}{ pixelSize
},
\param{wxFontFamily
}{ family
},
376 \param{int
}{ flags =
\texttt{wxFONTFLAG
\_DEFAULT}},
\param{const wxString\&
}{faceName = ""
},
377 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
379 These functions take the same parameters as
\helpref{wxFont
380 constructor
}{wxfontctor
} and return a new font object allocated on the heap.
382 Using
\texttt{New()
} is currently the only way to directly create a font with
383 the given size in pixels on platforms other than wxMSW.
386 \membersection{wxFont::Ok
}\label{wxfontok
}
388 \constfunc{bool
}{Ok
}{\void}
390 Returns
{\tt true
} if this object is a valid font,
{\tt false
} otherwise.
393 \membersection{wxFont::SetDefaultEncoding
}\label{wxfontsetdefaultencoding
}
395 \func{static void
}{SetDefaultEncoding
}{\param{wxFontEncoding
}{encoding
}}
397 Sets the default font encoding.
401 \helpref{Font encoding overview
}{wxfontencodingoverview
},
402 \helpref{GetDefaultEncoding
}{wxfontgetdefaultencoding
}
405 \membersection{wxFont::SetFaceName
}\label{wxfontsetfacename
}
407 \func{void
}{SetFaceName
}{\param{const wxString\&
}{faceName
}}
409 Sets the facename for the font.
411 \wxheading{Parameters
}
413 \docparam{faceName
}{A valid facename, which should be on the end-user's system.
}
417 To avoid portability problems, don't rely on a specific face, but specify the font family
418 instead or as well. A suitable font will be found on the end-user's system. If both the
419 family and the facename are specified, wxWidgets will first search for the specific face,
420 and then for a font belonging to the same family.
424 \helpref{wxFont::GetFaceName
}{wxfontgetfacename
},
\helpref{wxFont::SetFamily
}{wxfontsetfamily
}
427 \membersection{wxFont::SetFamily
}\label{wxfontsetfamily
}
429 \func{void
}{SetFamily
}{\param{wxFontFamily
}{ family
}}
431 Sets the font family.
433 \wxheading{Parameters
}
435 \docparam{family
}{One of:
438 \begin{twocollist
}\itemsep=
0pt
439 \twocolitem{{\bf wxFONTFAMILY
\_DEFAULT}}{Chooses a default font.
}
440 \twocolitem{{\bf wxFONTFAMILY
\_DECORATIVE}}{A decorative font.
}
441 \twocolitem{{\bf wxFONTFAMILY
\_ROMAN}}{A formal, serif font.
}
442 \twocolitem{{\bf wxFONTFAMILY
\_SCRIPT}}{A handwriting font.
}
443 \twocolitem{{\bf wxFONTFAMILY
\_SWISS}}{A sans-serif font.
}
444 \twocolitem{{\bf wxFONTFAMILY
\_MODERN}}{A fixed pitch font.
}
445 \twocolitem{{\bf wxFONTFAMILY
\_TELETYPE}}{A teletype font.
}
450 \helpref{wxFont::GetFamily
}{wxfontgetfamily
},
\helpref{wxFont::SetFaceName
}{wxfontsetfacename
}
453 \membersection{wxFont::SetNativeFontInfo
}\label{wxfontsetnativefontinfo
}
455 \func{void
}{SetNativeFontInfo
}{\param{const wxString\&
}{info
}}
457 Creates the font corresponding to the given native font description string
458 which must have been previously returned by
459 \helpref{GetNativeFontInfoDesc
}{wxfontgetnativefontinfodesc
}. If the string is
460 invalid, font is unchanged.
463 \membersection{wxFont::SetPointSize
}\label{wxfontsetpointsize
}
465 \func{void
}{SetPointSize
}{\param{int
}{ pointSize
}}
469 \wxheading{Parameters
}
471 \docparam{pointSize
}{Size in points.
}
475 \helpref{wxFont::GetPointSize
}{wxfontgetpointsize
}
478 \membersection{wxFont::SetStyle
}\label{wxfontsetstyle
}
480 \func{void
}{SetStyle
}{\param{int
}{ style
}}
484 \wxheading{Parameters
}
486 \docparam{style
}{One of
{\bf wxFONTSTYLE
\_NORMAL},
{\bf wxFONTSTYLE
\_SLANT} and
{\bf wxFONTSTYLE
\_ITALIC}.
}
490 \helpref{wxFont::GetStyle
}{wxfontgetstyle
}
493 \membersection{wxFont::SetUnderlined
}\label{wxfontsetunderlined
}
495 \func{void
}{SetUnderlined
}{\param{const bool
}{ underlined
}}
499 \wxheading{Parameters
}
501 \docparam{underlining
}{true to underline, false otherwise.
}
505 \helpref{wxFont::GetUnderlined
}{wxfontgetunderlined
}
508 \membersection{wxFont::SetWeight
}\label{wxfontsetweight
}
510 \func{void
}{SetWeight
}{\param{wxFontWeight
}{ weight
}}
512 Sets the font weight.
514 \wxheading{Parameters
}
516 \docparam{weight
}{One of:
519 \begin{twocollist
}\itemsep=
0pt
520 \twocolitem{{\bf wxFONTWEIGHT
\_NORMAL}}{Normal font.
}
521 \twocolitem{{\bf wxFONTWEIGHT
\_LIGHT}}{Light font.
}
522 \twocolitem{{\bf wxFONTWEIGHT
\_BOLD}}{Bold font.
}
527 \helpref{wxFont::GetWeight
}{wxfontgetweight
}
530 \membersection{wxFont::operator $=$
}\label{wxfontassignment
}
532 \func{wxFont\&
}{operator $=$
}{\param{const wxFont\&
}{font
}}
534 Assignment operator, using reference counting. Returns a reference
538 \membersection{wxFont::operator $==$
}\label{wxfontequals
}
540 \func{bool
}{operator $==$
}{\param{const wxFont\&
}{font
}}
542 Equality operator. Two fonts are equal if they contain pointers
543 to the same underlying font data. It does not compare each attribute,
544 so two independently-created fonts using the same parameters will
548 \membersection{wxFont::operator $!=$
}\label{wxfontnotequals
}
550 \func{bool
}{operator $!=$
}{\param{const wxFont\&
}{font
}}
552 Inequality operator. Two fonts are not equal if they contain pointers
553 to different underlying font data. It does not compare each attribute.