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 \wxheading{Derived from
}
9 \helpref{wxGDIObject
}{wxgdiobject
}\\
10 \helpref{wxObject
}{wxobject
}
12 \wxheading{Include files
}
16 \wxheading{Predefined objects
}
31 \helpref{wxFont overview
}{wxfontoverview
},
\helpref{wxDC::SetFont
}{wxdcsetfont
},
\rtfsp
32 \helpref{wxDC::DrawText
}{wxdcdrawtext
},
\helpref{wxDC::GetTextExtent
}{wxdcgettextextent
},
\rtfsp
33 \helpref{wxFontDialog
}{wxfontdialog
}
35 \latexignore{\rtfignore{\wxheading{Members
}}}
37 \membersection{wxFont::wxFont
}\label{wxfontconstr
}
39 \func{}{wxFont
}{\void}
43 \func{}{wxFont
}{\param{int
}{ pointSize
},
\param{int
}{ family
},
\param{int
}{ style
},
\param{int
}{ weight
},
44 \param{const bool
}{ underline = FALSE
},
\param{const wxString\&
}{faceName = ""
},
45 \param{wxFontEncoding
}{encoding = wxFONTENCODING
\_DEFAULT}}
47 Creates a font object (see
\helpref{font encoding
48 overview
}{wxfontencodingoverview
} for the meaning of the last parameter).
50 \wxheading{Parameters
}
52 \docparam{pointSize
}{Size in points.
}
54 \docparam{family
}{Font family, a generic way of referring to fonts without specifying actual facename. One of:
57 \begin{twocollist
}\itemsep=
0pt
58 \twocolitem{{\bf wxDEFAULT
}}{Chooses a default font.
}
59 \twocolitem{{\bf wxDECORATIVE
}}{A decorative font.
}
60 \twocolitem{{\bf wxROMAN
}}{A formal, serif font.
}
61 \twocolitem{{\bf wxSCRIPT
}}{A handwriting font.
}
62 \twocolitem{{\bf wxSWISS
}}{A sans-serif font.
}
63 \twocolitem{{\bf wxMODERN
}}{A fixed pitch font.
}
66 \docparam{style
}{One of
{\bf wxNORMAL
},
{\bf wxSLANT
} and
{\bf wxITALIC
}.
}
68 \docparam{weight
}{One of
{\bf wxNORMAL
},
{\bf wxLIGHT
} and
{\bf wxBOLD
}.
}
70 \docparam{underline
}{The value can be TRUE or FALSE. At present this has an effect on Windows only.
}
72 \docparam{faceName
}{An optional string specifying the actual typeface to be used. If the empty string,
73 a default typeface will chosen based on the family.
}
75 \docparam{encoding
}{An encoding which may be one of
77 \begin{twocollist
}\itemsep=
0pt
78 \twocolitem{{\bf wxFONTENCODING
\_SYSTEM}}{Default system encoding.
}
79 \twocolitem{{\bf wxFONTENCODING
\_DEFAULT}}{Default application encoding: this
80 is the encoding set by calls to
81 \helpref{SetDefaultEncoding
}{wxfontsetdefaultencoding
} and which may be set to,
82 say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
83 default application encoding is the same as default system encoding.
}
84 \twocolitem{{\bf wxFONTENCODING
\_ISO8859\_1..
.15}}{ISO8859 encodings.
}
85 \twocolitem{{\bf wxFONTENCODING
\_KOI8}}{The standard russian encoding for Internet.
}
86 \twocolitem{{\bf wxFONTENCODING
\_CP1250..
.1252}}{Windows encodings similar to ISO8859 (but not identical).
}
88 If the specified encoding isn't available, no font is created.
93 If the desired font does not exist, the closest match will be chosen.
94 Under Windows, only scaleable TrueType fonts are used.
96 See also
\helpref{wxDC::SetFont
}{wxdcsetfont
},
\helpref{wxDC::DrawText
}{wxdcdrawtext
}
97 and
\helpref{wxDC::GetTextExtent
}{wxdcgettextextent
}.
99 \membersection{wxFont::
\destruct{wxFont
}}
101 \func{}{\destruct{wxFont
}}{\void}
107 The destructor may not delete the underlying font object of the native windowing
108 system, since wxFont uses a reference counting system for efficiency.
110 Although all remaining fonts are deleted when the application exits,
111 the application should try to clean up all fonts itself. This is because
112 wxWindows cannot know if a pointer to the font object is stored in an
113 application data structure, and there is a risk of double deletion.
115 \membersection{wxFont::GetDefaultEncoding
}\label{wxfontgetdefaultencoding
}
117 \func{static wxFontEncoding
}{GetDefaultEncoding
}{\void}
119 Returns the current applications default encoding.
123 \helpref{Font encoding overview
}{wxfontencodingoverview
},
124 \helpref{SetDefaultEncoding
}{wxfontsetdefaultencoding
}
126 \membersection{wxFont::GetFaceName
}\label{wxfontgetfacename
}
128 \constfunc{wxString
}{GetFaceName
}{\void}
130 Returns the typeface name associated with the font, or the empty string if there is no
131 typeface information.
135 \helpref{wxFont::SetFaceName
}{wxfontsetfacename
}
137 \membersection{wxFont::GetFamily
}\label{wxfontgetfamily
}
139 \constfunc{int
}{GetFamily
}{\void}
141 Gets the font family. See
\helpref{wxFont::wxFont
}{wxfontconstr
} for a list of valid
146 \helpref{wxFont::SetFamily
}{wxfontsetfamily
}
148 \membersection{wxFont::GetFontId
}\label{wxfontgetfontid
}
150 \constfunc{int
}{GetFontId
}{\void}
152 Returns the font id, if the portable font system is in operation. See
\helpref{Font overview
}{wxfontoverview
} for
155 \membersection{wxFont::GetPointSize
}\label{wxfontgetpointsize
}
157 \constfunc{int
}{GetPointSize
}{\void}
163 \helpref{wxFont::SetPointSize
}{wxfontsetpointsize
}
165 \membersection{wxFont::GetStyle
}\label{wxfontgetstyle
}
167 \constfunc{int
}{GetStyle
}{\void}
169 Gets the font style. See
\helpref{wxFont::wxFont
}{wxfontconstr
} for a list of valid
174 \helpref{wxFont::SetStyle
}{wxfontsetstyle
}
176 \membersection{wxFont::GetUnderlined
}\label{wxfontgetunderlined
}
178 \constfunc{bool
}{GetUnderlined
}{\void}
180 Returns TRUE if the font is underlined, FALSE otherwise.
184 \helpref{wxFont::SetUnderlined
}{wxfontsetunderlined
}
186 \membersection{wxFont::GetWeight
}\label{wxfontgetweight
}
188 \constfunc{int
}{GetWeight
}{\void}
190 Gets the font weight. See
\helpref{wxFont::wxFont
}{wxfontconstr
} for a list of valid
195 \helpref{wxFont::SetWeight
}{wxfontsetweight
}
197 \membersection{wxFont::SetDefaultEncoding
}\label{wxfontsetdefaultencoding
}
199 \func{static void
}{SetDefaultEncoding
}{\param{wxFontEncoding
}{encoding
}}
201 Sets the default font encoding.
205 \helpref{Font encoding overview
}{wxfontencodingoverview
},
206 \helpref{GetDefaultEncoding
}{wxfontgetdefaultencoding
}
208 \membersection{wxFont::SetFaceName
}\label{wxfontsetfacename
}
210 \func{void
}{SetFaceName
}{\param{const wxString\&
}{faceName
}}
212 Sets the facename for the font.
214 \wxheading{Parameters
}
216 \docparam{faceName
}{A valid facename, which should be on the end-user's system.
}
220 To avoid portability problems, don't rely on a specific face, but specify the font family
221 instead or as well. A suitable font will be found on the end-user's system. If both the
222 family and the facename are specified, wxWindows will first search for the specific face,
223 and then for a font belonging to the same family.
227 \helpref{wxFont::GetFaceName
}{wxfontgetfacename
},
\helpref{wxFont::SetFamily
}{wxfontsetfamily
}
229 \membersection{wxFont::SetFamily
}\label{wxfontsetfamily
}
231 \func{void
}{SetFamily
}{\param{int
}{ family
}}
233 Sets the font family.
235 \wxheading{Parameters
}
237 \docparam{family
}{One of:
240 \begin{twocollist
}\itemsep=
0pt
241 \twocolitem{{\bf wxDEFAULT
}}{Chooses a default font.
}
242 \twocolitem{{\bf wxDECORATIVE
}}{A decorative font.
}
243 \twocolitem{{\bf wxROMAN
}}{A formal, serif font.
}
244 \twocolitem{{\bf wxSCRIPT
}}{A handwriting font.
}
245 \twocolitem{{\bf wxSWISS
}}{A sans-serif font.
}
246 \twocolitem{{\bf wxMODERN
}}{A fixed pitch font.
}
251 \helpref{wxFont::GetFamily
}{wxfontgetfamily
},
\helpref{wxFont::SetFaceName
}{wxfontsetfacename
}
253 \membersection{wxFont::SetPointSize
}\label{wxfontsetpointsize
}
255 \func{void
}{SetPointSize
}{\param{int
}{ pointSize
}}
259 \wxheading{Parameters
}
261 \docparam{pointSize
}{Size in points.
}
265 \helpref{wxFont::GetPointSize
}{wxfontgetpointsize
}
267 \membersection{wxFont::SetStyle
}\label{wxfontsetstyle
}
269 \func{void
}{SetStyle
}{\param{int
}{ style
}}
273 \wxheading{Parameters
}
275 \docparam{style
}{One of
{\bf wxNORMAL
},
{\bf wxSLANT
} and
{\bf wxITALIC
}.
}
279 \helpref{wxFont::GetStyle
}{wxfontgetstyle
}
281 \membersection{wxFont::SetUnderlined
}\label{wxfontsetunderlined
}
283 \func{void
}{SetUnderlined
}{\param{const bool
}{ underlined
}}
287 \wxheading{Parameters
}
289 \docparam{underlining
}{TRUE to underline, FALSE otherwise.
}
293 \helpref{wxFont::GetUnderlined
}{wxfontgetunderlined
}
295 \membersection{wxFont::SetWeight
}\label{wxfontsetweight
}
297 \func{void
}{SetWeight
}{\param{int
}{ weight
}}
299 Sets the font weight.
301 \wxheading{Parameters
}
303 \docparam{weight
}{One of
{\bf wxNORMAL
},
{\bf wxLIGHT
} and
{\bf wxBOLD
}.
}
307 \helpref{wxFont::GetWeight
}{wxfontgetweight
}
309 \membersection{wxFont::operator $=$
}\label{wxfontassignment
}
311 \func{wxFont\&
}{operator $=$
}{\param{const wxFont\&
}{font
}}
313 Assignment operator, using reference counting. Returns a reference
316 \membersection{wxFont::operator $==$
}\label{wxfontequals
}
318 \func{bool
}{operator $==$
}{\param{const wxFont\&
}{font
}}
320 Equality operator. Two fonts are equal if they contain pointers
321 to the same underlying font data. It does not compare each attribute,
322 so two indefontdently-created fonts using the same parameters will
325 \membersection{wxFont::operator $!=$
}\label{wxfontnotequals
}
327 \func{bool
}{operator $!=$
}{\param{const wxFont\&
}{font
}}
329 Inequality operator. Two fonts are not equal if they contain pointers
330 to different underlying font data. It does not compare each attribute.
projects / wxWidgets.git / blob