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{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}}
 171
 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}}
 175
 176 Creates a font object with the specified attributes.
 177
 178 \wxheading{Parameters}
 179
 180 \docparam{pointSize}{Size in points.}
 181
 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.}
 186
 187 \docparam{family}{Font family, a generic way of referring to fonts without specifying actual facename. One of:
 188
 189 \twocolwidtha{5cm}
 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.}
 198 \end{twocollist}}
 199
 200 \docparam{style}{One of {\bf wxFONTSTYLE\_NORMAL}, {\bf wxFONTSTYLE\_SLANT} and {\bf wxFONTSTYLE\_ITALIC}.}
 201
 202 \docparam{weight}{Font weight, sometimes also referred to as font boldness. One of:
 203
 204 \twocolwidtha{5cm}
 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.}
 209 \end{twocollist}}
 210
 211 \docparam{underline}{The value can be true or false. At present this has an effect on Windows and Motif 2.x only.}
 212
 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.}
 215
 216 \docparam{encoding}{An encoding which may be one of
 217 \twocolwidtha{5cm}
 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).}
 228 \end{twocollist}
 229 If the specified encoding isn't available, no font is created
 230 (see also \helpref{font encoding overview}{wxfontencodingoverview}).
 231 }
 232
 233 \wxheading{Remarks}
 234
 235 If the desired font does not exist, the closest match will be chosen.
 236 Under Windows, only scalable TrueType fonts are used.
 237
 238 See also \helpref{wxDC::SetFont}{wxdcsetfont}, \helpref{wxDC::DrawText}{wxdcdrawtext}
 239 and \helpref{wxDC::GetTextExtent}{wxdcgettextextent}.
 240
 241
 242 \membersection{wxFont::\destruct{wxFont}}\label{wxfontdtor}
 243
 244 \func{}{\destruct{wxFont}}{\void}
 245
 246 Destructor.
 247
 248 \wxheading{Remarks}
 249
 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.
 252
 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.
 257
 258
 259 \membersection{wxFont::IsFixedWidth}\label{wxfontisfixedwidth}
 260
 261 \constfunc{bool}{IsFixedWidth}{\void}
 262
 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.
 265
 266
 267 \membersection{wxFont::GetDefaultEncoding}\label{wxfontgetdefaultencoding}
 268
 269 \func{static wxFontEncoding}{GetDefaultEncoding}{\void}
 270
 271 Returns the current application's default encoding.
 272
 273 \wxheading{See also}
 274
 275 \helpref{Font encoding overview}{wxfontencodingoverview},
 276 \helpref{SetDefaultEncoding}{wxfontsetdefaultencoding}
 277
 278
 279 \membersection{wxFont::GetFaceName}\label{wxfontgetfacename}
 280
 281 \constfunc{wxString}{GetFaceName}{\void}
 282
 283 Returns the typeface name associated with the font, or the empty string if there is no
 284 typeface information.
 285
 286 \wxheading{See also}
 287
 288 \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 289
 290
 291 \membersection{wxFont::GetFamily}\label{wxfontgetfamily}
 292
 293 \constfunc{wxFontFamily}{GetFamily}{\void}
 294
 295 Gets the font family. See \helpref{wxFont::SetFamily}{wxfontsetfamily} for a list of valid
 296 family identifiers.
 297
 298 \wxheading{See also}
 299
 300 \helpref{wxFont::SetFamily}{wxfontsetfamily}
 301
 302
 303 \membersection{wxFont::GetNativeFontInfoDesc}\label{wxfontgetnativefontinfodesc}
 304
 305 \constfunc{wxString}{GetNativeFontInfoDesc}{\void}
 306
 307 Returns the platform-dependent string completely describing this font.
 308 Returned string is always non-empty.
 309 Note that the returned string is not meant to be shown or edited by the user: a typical
 310 use of this function is for serializing in string-form a wxFont object.
 311
 312 \wxheading{See also}
 313
 314 \helpref{wxFont::SetNativeFontInfo}{wxfontsetnativefontinfo},\helpref{wxFont::GetNativeFontInfoUserDesc}{wxfontgetnativefontinfouserdesc}
 315
 316
 317 \membersection{wxFont::GetNativeFontInfoUserDesc}\label{wxfontgetnativefontinfouserdesc}
 318
 319 \func{wxString}{GetNativeFontInfoUserDesc}{\void}
 320
 321 Returns a user-friendly string for this font object. Returned string is always non-empty.
 322 Some examples of the formats of returned strings (which are platform-dependent) are in \helpref{SetNativeFontInfoUserDesc}{wxfontsetnativefontinfouserdesc}.
 323
 324 \wxheading{See also}
 325
 326 \helpref{wxFont::GetNativeFontInfoDesc}{wxfontgetnativefontinfodesc}
 327
 328
 329 \membersection{wxFont::GetPointSize}\label{wxfontgetpointsize}
 330
 331 \constfunc{int}{GetPointSize}{\void}
 332
 333 Gets the point size.
 334
 335 \wxheading{See also}
 336
 337 \helpref{wxFont::SetPointSize}{wxfontsetpointsize}
 338
 339
 340 \membersection{wxFont::GetStyle}\label{wxfontgetstyle}
 341
 342 \constfunc{int}{GetStyle}{\void}
 343
 344 Gets the font style. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 345 styles.
 346
 347 \wxheading{See also}
 348
 349 \helpref{wxFont::SetStyle}{wxfontsetstyle}
 350
 351
 352 \membersection{wxFont::GetUnderlined}\label{wxfontgetunderlined}
 353
 354 \constfunc{bool}{GetUnderlined}{\void}
 355
 356 Returns true if the font is underlined, false otherwise.
 357
 358 \wxheading{See also}
 359
 360 \helpref{wxFont::SetUnderlined}{wxfontsetunderlined}
 361
 362
 363 \membersection{wxFont::GetWeight}\label{wxfontgetweight}
 364
 365 \constfunc{wxFontWeight}{GetWeight}{\void}
 366
 367 Gets the font weight. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 368 weight identifiers.
 369
 370 \wxheading{See also}
 371
 372 \helpref{wxFont::SetWeight}{wxfontsetweight}
 373
 374
 375 \membersection{wxFont::New}\label{wxfontnew}
 376
 377 \func{static wxFont *}{New}{\param{int}{ pointSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{wxFontWeight}{ weight},
 378  \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
 379  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 380
 381 \func{static wxFont *}{New}{\param{int}{ pointSize}, \param{wxFontFamily}{ family},
 382  \param{int}{ flags = \texttt{wxFONTFLAG\_DEFAULT}}, \param{const wxString\& }{faceName = ""},
 383  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 384
 385 \func{static wxFont *}{New}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{wxFontWeight}{ weight},
 386  \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
 387  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 388
 389 \func{static wxFont *}{New}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family},
 390  \param{int}{ flags = \texttt{wxFONTFLAG\_DEFAULT}}, \param{const wxString\& }{faceName = ""},
 391  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 392
 393 These functions take the same parameters as \helpref{wxFont
 394 constructor}{wxfontctor} and return a new font object allocated on the heap.
 395
 396 Using \texttt{New()} is currently the only way to directly create a font with
 397 the given size in pixels on platforms other than wxMSW.
 398
 399
 400 \membersection{wxFont::IsOk}\label{wxfontisok}
 401
 402 \constfunc{bool}{IsOk}{\void}
 403
 404 Returns {\tt true} if this object is a valid font, {\tt false} otherwise.
 405
 406
 407 \membersection{wxFont::SetDefaultEncoding}\label{wxfontsetdefaultencoding}
 408
 409 \func{static void}{SetDefaultEncoding}{\param{wxFontEncoding }{encoding}}
 410
 411 Sets the default font encoding.
 412
 413 \wxheading{See also}
 414
 415 \helpref{Font encoding overview}{wxfontencodingoverview},
 416 \helpref{GetDefaultEncoding}{wxfontgetdefaultencoding}
 417
 418
 419 \membersection{wxFont::SetFaceName}\label{wxfontsetfacename}
 420
 421 \func{bool}{SetFaceName}{\param{const wxString\& }{faceName}}
 422
 423 Sets the facename for the font.
 424 Returns \true if the given face name exists; \false otherwise.
 425
 426 \wxheading{Parameters}
 427
 428 \docparam{faceName}{A valid facename, which should be on the end-user's system.}
 429
 430 \wxheading{Remarks}
 431
 432 To avoid portability problems, don't rely on a specific face, but specify the font family
 433 instead or as well. A suitable font will be found on the end-user's system. If both the
 434 family and the facename are specified, wxWidgets will first search for the specific face,
 435 and then for a font belonging to the same family.
 436
 437 \wxheading{See also}
 438
 439 \helpref{wxFont::GetFaceName}{wxfontgetfacename}, \helpref{wxFont::SetFamily}{wxfontsetfamily}
 440
 441
 442 \membersection{wxFont::SetFamily}\label{wxfontsetfamily}
 443
 444 \func{void}{SetFamily}{\param{wxFontFamily}{ family}}
 445
 446 Sets the font family.
 447
 448 \wxheading{Parameters}
 449
 450 \docparam{family}{One of:
 451
 452 \twocolwidtha{5cm}
 453 \begin{twocollist}\itemsep=0pt
 454 \twocolitem{{\bf wxFONTFAMILY\_DEFAULT}}{Chooses a default font.}
 455 \twocolitem{{\bf wxFONTFAMILY\_DECORATIVE}}{A decorative font.}
 456 \twocolitem{{\bf wxFONTFAMILY\_ROMAN}}{A formal, serif font.}
 457 \twocolitem{{\bf wxFONTFAMILY\_SCRIPT}}{A handwriting font.}
 458 \twocolitem{{\bf wxFONTFAMILY\_SWISS}}{A sans-serif font.}
 459 \twocolitem{{\bf wxFONTFAMILY\_MODERN}}{A fixed pitch font.}
 460 \twocolitem{{\bf wxFONTFAMILY\_TELETYPE}}{A teletype font.}
 461 \end{twocollist}}
 462
 463 \wxheading{See also}
 464
 465 \helpref{wxFont::GetFamily}{wxfontgetfamily}, \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 466
 467
 468 \membersection{wxFont::SetNativeFontInfo}\label{wxfontsetnativefontinfo}
 469
 470 \func{bool}{SetNativeFontInfo}{\param{const wxString\& }{info}}
 471
 472 Creates the font corresponding to the given native font description string and returns \true if
 473 the creation was successful.
 474 which must have been previously returned by
 475 \helpref{GetNativeFontInfoDesc}{wxfontgetnativefontinfodesc}. If the string is
 476 invalid, font is unchanged. This function is typically used for de-serializing a wxFont
 477 object previously saved in a string-form.
 478
 479 \wxheading{See also}
 480
 481 \helpref{wxFont::SetNativeFontInfoUserDesc}{wxfontsetnativefontinfouserdesc}
 482
 483
 484 \membersection{wxFont::SetNativeFontInfoUserDesc}\label{wxfontsetnativefontinfouserdesc}
 485
 486 \func{bool}{SetNativeFontInfoUserDesc}{\param{const wxString\& }{info}}
 487
 488 Creates the font corresponding to the given native font description string and returns \true if
 489 the creation was successful.
 490 Unlike \helpref{SetNativeFontInfo}{wxfontsetnativefontinfo}, this function accepts
 491 strings which are user-friendly.
 492 Examples of accepted string formats are:
 493
 494 \twocolwidtha{15cm}
 495 \begin{twocollist}\itemsep=0pt
 496 \twocolitem{Generic syntax}{Example}
 497 \twocolitem{on {\bf wxGTK2}: {\tt $[FACE-NAME]$ $[bold]$ $[oblique|italic]$ $[POINTSIZE]$}}{Monospace bold 10}
 498 \twocolitem{on {\bf wxMSW}: {\tt $[light|bold]$ $[italic]$ $[FACE-NAME]$ $[POINTSIZE]$ $[ENCODING]$}}{Tahoma 10 WINDOWS-1252}
 499 \twocolitem{on {\bf wxMac}: FIXME}{FIXME}
 500 \end{twocollist}
 501
 502 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}).
 503
 504 \wxheading{See also}
 505
 506 \helpref{wxFont::SetNativeFontInfo}{wxfontsetnativefontinfo}
 507
 508
 509
 510 \membersection{wxFont::SetPointSize}\label{wxfontsetpointsize}
 511
 512 \func{void}{SetPointSize}{\param{int}{ pointSize}}
 513
 514 Sets the point size.
 515
 516 \wxheading{Parameters}
 517
 518 \docparam{pointSize}{Size in points.}
 519
 520 \wxheading{See also}
 521
 522 \helpref{wxFont::GetPointSize}{wxfontgetpointsize}
 523
 524
 525 \membersection{wxFont::SetStyle}\label{wxfontsetstyle}
 526
 527 \func{void}{SetStyle}{\param{int}{ style}}
 528
 529 Sets the font style.
 530
 531 \wxheading{Parameters}
 532
 533 \docparam{style}{One of {\bf wxFONTSTYLE\_NORMAL}, {\bf wxFONTSTYLE\_SLANT} and {\bf wxFONTSTYLE\_ITALIC}.}
 534
 535 \wxheading{See also}
 536
 537 \helpref{wxFont::GetStyle}{wxfontgetstyle}
 538
 539
 540 \membersection{wxFont::SetUnderlined}\label{wxfontsetunderlined}
 541
 542 \func{void}{SetUnderlined}{\param{const bool}{ underlined}}
 543
 544 Sets underlining.
 545
 546 \wxheading{Parameters}
 547
 548 \docparam{underlining}{true to underline, false otherwise.}
 549
 550 \wxheading{See also}
 551
 552 \helpref{wxFont::GetUnderlined}{wxfontgetunderlined}
 553
 554
 555 \membersection{wxFont::SetWeight}\label{wxfontsetweight}
 556
 557 \func{void}{SetWeight}{\param{wxFontWeight}{ weight}}
 558
 559 Sets the font weight.
 560
 561 \wxheading{Parameters}
 562
 563 \docparam{weight}{One of:
 564
 565 \twocolwidtha{5cm}
 566 \begin{twocollist}\itemsep=0pt
 567 \twocolitem{{\bf wxFONTWEIGHT\_NORMAL}}{Normal font.}
 568 \twocolitem{{\bf wxFONTWEIGHT\_LIGHT}}{Light font.}
 569 \twocolitem{{\bf wxFONTWEIGHT\_BOLD}}{Bold font.}
 570 \end{twocollist}}
 571
 572 \wxheading{See also}
 573
 574 \helpref{wxFont::GetWeight}{wxfontgetweight}
 575
 576
 577 \membersection{wxFont::operator $=$}\label{wxfontassignment}
 578
 579 \func{wxFont\&}{operator $=$}{\param{const wxFont\& }{font}}
 580
 581 Assignment operator, using reference counting. Returns a reference
 582 to `this'.
 583
 584
 585 \membersection{wxFont::operator $==$}\label{wxfontequals}
 586
 587 \func{bool}{operator $==$}{\param{const wxFont\& }{font}}
 588
 589 Equality operator. Two fonts are equal if they contain pointers
 590 to the same underlying font data. It does not compare each attribute,
 591 so two independently-created fonts using the same parameters will
 592 fail the test.
 593
 594
 595 \membersection{wxFont::operator $!=$}\label{wxfontnotequals}
 596
 597 \func{bool}{operator $!=$}{\param{const wxFont\& }{font}}
 598
 599 Inequality operator. Two fonts are not equal if they contain pointers
 600 to different underlying font data. It does not compare each attribute.
 601