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