interface/wx/font.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        font.h
   3 // Purpose:     interface of wxFont
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     Standard font families: these may be used only for the font creation, it
  12     doesn't make sense to query an existing font for its font family as,
  13     especially if the font had been created from a native font description, it
  14     may be unknown.
  15 */
  16 enum wxFontFamily
  17 {
  18     wxFONTFAMILY_DEFAULT = wxDEFAULT,           //!< Chooses a default font.
  19     wxFONTFAMILY_DECORATIVE = wxDECORATIVE,     //!< A decorative font.
  20     wxFONTFAMILY_ROMAN = wxROMAN,               //!< A formal, serif font.
  21     wxFONTFAMILY_SCRIPT = wxSCRIPT,             //!< A handwriting font.
  22     wxFONTFAMILY_SWISS = wxSWISS,               //!< A sans-serif font.
  23     wxFONTFAMILY_MODERN = wxMODERN,             //!< A fixed pitch font.
  24     wxFONTFAMILY_TELETYPE = wxTELETYPE,         //!< A teletype font.
  25     wxFONTFAMILY_MAX,
  26     wxFONTFAMILY_UNKNOWN = wxFONTFAMILY_MAX
  27 };
  28
  29 /**
  30     Font styles.
  31 */
  32 enum wxFontStyle
  33 {
  34     wxFONTSTYLE_NORMAL = wxNORMAL,
  35     wxFONTSTYLE_ITALIC = wxITALIC,
  36     wxFONTSTYLE_SLANT = wxSLANT,
  37     wxFONTSTYLE_MAX
  38 };
  39
  40 /**
  41     Font weights.
  42 */
  43 enum wxFontWeight
  44 {
  45     wxFONTWEIGHT_NORMAL = wxNORMAL,  //!< Normal font.
  46     wxFONTWEIGHT_LIGHT = wxLIGHT,    //!< Light font.
  47     wxFONTWEIGHT_BOLD = wxBOLD,      //!< Bold font.
  48     wxFONTWEIGHT_MAX
  49 };
  50
  51 /**
  52     The font flag bits for the new font ctor accepting one combined flags word.
  53 */
  54 enum wxFontFlag
  55 {
  56     /// no special flags: font with default weight/slant/anti-aliasing
  57     wxFONTFLAG_DEFAULT          = 0,
  58
  59     /// slant flags (default: no slant)
  60     wxFONTFLAG_ITALIC           = 1 << 0,
  61     wxFONTFLAG_SLANT            = 1 << 1,
  62
  63     /// weight flags (default: medium)
  64     wxFONTFLAG_LIGHT            = 1 << 2,
  65     wxFONTFLAG_BOLD             = 1 << 3,
  66
  67     /// anti-aliasing flag: force on or off (default: the current system default)
  68     wxFONTFLAG_ANTIALIASED      = 1 << 4,
  69     wxFONTFLAG_NOT_ANTIALIASED  = 1 << 5,
  70
  71     /// underlined/strikethrough flags (default: no lines)
  72     wxFONTFLAG_UNDERLINED       = 1 << 6,
  73     wxFONTFLAG_STRIKETHROUGH    = 1 << 7,
  74
  75     /// the mask of all currently used flags
  76     wxFONTFLAG_MASK = wxFONTFLAG_ITALIC             |
  77                       wxFONTFLAG_SLANT              |
  78                       wxFONTFLAG_LIGHT              |
  79                       wxFONTFLAG_BOLD               |
  80                       wxFONTFLAG_ANTIALIASED        |
  81                       wxFONTFLAG_NOT_ANTIALIASED    |
  82                       wxFONTFLAG_UNDERLINED         |
  83                       wxFONTFLAG_STRIKETHROUGH
  84 };
  85
  86
  87
  88 /**
  89     Font encodings.
  90 */
  91 enum wxFontEncoding
  92 {
  93     /// Default system encoding.
  94     wxFONTENCODING_SYSTEM = -1,     // system default
  95
  96     /// Default application encoding.
  97     wxFONTENCODING_DEFAULT,         // current default encoding
  98
  99     // ISO8859 standard defines a number of single-byte charsets
 100     wxFONTENCODING_ISO8859_1,       //!< West European (Latin1)
 101     wxFONTENCODING_ISO8859_2,       //!< Central and East European (Latin2)
 102     wxFONTENCODING_ISO8859_3,       //!< Esperanto (Latin3)
 103     wxFONTENCODING_ISO8859_4,       //!< Baltic (old) (Latin4)
 104     wxFONTENCODING_ISO8859_5,       //!< Cyrillic
 105     wxFONTENCODING_ISO8859_6,       //!< Arabic
 106     wxFONTENCODING_ISO8859_7,       //!< Greek
 107     wxFONTENCODING_ISO8859_8,       //!< Hebrew
 108     wxFONTENCODING_ISO8859_9,       //!< Turkish (Latin5)
 109     wxFONTENCODING_ISO8859_10,      //!< Variation of Latin4 (Latin6)
 110     wxFONTENCODING_ISO8859_11,      //!< Thai
 111     wxFONTENCODING_ISO8859_12,      //!< doesn't exist currently, but put it
 112                                     //!< here anyhow to make all ISO8859
 113                                     //!< consecutive numbers
 114     wxFONTENCODING_ISO8859_13,      //!< Baltic (Latin7)
 115     wxFONTENCODING_ISO8859_14,      //!< Latin8
 116     wxFONTENCODING_ISO8859_15,      //!< Latin9 (a.k.a. Latin0, includes euro)
 117     wxFONTENCODING_ISO8859_MAX,
 118
 119     // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
 120     wxFONTENCODING_KOI8,            //!< KOI8 Russian
 121     wxFONTENCODING_KOI8_U,          //!< KOI8 Ukrainian
 122     wxFONTENCODING_ALTERNATIVE,     //!< same as MS-DOS CP866
 123     wxFONTENCODING_BULGARIAN,       //!< used under Linux in Bulgaria
 124
 125     // what would we do without Microsoft? They have their own encodings
 126         // for DOS
 127     wxFONTENCODING_CP437,           //!< original MS-DOS codepage
 128     wxFONTENCODING_CP850,           //!< CP437 merged with Latin1
 129     wxFONTENCODING_CP852,           //!< CP437 merged with Latin2
 130     wxFONTENCODING_CP855,           //!< another cyrillic encoding
 131     wxFONTENCODING_CP866,           //!< and another one
 132         // and for Windows
 133     wxFONTENCODING_CP874,           //!< WinThai
 134     wxFONTENCODING_CP932,           //!< Japanese (shift-JIS)
 135     wxFONTENCODING_CP936,           //!< Chinese simplified (GB)
 136     wxFONTENCODING_CP949,           //!< Korean (Hangul charset)
 137     wxFONTENCODING_CP950,           //!< Chinese (traditional - Big5)
 138     wxFONTENCODING_CP1250,          //!< WinLatin2
 139     wxFONTENCODING_CP1251,          //!< WinCyrillic
 140     wxFONTENCODING_CP1252,          //!< WinLatin1
 141     wxFONTENCODING_CP1253,          //!< WinGreek (8859-7)
 142     wxFONTENCODING_CP1254,          //!< WinTurkish
 143     wxFONTENCODING_CP1255,          //!< WinHebrew
 144     wxFONTENCODING_CP1256,          //!< WinArabic
 145     wxFONTENCODING_CP1257,          //!< WinBaltic (same as Latin 7)
 146     wxFONTENCODING_CP12_MAX,
 147
 148     wxFONTENCODING_UTF7,            //!< UTF-7 Unicode encoding
 149     wxFONTENCODING_UTF8,            //!< UTF-8 Unicode encoding
 150     wxFONTENCODING_EUC_JP,          //!< Extended Unix Codepage for Japanese
 151     wxFONTENCODING_UTF16BE,         //!< UTF-16 Big Endian Unicode encoding
 152     wxFONTENCODING_UTF16LE,         //!< UTF-16 Little Endian Unicode encoding
 153     wxFONTENCODING_UTF32BE,         //!< UTF-32 Big Endian Unicode encoding
 154     wxFONTENCODING_UTF32LE,         // UTF-32 Little Endian Unicode encoding
 155
 156     wxFONTENCODING_MACROMAN,        //!< the standard mac encodings
 157     wxFONTENCODING_MACJAPANESE,
 158     wxFONTENCODING_MACCHINESETRAD,
 159     wxFONTENCODING_MACKOREAN,
 160     wxFONTENCODING_MACARABIC,
 161     wxFONTENCODING_MACHEBREW,
 162     wxFONTENCODING_MACGREEK,
 163     wxFONTENCODING_MACCYRILLIC,
 164     wxFONTENCODING_MACDEVANAGARI,
 165     wxFONTENCODING_MACGURMUKHI,
 166     wxFONTENCODING_MACGUJARATI,
 167     wxFONTENCODING_MACORIYA,
 168     wxFONTENCODING_MACBENGALI,
 169     wxFONTENCODING_MACTAMIL,
 170     wxFONTENCODING_MACTELUGU,
 171     wxFONTENCODING_MACKANNADA,
 172     wxFONTENCODING_MACMALAJALAM,
 173     wxFONTENCODING_MACSINHALESE,
 174     wxFONTENCODING_MACBURMESE,
 175     wxFONTENCODING_MACKHMER,
 176     wxFONTENCODING_MACTHAI,
 177     wxFONTENCODING_MACLAOTIAN,
 178     wxFONTENCODING_MACGEORGIAN,
 179     wxFONTENCODING_MACARMENIAN,
 180     wxFONTENCODING_MACCHINESESIMP,
 181     wxFONTENCODING_MACTIBETAN,
 182     wxFONTENCODING_MACMONGOLIAN,
 183     wxFONTENCODING_MACETHIOPIC,
 184     wxFONTENCODING_MACCENTRALEUR,
 185     wxFONTENCODING_MACVIATNAMESE,
 186     wxFONTENCODING_MACARABICEXT,
 187     wxFONTENCODING_MACSYMBOL,
 188     wxFONTENCODING_MACDINGBATS,
 189     wxFONTENCODING_MACTURKISH,
 190     wxFONTENCODING_MACCROATIAN,
 191     wxFONTENCODING_MACICELANDIC,
 192     wxFONTENCODING_MACROMANIAN,
 193     wxFONTENCODING_MACCELTIC,
 194     wxFONTENCODING_MACGAELIC,
 195     wxFONTENCODING_MACKEYBOARD,
 196
 197     // more CJK encodings (for historical reasons some are already declared
 198     // above)
 199     wxFONTENCODING_ISO2022_JP,      //!< ISO-2022-JP JIS encoding
 200
 201     wxFONTENCODING_MAX,             //!< highest enumerated encoding value
 202
 203     wxFONTENCODING_MACMIN = wxFONTENCODING_MACROMAN ,
 204     wxFONTENCODING_MACMAX = wxFONTENCODING_MACKEYBOARD ,
 205
 206     // aliases for endian-dependent UTF encodings
 207     wxFONTENCODING_UTF16,  //!< native UTF-16
 208     wxFONTENCODING_UTF32,  //!< native UTF-32
 209
 210     /// Alias for the native Unicode encoding on this platform
 211     /// (this is used by wxEncodingConverter and wxUTFFile only for now)
 212     wxFONTENCODING_UNICODE,
 213
 214     // alternative names for Far Eastern encodings
 215     // Chinese
 216     wxFONTENCODING_GB2312 = wxFONTENCODING_CP936, //!< Simplified Chinese
 217     wxFONTENCODING_BIG5 = wxFONTENCODING_CP950,   //!< Traditional Chinese
 218
 219         // Japanese (see http://zsigri.tripod.com/fontboard/cjk/jis.html)
 220     wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932 //!< Shift JIS
 221 };
 222
 223
 224
 225 /**
 226     @class wxFont
 227
 228     A font is an object which determines the appearance of text.
 229     Fonts are used for drawing text to a device context, and setting the appearance
 230     of a window's text.
 231
 232     This class uses @ref overview_refcount "reference counting and copy-on-write"
 233     internally so that assignments between two instances of this class are very
 234     cheap. You can therefore use actual objects instead of pointers without
 235     efficiency problems. If an instance of this class is changed it will create
 236     its own data internally so that other instances, which previously shared the
 237     data using the reference counting, are not affected.
 238
 239     You can retrieve the current system font settings with wxSystemSettings.
 240
 241     @library{wxcore}
 242     @category{gdi}
 243
 244     @stdobjects
 245     ::wxNullFont, ::wxNORMAL_FONT, ::wxSMALL_FONT, ::wxITALIC_FONT, ::wxSWISS_FONT
 246
 247     @see @ref overview_font, wxDC::SetFont, wxDC::DrawText,
 248          wxDC::GetTextExtent, wxFontDialog, wxSystemSettings
 249 */
 250 class wxFont : public wxGDIObject
 251 {
 252 public:
 253     //@{
 254     /**
 255         Default ctor.
 256     */
 257     wxFont();
 258
 259     /**
 260         Copy constructor, uses @ref overview_refcount "reference counting".
 261     */
 262     wxFont(const wxFont& font);
 263
 264     /**
 265         Creates a font object with the specified attributes.
 266
 267         @param pointSize
 268             Size in points.
 269         @param family
 270             Font family, a generic way of referring to fonts without specifying actual
 271             facename. One of the ::wxFontFamily enumeration values.
 272         @param style
 273             One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
 274         @param weight
 275             Font weight, sometimes also referred to as font boldness. One of
 276             the ::wxFontWeight enumeration values.
 277         @param underline
 278             The value can be @true or @false.
 279             At present this has an effect on Windows and Motif 2.x only.
 280         @param faceName
 281             An optional string specifying the actual typeface to be used.
 282             If it is an empty string, a default typeface will be chosen based on the family.
 283         @param encoding
 284             An encoding which may be one of the enumeration values of ::wxFontEncoding.
 285             Briefly these can be summed up as:
 286             <TABLE>
 287                 <TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
 288                 <TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
 289                     Default application encoding: this
 290                     is the encoding set by calls to
 291                     SetDefaultEncoding and which may be set to,
 292                     say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
 293                     default application encoding is the same as default system encoding.</TD></TR>
 294                 <TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
 295                 <TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
 296                 <TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
 297             </TABLE>
 298             If the specified encoding isn't available, no font is created
 299             (see also font encoding overview).
 300
 301         @remarks If the desired font does not exist, the closest match will be
 302                  chosen. Under Windows, only scalable TrueType fonts are used.
 303     */
 304     wxFont(int pointSize, wxFontFamily family, wxFontStyle style,
 305            wxFontWeight weight,
 306            bool underline = false,
 307            const wxString& faceName = wxEmptyString,
 308            wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 309
 310     /**
 311         Creates a font object with the specified attributes.
 312
 313         @param pixelSize
 314             Size in pixels: this is directly supported only under MSW currently
 315             where this constructor can be used directly, under other platforms a
 316             font with the closest size to the given one is found using binary search
 317             and the static New method must be used.
 318         @param family
 319             Font family, a generic way of referring to fonts without specifying actual
 320             facename. One of ::wxFontFamily enumeration values.
 321         @param style
 322             One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
 323         @param weight
 324             Font weight, sometimes also referred to as font boldness.
 325             One of the ::wxFontWeight enumeration values.
 326         @param underline
 327             The value can be @true or @false.
 328             At present this has an effect on Windows and Motif 2.x only.
 329         @param faceName
 330             An optional string specifying the actual typeface to be used.
 331             If it is an empty string, a default typeface will be chosen based on the family.
 332         @param encoding
 333             An encoding which may be one of the enumeration values of ::wxFontEncoding.
 334             Briefly these can be summed up as:
 335             <TABLE>
 336                 <TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
 337                 <TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
 338                     Default application encoding: this
 339                     is the encoding set by calls to
 340                     SetDefaultEncoding and which may be set to,
 341                     say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
 342                     default application encoding is the same as default system encoding.</TD></TR>
 343                 <TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
 344                 <TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
 345                 <TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
 346             </TABLE>
 347             If the specified encoding isn't available, no font is created
 348             (see also font encoding overview).
 349
 350         @remarks If the desired font does not exist, the closest match will be
 351                  chosen. Under Windows, only scalable TrueType fonts are used.
 352     */
 353     wxFont(const wxSize& pixelSize, wxFontFamily family,
 354            wxFontStyle style, wxFontWeight weight,
 355            bool underline = false,
 356            const wxString& faceName = wxEmptyString,
 357            wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 358     //@}
 359
 360     /**
 361         Destructor.
 362
 363         See @ref overview_refcount_destruct "reference-counted object destruction"
 364         for more info.
 365
 366         @remarks Although all remaining fonts are deleted when the application
 367                  exits, the application should try to clean up all fonts
 368                  itself. This is because wxWidgets cannot know if a
 369                  pointer to the font object is stored in an application
 370                  data structure, and there is a risk of double deletion.
 371     */
 372     virtual ~wxFont();
 373
 374     /**
 375         Returns the current application's default encoding.
 376
 377         @see @ref overview_fontencoding, SetDefaultEncoding()
 378     */
 379     static wxFontEncoding GetDefaultEncoding();
 380
 381     /**
 382         Returns the typeface name associated with the font, or the empty string if
 383         there is no typeface information.
 384
 385         @see SetFaceName()
 386     */
 387     virtual wxString GetFaceName() const;
 388
 389     /**
 390         Gets the font family. See SetFamily() for a list of valid
 391         family identifiers.
 392
 393         @see SetFamily()
 394     */
 395     virtual wxFontFamily GetFamily() const;
 396
 397     /**
 398         Returns the platform-dependent string completely describing this font.
 399         Returned string is always non-empty.
 400
 401         Note that the returned string is not meant to be shown or edited by the user: a
 402         typical use of this function is for serializing in string-form a wxFont object.
 403
 404         @see SetNativeFontInfo(),GetNativeFontInfoUserDesc()
 405     */
 406     wxString GetNativeFontInfoDesc() const;
 407
 408     /**
 409         Returns a user-friendly string for this font object.
 410         Returned string is always non-empty.
 411
 412         Some examples of the formats of returned strings (which are platform-dependent)
 413         are in SetNativeFontInfoUserDesc().
 414
 415         @see GetNativeFontInfoDesc()
 416     */
 417     wxString GetNativeFontInfoUserDesc() const;
 418
 419     /**
 420         Gets the point size.
 421
 422         @see SetPointSize()
 423     */
 424     virtual int GetPointSize() const;
 425
 426     /**
 427         Gets the font style. See wxFontStyle for a list of valid styles.
 428
 429         @see SetStyle()
 430     */
 431     virtual wxFontStyle GetStyle() const;
 432
 433     /**
 434         Returns @true if the font is underlined, @false otherwise.
 435
 436         @see SetUnderlined()
 437     */
 438     virtual bool GetUnderlined() const;
 439
 440     /**
 441         Gets the font weight. See wxFontWeight for a list of valid weight identifiers.
 442
 443         @see SetWeight()
 444     */
 445     virtual wxFontWeight GetWeight() const;
 446
 447     /**
 448         Returns @true if the font is a fixed width (or monospaced) font,
 449         @false if it is a proportional one or font is invalid.
 450     */
 451     virtual bool IsFixedWidth() const;
 452
 453     /**
 454         Returns @true if this object is a valid font, @false otherwise.
 455     */
 456     virtual bool IsOk() const;
 457
 458     //@{
 459     /**
 460         These functions take the same parameters as
 461         @ref wxFont::wxFont "wxFont constructors" and return a new font
 462         object allocated on the heap.
 463
 464         Using @c New() is currently the only way to directly create a font with
 465         the given size in pixels on platforms other than wxMSW.
 466     */
 467     static wxFont* New(int pointSize, wxFontFamily family, wxFontStyle style,
 468                        wxFontWeight weight,
 469                        bool underline = false,
 470                        const wxString& faceName = wxEmptyString,
 471                        wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 472     static wxFont* New(int pointSize, wxFontFamily family,
 473                        int flags = wxFONTFLAG_DEFAULT,
 474                        const wxString& faceName = wxEmptyString,
 475                        wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 476     static wxFont* New(const wxSize& pixelSize,
 477                        wxFontFamily family,
 478                        wxFontStyle style,
 479                        wxFontWeight weight,
 480                        bool underline = false,
 481                        const wxString& faceName = wxEmptyString,
 482                        wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 483     static wxFont* New(const wxSize& pixelSize,
 484                        wxFontFamily family,
 485                        int flags = wxFONTFLAG_DEFAULT,
 486                        const wxString& faceName = wxEmptyString,
 487                        wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 488     //@}
 489
 490     /**
 491         Sets the default font encoding.
 492
 493         @see @ref overview_fontencoding, GetDefaultEncoding()
 494     */
 495     static void SetDefaultEncoding(wxFontEncoding encoding);
 496
 497     /**
 498         Sets the facename for the font.
 499         Returns @true if the given face name exists; @false otherwise.
 500
 501         @param faceName
 502             A valid facename, which should be on the end-user's system.
 503
 504         @remarks To avoid portability problems, don't rely on a specific face,
 505                  but specify the font family instead or as well.
 506                  A suitable font will be found on the end-user's system.
 507                  If both the family and the facename are specified,
 508                  wxWidgets will first search for the specific face, and
 509                  then for a font belonging to the same family.
 510
 511         @see GetFaceName(), SetFamily()
 512     */
 513     virtual bool SetFaceName(const wxString& faceName);
 514
 515     /**
 516         Sets the font family.
 517
 518         @param family
 519             One of the ::wxFontFamily values.
 520
 521         @see GetFamily(), SetFaceName()
 522     */
 523     virtual void SetFamily(wxFontFamily family);
 524
 525     /**
 526         Creates the font corresponding to the given native font description string
 527         which must have been previously returned by GetNativeFontInfoDesc().
 528
 529         If the string is invalid, font is unchanged.
 530         This function is typically used for de-serializing a wxFont object
 531         previously saved in a string-form.
 532
 533         @return @true if the creation was successful.
 534
 535         @see SetNativeFontInfoUserDesc()
 536     */
 537     bool SetNativeFontInfo(const wxString& info);
 538
 539     /**
 540         Creates the font corresponding to the given native font description string and
 541         returns @true if the creation was successful.
 542
 543         Unlike SetNativeFontInfo(), this function accepts strings which are user-friendly.
 544         Examples of accepted string formats are:
 545
 546         @beginTable
 547         @hdr3col{platform, generic syntax, example}
 548         @row3col{wxGTK2, @c [FACE-NAME] [bold] [oblique|italic] [POINTSIZE], Monospace bold 10}
 549         @row3col{wxMSW, @c [light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING], Tahoma 10 WINDOWS-1252}
 550         @endTable
 551
 552         @todo add an example for wxMac
 553
 554         For more detailed information about the allowed syntaxes you can look at the
 555         documentation of the native API used for font-rendering
 556         (e.g. @c pango_font_description_from_string on GTK).
 557
 558         @see SetNativeFontInfo()
 559     */
 560     bool SetNativeFontInfoUserDesc(const wxString& info);
 561
 562     /**
 563         Sets the point size.
 564
 565         @param pointSize
 566             Size in points.
 567
 568         @see GetPointSize()
 569     */
 570     virtual void SetPointSize(int pointSize);
 571
 572     /**
 573         Sets the font style.
 574
 575         @param style
 576             One of the ::wxFontStyle enumeration values.
 577
 578         @see GetStyle()
 579     */
 580     virtual void SetStyle(wxFontStyle style);
 581
 582     /**
 583         Sets underlining.
 584
 585         @param underlined
 586             @true to underline, @false otherwise.
 587
 588         @see GetUnderlined()
 589     */
 590     virtual void SetUnderlined(bool underlined);
 591
 592     /**
 593         Sets the font weight.
 594
 595         @param weight
 596             One of the ::wxFontWeight values.
 597
 598         @see GetWeight()
 599     */
 600     virtual void SetWeight(wxFontWeight weight);
 601
 602     /**
 603         Inequality operator.
 604
 605         See @ref overview_refcount_equality "reference-counted object comparison" for
 606         more info.
 607     */
 608     bool operator!=(const wxFont& font) const;
 609
 610     /**
 611         Equality operator.
 612
 613         See @ref overview_refcount_equality "reference-counted object comparison" for
 614         more info.
 615     */
 616     bool operator==(const wxFont& font) const;
 617
 618     /**
 619         Assignment operator, using @ref overview_refcount "reference counting".
 620     */
 621     wxFont& operator =(const wxFont& font);
 622 };
 623
 624
 625 /**
 626     An empty wxFont.
 627 */
 628 wxFont wxNullFont;
 629
 630 /**
 631     Equivalent to wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT).
 632 */
 633 wxFont wxNORMAL_FONT;
 634
 635 /**
 636     A font using the wxFONTFAMILY_SWISS family and 2 points smaller than
 637     ::wxNORMAL_FONT.
 638 */
 639 wxFont wxSMALL_FONT;
 640
 641 /**
 642     A font using the wxFONTFAMILY_ROMAN family and wxFONTSTYLE_ITALIC style and
 643     of the same size of ::wxNORMAL_FONT.
 644 */
 645 wxFont wxITALIC_FONT;
 646
 647 /**
 648     A font identic to ::wxNORMAL_FONT except for the family used which is
 649     wxFONTFAMILY_SWISS.
 650 */
 651 wxFont wxSWISS_FONT;
 652
 653
 654 /**
 655     @class wxFontList
 656
 657     A font list is a list containing all fonts which have been created.
 658     There is only one instance of this class: ::wxTheFontList.
 659
 660     Use this object to search for a previously created font of the desired type
 661     and create it if not already found.
 662
 663     In some windowing systems, the font may be a scarce resource, so it is best to
 664     reuse old resources if possible.  When an application finishes, all fonts will
 665     be deleted and their resources freed, eliminating the possibility of 'memory
 666     leaks'.
 667
 668     @library{wxcore}
 669     @category{gdi}
 670
 671     @see wxFont
 672 */
 673 class wxFontList : public wxList
 674 {
 675 public:
 676     /**
 677         Constructor. The application should not construct its own font list:
 678         use the object pointer ::wxTheFontList.
 679     */
 680     wxFontList();
 681
 682     /**
 683         Finds a font of the given specification, or creates one and adds it to the
 684         list. See the @ref wxFont "wxFont constructor" for details of the arguments.
 685     */
 686     wxFont* FindOrCreateFont(int point_size, wxFontFamily family, wxFontStyle style,
 687                              wxFontWeight weight, bool underline = false,
 688                              const wxString& facename = wxEmptyString,
 689                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 690 };
 691
 692
 693 /**
 694     The global wxFontList instance.
 695 */
 696 wxFontList* wxTheFontList;
 697
 698
 699 // ============================================================================
 700 // Global functions/macros
 701 // ============================================================================
 702
 703 /** @addtogroup group_funcmacro_misc */
 704 //@{
 705
 706 /**
 707     Converts string to a wxFont best represented by the given string. Returns
 708     @true on success.
 709
 710     @see wxToString(const wxFont&)
 711
 712     @header{wx/font.h}
 713 */
 714 bool wxFromString(const wxString& string, wxFont* font);
 715
 716 /**
 717     Converts the given wxFont into a string.
 718
 719     @see wxFromString(const wxString&, wxFont*)
 720
 721     @header{wx/font.h}
 722 */
 723 wxString wxToString(const wxFont& font);
 724
 725 //@}
 726