docs/latex/wx/font.tex

   1 \section{\class{wxFont}}\label{wxfont}
   2
   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
   5 a window's text.
   6
   7 You can retrieve the current system font settings with \helpref{wxSystemSettings}{wxsystemsettings}.
   8
   9 \helpref{wxSystemSettings}{wxsystemsettings}
  10
  11 \wxheading{Derived from}
  12
  13 \helpref{wxGDIObject}{wxgdiobject}\\
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Include files}
  17
  18 <wx/font.h>
  19
  20 \wxheading{Constants}
  21
  22 The possible values for the \arg{family} parameter of \helpref{wxFont
  23 constructor}{wxfontctor} are (the old names are for compatibility only):
  24
  25 \begin{verbatim}
  26 enum wxFontFamily
  27 {
  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,
  35     wxFONTFAMILY_MAX
  36 };
  37 \end{verbatim}
  38
  39 The possible values for the \arg{weight} parameter are (the old names
  40 are for compatibility only):
  41
  42 \begin{verbatim}
  43 enum wxFontWeight
  44 {
  45     wxFONTWEIGHT_NORMAL = wxNORMAL,
  46     wxFONTWEIGHT_LIGHT = wxLIGHT,
  47     wxFONTWEIGHT_BOLD = wxBOLD,
  48     wxFONTWEIGHT_MAX
  49 };
  50 \end{verbatim}
  51
  52 The font flags which can be used during the font creation are:
  53
  54 \begin{verbatim}
  55 enum
  56 {
  57     // no special flags: font with default weight/slant/anti-aliasing
  58     wxFONTFLAG_DEFAULT          = 0,
  59
  60     // slant flags (default: no slant)
  61     wxFONTFLAG_ITALIC           = 1 << 0,
  62     wxFONTFLAG_SLANT            = 1 << 1,
  63
  64     // weight flags (default: medium)
  65     wxFONTFLAG_LIGHT            = 1 << 2,
  66     wxFONTFLAG_BOLD             = 1 << 3,
  67
  68     // anti-aliasing flag: force on or off (default: the current system default)
  69     wxFONTFLAG_ANTIALIASED      = 1 << 4,
  70     wxFONTFLAG_NOT_ANTIALIASED  = 1 << 5,
  71
  72     // underlined/strikethrough flags (default: no lines)
  73     wxFONTFLAG_UNDERLINED       = 1 << 6,
  74     wxFONTFLAG_STRIKETHROUGH    = 1 << 7,
  75 };
  76 \end{verbatim}
  77
  78 The known font encodings are:
  79
  80 \begin{verbatim}
  81 enum wxFontEncoding
  82 {
  83     wxFONTENCODING_SYSTEM = -1,     // system default
  84     wxFONTENCODING_DEFAULT,         // current default encoding
  85
  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,
 105
 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
 110
 111     // what would we do without Microsoft? They have their own encodings
 112         // for DOS
 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
 118         // and for Windows
 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,
 129
 130     wxFONTENCODING_UTF7,            // UTF-7 Unicode encoding
 131     wxFONTENCODING_UTF8,            // UTF-8 Unicode encoding
 132
 133     wxFONTENCODING_UNICODE,         // Unicode - currently used only by
 134                                     // wxEncodingConverter class
 135
 136     wxFONTENCODING_MAX
 137 };
 138 \end{verbatim}
 139
 140 \wxheading{Predefined objects}
 141
 142 Objects:
 143
 144 {\bf wxNullFont}
 145
 146 Pointers:
 147
 148 {\bf wxNORMAL\_FONT\\
 149 wxSMALL\_FONT\\
 150 wxITALIC\_FONT\\
 151 wxSWISS\_FONT}
 152
 153 \wxheading{See also}
 154
 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}
 158
 159 \latexignore{\rtfignore{\wxheading{Members}}}
 160
 161
 162 \membersection{wxFont::wxFont}\label{wxfontctor}
 163
 164 \func{}{wxFont}{\void}
 165
 166 Default constructor.
 167
 168 \func{}{wxFont}{\param{const wxFont\&}{ font}}
 169
 170 Copy constructor, uses \helpref{reference counting}{trefcount}.
 171
 172 \func{}{wxFont}{\param{int}{ pointSize}, \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}}
 175
 176 \func{}{wxFont}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{wxFontWeight}{ weight},
 177  \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
 178  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 179
 180 Creates a font object with the specified attributes.
 181
 182 \wxheading{Parameters}
 183
 184 \docparam{pointSize}{Size in points.}
 185
 186 \docparam{pixelSize}{Size in pixels: this is directly supported only under MSW
 187 currently where this constructor can be used directly, under other platforms a
 188 font with the closest size to the given one is found using binary search and
 189 the static \helpref{New}{wxfontnew} method must be used.}
 190
 191 \docparam{family}{Font family, a generic way of referring to fonts without specifying actual facename. One of:
 192
 193 \twocolwidtha{5cm}
 194 \begin{twocollist}\itemsep=0pt
 195 \twocolitem{{\bf wxFONTFAMILY\_DEFAULT}}{Chooses a default font.}
 196 \twocolitem{{\bf wxFONTFAMILY\_DECORATIVE}}{A decorative font.}
 197 \twocolitem{{\bf wxFONTFAMILY\_ROMAN}}{A formal, serif font.}
 198 \twocolitem{{\bf wxFONTFAMILY\_SCRIPT}}{A handwriting font.}
 199 \twocolitem{{\bf wxFONTFAMILY\_SWISS}}{A sans-serif font.}
 200 \twocolitem{{\bf wxFONTFAMILY\_MODERN}}{A fixed pitch font.}
 201 \twocolitem{{\bf wxFONTFAMILY\_TELETYPE}}{A teletype font.}
 202 \end{twocollist}}
 203
 204 \docparam{style}{One of {\bf wxFONTSTYLE\_NORMAL}, {\bf wxFONTSTYLE\_SLANT} and {\bf wxFONTSTYLE\_ITALIC}.}
 205
 206 \docparam{weight}{Font weight, sometimes also referred to as font boldness. One of:
 207
 208 \twocolwidtha{5cm}
 209 \begin{twocollist}\itemsep=0pt
 210 \twocolitem{{\bf wxFONTWEIGHT\_NORMAL}}{Normal font.}
 211 \twocolitem{{\bf wxFONTWEIGHT\_LIGHT}}{Light font.}
 212 \twocolitem{{\bf wxFONTWEIGHT\_BOLD}}{Bold font.}
 213 \end{twocollist}}
 214
 215 \docparam{underline}{The value can be true or false. At present this has an effect on Windows and Motif 2.x only.}
 216
 217 \docparam{faceName}{An optional string specifying the actual typeface to be used. If it is an empty string,
 218 a default typeface will be chosen based on the family.}
 219
 220 \docparam{encoding}{An encoding which may be one of
 221 \twocolwidtha{5cm}
 222 \begin{twocollist}\itemsep=0pt
 223 \twocolitem{{\bf wxFONTENCODING\_SYSTEM}}{Default system encoding.}
 224 \twocolitem{{\bf wxFONTENCODING\_DEFAULT}}{Default application encoding: this
 225 is the encoding set by calls to
 226 \helpref{SetDefaultEncoding}{wxfontsetdefaultencoding} and which may be set to,
 227 say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
 228 default application encoding is the same as default system encoding.}
 229 \twocolitem{{\bf wxFONTENCODING\_ISO8859\_1...15}}{ISO8859 encodings.}
 230 \twocolitem{{\bf wxFONTENCODING\_KOI8}}{The standard Russian encoding for Internet.}
 231 \twocolitem{{\bf wxFONTENCODING\_CP1250...1252}}{Windows encodings similar to ISO8859 (but not identical).}
 232 \end{twocollist}
 233 If the specified encoding isn't available, no font is created
 234 (see also \helpref{font encoding overview}{wxfontencodingoverview}).
 235 }
 236
 237 \wxheading{Remarks}
 238
 239 If the desired font does not exist, the closest match will be chosen.
 240 Under Windows, only scalable TrueType fonts are used.
 241
 242 See also \helpref{wxDC::SetFont}{wxdcsetfont}, \helpref{wxDC::DrawText}{wxdcdrawtext}
 243 and \helpref{wxDC::GetTextExtent}{wxdcgettextextent}.
 244
 245
 246 \membersection{wxFont::\destruct{wxFont}}\label{wxfontdtor}
 247
 248 \func{}{\destruct{wxFont}}{\void}
 249
 250 Destructor.
 251
 252 \wxheading{Remarks}
 253
 254 The destructor may not delete the underlying font object of the native windowing
 255 system, since wxFont uses a reference counting system for efficiency.
 256
 257 Although all remaining fonts are deleted when the application exits,
 258 the application should try to clean up all fonts itself. This is because
 259 wxWidgets cannot know if a pointer to the font object is stored in an
 260 application data structure, and there is a risk of double deletion.
 261
 262
 263 \membersection{wxFont::IsFixedWidth}\label{wxfontisfixedwidth}
 264
 265 \constfunc{bool}{IsFixedWidth}{\void}
 266
 267 Returns {\tt true} if the font is a fixed width (or monospaced) font,
 268 {\tt false} if it is a proportional one or font is invalid.
 269
 270
 271 \membersection{wxFont::GetDefaultEncoding}\label{wxfontgetdefaultencoding}
 272
 273 \func{static wxFontEncoding}{GetDefaultEncoding}{\void}
 274
 275 Returns the current application's default encoding.
 276
 277 \wxheading{See also}
 278
 279 \helpref{Font encoding overview}{wxfontencodingoverview},
 280 \helpref{SetDefaultEncoding}{wxfontsetdefaultencoding}
 281
 282
 283 \membersection{wxFont::GetFaceName}\label{wxfontgetfacename}
 284
 285 \constfunc{wxString}{GetFaceName}{\void}
 286
 287 Returns the typeface name associated with the font, or the empty string if there is no
 288 typeface information.
 289
 290 \wxheading{See also}
 291
 292 \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 293
 294
 295 \membersection{wxFont::GetFamily}\label{wxfontgetfamily}
 296
 297 \constfunc{wxFontFamily}{GetFamily}{\void}
 298
 299 Gets the font family. See \helpref{wxFont::SetFamily}{wxfontsetfamily} for a list of valid
 300 family identifiers.
 301
 302 \wxheading{See also}
 303
 304 \helpref{wxFont::SetFamily}{wxfontsetfamily}
 305
 306
 307 \membersection{wxFont::GetNativeFontInfoDesc}\label{wxfontgetnativefontinfodesc}
 308
 309 \constfunc{wxString}{GetNativeFontInfoDesc}{\void}
 310
 311 Returns the platform-dependent string completely describing this font.
 312 Returned string is always non-empty.
 313 Note that the returned string is not meant to be shown or edited by the user: a typical
 314 use of this function is for serializing in string-form a wxFont object.
 315
 316 \wxheading{See also}
 317
 318 \helpref{wxFont::SetNativeFontInfo}{wxfontsetnativefontinfo},\helpref{wxFont::GetNativeFontInfoUserDesc}{wxfontgetnativefontinfouserdesc}
 319
 320
 321 \membersection{wxFont::GetNativeFontInfoUserDesc}\label{wxfontgetnativefontinfouserdesc}
 322
 323 \func{wxString}{GetNativeFontInfoUserDesc}{\void}
 324
 325 Returns a user-friendly string for this font object. Returned string is always non-empty.
 326 Some examples of the formats of returned strings (which are platform-dependent) are in \helpref{SetNativeFontInfoUserDesc}{wxfontsetnativefontinfouserdesc}.
 327
 328 \wxheading{See also}
 329
 330 \helpref{wxFont::GetNativeFontInfoDesc}{wxfontgetnativefontinfodesc}
 331
 332
 333 \membersection{wxFont::GetPointSize}\label{wxfontgetpointsize}
 334
 335 \constfunc{int}{GetPointSize}{\void}
 336
 337 Gets the point size.
 338
 339 \wxheading{See also}
 340
 341 \helpref{wxFont::SetPointSize}{wxfontsetpointsize}
 342
 343
 344 \membersection{wxFont::GetStyle}\label{wxfontgetstyle}
 345
 346 \constfunc{int}{GetStyle}{\void}
 347
 348 Gets the font style. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 349 styles.
 350
 351 \wxheading{See also}
 352
 353 \helpref{wxFont::SetStyle}{wxfontsetstyle}
 354
 355
 356 \membersection{wxFont::GetUnderlined}\label{wxfontgetunderlined}
 357
 358 \constfunc{bool}{GetUnderlined}{\void}
 359
 360 Returns true if the font is underlined, false otherwise.
 361
 362 \wxheading{See also}
 363
 364 \helpref{wxFont::SetUnderlined}{wxfontsetunderlined}
 365
 366
 367 \membersection{wxFont::GetWeight}\label{wxfontgetweight}
 368
 369 \constfunc{wxFontWeight}{GetWeight}{\void}
 370
 371 Gets the font weight. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 372 weight identifiers.
 373
 374 \wxheading{See also}
 375
 376 \helpref{wxFont::SetWeight}{wxfontsetweight}
 377
 378
 379 \membersection{wxFont::New}\label{wxfontnew}
 380
 381 \func{static wxFont *}{New}{\param{int}{ pointSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{wxFontWeight}{ weight},
 382  \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
 383  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 384
 385 \func{static wxFont *}{New}{\param{int}{ pointSize}, \param{wxFontFamily}{ family},
 386  \param{int}{ flags = \texttt{wxFONTFLAG\_DEFAULT}}, \param{const wxString\& }{faceName = ""},
 387  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 388
 389 \func{static wxFont *}{New}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{wxFontWeight}{ weight},
 390  \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
 391  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 392
 393 \func{static wxFont *}{New}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family},
 394  \param{int}{ flags = \texttt{wxFONTFLAG\_DEFAULT}}, \param{const wxString\& }{faceName = ""},
 395  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 396
 397 These functions take the same parameters as \helpref{wxFont
 398 constructor}{wxfontctor} and return a new font object allocated on the heap.
 399
 400 Using \texttt{New()} is currently the only way to directly create a font with
 401 the given size in pixels on platforms other than wxMSW.
 402
 403
 404 \membersection{wxFont::IsOk}\label{wxfontisok}
 405
 406 \constfunc{bool}{IsOk}{\void}
 407
 408 Returns {\tt true} if this object is a valid font, {\tt false} otherwise.
 409
 410
 411 \membersection{wxFont::SetDefaultEncoding}\label{wxfontsetdefaultencoding}
 412
 413 \func{static void}{SetDefaultEncoding}{\param{wxFontEncoding }{encoding}}
 414
 415 Sets the default font encoding.
 416
 417 \wxheading{See also}
 418
 419 \helpref{Font encoding overview}{wxfontencodingoverview},
 420 \helpref{GetDefaultEncoding}{wxfontgetdefaultencoding}
 421
 422
 423 \membersection{wxFont::SetFaceName}\label{wxfontsetfacename}
 424
 425 \func{bool}{SetFaceName}{\param{const wxString\& }{faceName}}
 426
 427 Sets the facename for the font.
 428 Returns \true if the given face name exists; \false otherwise.
 429
 430 \wxheading{Parameters}
 431
 432 \docparam{faceName}{A valid facename, which should be on the end-user's system.}
 433
 434 \wxheading{Remarks}
 435
 436 To avoid portability problems, don't rely on a specific face, but specify the font family
 437 instead or as well. A suitable font will be found on the end-user's system. If both the
 438 family and the facename are specified, wxWidgets will first search for the specific face,
 439 and then for a font belonging to the same family.
 440
 441 \wxheading{See also}
 442
 443 \helpref{wxFont::GetFaceName}{wxfontgetfacename}, \helpref{wxFont::SetFamily}{wxfontsetfamily}
 444
 445
 446 \membersection{wxFont::SetFamily}\label{wxfontsetfamily}
 447
 448 \func{void}{SetFamily}{\param{wxFontFamily}{ family}}
 449
 450 Sets the font family.
 451
 452 \wxheading{Parameters}
 453
 454 \docparam{family}{One of:
 455
 456 \twocolwidtha{5cm}
 457 \begin{twocollist}\itemsep=0pt
 458 \twocolitem{{\bf wxFONTFAMILY\_DEFAULT}}{Chooses a default font.}
 459 \twocolitem{{\bf wxFONTFAMILY\_DECORATIVE}}{A decorative font.}
 460 \twocolitem{{\bf wxFONTFAMILY\_ROMAN}}{A formal, serif font.}
 461 \twocolitem{{\bf wxFONTFAMILY\_SCRIPT}}{A handwriting font.}
 462 \twocolitem{{\bf wxFONTFAMILY\_SWISS}}{A sans-serif font.}
 463 \twocolitem{{\bf wxFONTFAMILY\_MODERN}}{A fixed pitch font.}
 464 \twocolitem{{\bf wxFONTFAMILY\_TELETYPE}}{A teletype font.}
 465 \end{twocollist}}
 466
 467 \wxheading{See also}
 468
 469 \helpref{wxFont::GetFamily}{wxfontgetfamily}, \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 470
 471
 472 \membersection{wxFont::SetNativeFontInfo}\label{wxfontsetnativefontinfo}
 473
 474 \func{bool}{SetNativeFontInfo}{\param{const wxString\& }{info}}
 475
 476 Creates the font corresponding to the given native font description string and returns \true if
 477 the creation was successful.
 478 which must have been previously returned by
 479 \helpref{GetNativeFontInfoDesc}{wxfontgetnativefontinfodesc}. If the string is
 480 invalid, font is unchanged. This function is typically used for de-serializing a wxFont
 481 object previously saved in a string-form.
 482
 483 \wxheading{See also}
 484
 485 \helpref{wxFont::SetNativeFontInfoUserDesc}{wxfontsetnativefontinfouserdesc}
 486
 487
 488 \membersection{wxFont::SetNativeFontInfoUserDesc}\label{wxfontsetnativefontinfouserdesc}
 489
 490 \func{bool}{SetNativeFontInfoUserDesc}{\param{const wxString\& }{info}}
 491
 492 Creates the font corresponding to the given native font description string and returns \true if
 493 the creation was successful.
 494 Unlike \helpref{SetNativeFontInfo}{wxfontsetnativefontinfo}, this function accepts
 495 strings which are user-friendly.
 496 Examples of accepted string formats are:
 497
 498 \twocolwidtha{15cm}
 499 \begin{twocollist}\itemsep=0pt
 500 \twocolitem{Generic syntax}{Example}
 501 \twocolitem{on {\bf wxGTK2}: {\tt $[FACE-NAME]$ $[bold]$ $[oblique|italic]$ $[POINTSIZE]$}}{Monospace bold 10}
 502 \twocolitem{on {\bf wxMSW}: {\tt $[light|bold]$ $[italic]$ $[FACE-NAME]$ $[POINTSIZE]$ $[ENCODING]$}}{Tahoma 10 WINDOWS-1252}
 503 \twocolitem{on {\bf wxMac}: FIXME}{FIXME}
 504 \end{twocollist}
 505
 506 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}).
 507
 508 \wxheading{See also}
 509
 510 \helpref{wxFont::SetNativeFontInfo}{wxfontsetnativefontinfo}
 511
 512
 513
 514 \membersection{wxFont::SetPointSize}\label{wxfontsetpointsize}
 515
 516 \func{void}{SetPointSize}{\param{int}{ pointSize}}
 517
 518 Sets the point size.
 519
 520 \wxheading{Parameters}
 521
 522 \docparam{pointSize}{Size in points.}
 523
 524 \wxheading{See also}
 525
 526 \helpref{wxFont::GetPointSize}{wxfontgetpointsize}
 527
 528
 529 \membersection{wxFont::SetStyle}\label{wxfontsetstyle}
 530
 531 \func{void}{SetStyle}{\param{int}{ style}}
 532
 533 Sets the font style.
 534
 535 \wxheading{Parameters}
 536
 537 \docparam{style}{One of {\bf wxFONTSTYLE\_NORMAL}, {\bf wxFONTSTYLE\_SLANT} and {\bf wxFONTSTYLE\_ITALIC}.}
 538
 539 \wxheading{See also}
 540
 541 \helpref{wxFont::GetStyle}{wxfontgetstyle}
 542
 543
 544 \membersection{wxFont::SetUnderlined}\label{wxfontsetunderlined}
 545
 546 \func{void}{SetUnderlined}{\param{const bool}{ underlined}}
 547
 548 Sets underlining.
 549
 550 \wxheading{Parameters}
 551
 552 \docparam{underlining}{true to underline, false otherwise.}
 553
 554 \wxheading{See also}
 555
 556 \helpref{wxFont::GetUnderlined}{wxfontgetunderlined}
 557
 558
 559 \membersection{wxFont::SetWeight}\label{wxfontsetweight}
 560
 561 \func{void}{SetWeight}{\param{wxFontWeight}{ weight}}
 562
 563 Sets the font weight.
 564
 565 \wxheading{Parameters}
 566
 567 \docparam{weight}{One of:
 568
 569 \twocolwidtha{5cm}
 570 \begin{twocollist}\itemsep=0pt
 571 \twocolitem{{\bf wxFONTWEIGHT\_NORMAL}}{Normal font.}
 572 \twocolitem{{\bf wxFONTWEIGHT\_LIGHT}}{Light font.}
 573 \twocolitem{{\bf wxFONTWEIGHT\_BOLD}}{Bold font.}
 574 \end{twocollist}}
 575
 576 \wxheading{See also}
 577
 578 \helpref{wxFont::GetWeight}{wxfontgetweight}
 579
 580
 581 \membersection{wxFont::operator $=$}\label{wxfontassignment}
 582
 583 \func{wxFont\&}{operator $=$}{\param{const wxFont\& }{font}}
 584
 585 Assignment operator, using \helpref{reference counting}{trefcount}.
 586
 587
 588 \membersection{wxFont::operator $==$}\label{wxfontequals}
 589
 590 \func{bool}{operator $==$}{\param{const wxFont\& }{font}}
 591
 592 Equality operator. Two fonts are equal if they contain pointers
 593 to the same underlying font data. It does not compare each attribute,
 594 so two independently-created fonts using the same parameters will
 595 fail the test.
 596
 597
 598 \membersection{wxFont::operator $!=$}\label{wxfontnotequals}
 599
 600 \func{bool}{operator $!=$}{\param{const wxFont\& }{font}}
 601
 602 Inequality operator. Two fonts are not equal if they contain pointers
 603 to different underlying font data. It does not compare each attribute.
 604