include/wx/font.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/font.h
   3 // Purpose:     wxFontBase class: the interface of wxFont
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     20.09.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FONT_H_BASE_
  13 #define _WX_FONT_H_BASE_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "fontbase.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/defs.h"        // for wxDEFAULT &c
  24 #include "wx/fontenc.h"     // the font encoding constants
  25 #include "wx/gdiobj.h"      // the base class
  26
  27 // ----------------------------------------------------------------------------
  28 // forward declarations
  29 // ----------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxFontData;
  32 class WXDLLEXPORT wxFontBase;
  33 class WXDLLEXPORT wxFont;
  34
  35 // ----------------------------------------------------------------------------
  36 // font constants
  37 // ----------------------------------------------------------------------------
  38
  39 // standard font families
  40 enum wxFontFamily
  41 {
  42     wxFONTFAMILY_DEFAULT = wxDEFAULT,
  43     wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
  44     wxFONTFAMILY_ROMAN = wxROMAN,
  45     wxFONTFAMILY_SCRIPT = wxSCRIPT,
  46     wxFONTFAMILY_SWISS = wxSWISS,
  47     wxFONTFAMILY_MODERN = wxMODERN,
  48     wxFONTFAMILY_TELETYPE = wxTELETYPE,
  49     wxFONTFAMILY_MAX
  50 };
  51
  52 // font styles
  53 enum wxFontStyle
  54 {
  55     wxFONTSTYLE_NORMAL = wxNORMAL,
  56     wxFONTSTYLE_ITALIC = wxITALIC,
  57     wxFONTSTYLE_SLANT = wxSLANT,
  58     wxFONTSTYLE_MAX
  59 };
  60
  61 // font weights
  62 enum wxFontWeight
  63 {
  64     wxFONTWEIGHT_NORMAL = wxNORMAL,
  65     wxFONTWEIGHT_LIGHT = wxLIGHT,
  66     wxFONTWEIGHT_BOLD = wxBOLD,
  67     wxFONTWEIGHT_MAX
  68 };
  69
  70 // ----------------------------------------------------------------------------
  71 // wxFontBase represents a font object
  72 // ----------------------------------------------------------------------------
  73
  74 class WXDLLEXPORT wxFontRefData;
  75 class WXDLLEXPORT wxNativeFontInfo;
  76
  77 class WXDLLEXPORT wxFontBase : public wxGDIObject
  78 {
  79 public:
  80     // creator function
  81
  82     // from the font components
  83     static wxFont *New(
  84         int pointSize,              // size of the font in points
  85         int family,                 // see wxFontFamily enum
  86         int style,                  // see wxFontStyle enum
  87         int weight,                 // see wxFontWeight enum
  88         bool underlined = FALSE,    // not underlined by default
  89         const wxString& face = wxEmptyString,              // facename
  90         wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
  91
  92     // from the (opaque) native font description object
  93     static wxFont *New(const wxNativeFontInfo& nativeFontDesc);
  94
  95     // from the string representation of wxNativeFontInfo
  96     static wxFont *New(const wxString& strNativeFontDesc);
  97
  98     // was the font successfully created?
  99     bool Ok() const { return m_refData != NULL; }
 100
 101     // comparison
 102     bool operator == (const wxFont& font) const;
 103     bool operator != (const wxFont& font) const;
 104
 105     // accessors: get the font characteristics
 106     virtual int GetPointSize() const = 0;
 107     virtual int GetFamily() const = 0;
 108     virtual int GetStyle() const = 0;
 109     virtual int GetWeight() const = 0;
 110     virtual bool GetUnderlined() const = 0;
 111     virtual wxString GetFaceName() const = 0;
 112     virtual wxFontEncoding GetEncoding() const = 0;
 113     virtual wxNativeFontInfo *GetNativeFontInfo() const;
 114     wxString GetNativeFontInfoDesc() const;
 115
 116     // change the font characteristics
 117     virtual void SetPointSize( int pointSize ) = 0;
 118     virtual void SetFamily( int family ) = 0;
 119     virtual void SetStyle( int style ) = 0;
 120     virtual void SetWeight( int weight ) = 0;
 121     virtual void SetFaceName( const wxString& faceName ) = 0;
 122     virtual void SetUnderlined( bool underlined ) = 0;
 123     virtual void SetEncoding(wxFontEncoding encoding) = 0;
 124     virtual void SetNativeFontInfo(const wxNativeFontInfo& info);
 125
 126     // VZ: there is no void SetNativeFontInfo(const wxString& info), needed?
 127
 128     // translate the fonts into human-readable string (i.e. GetStyleString()
 129     // will return "wxITALIC" for an italic font, ...)
 130     wxString GetFamilyString() const;
 131     wxString GetStyleString() const;
 132     wxString GetWeightString() const;
 133
 134     // the default encoding is used for creating all fonts with default
 135     // encoding parameter
 136     static wxFontEncoding GetDefaultEncoding()
 137         { return ms_encodingDefault; }
 138     static void SetDefaultEncoding(wxFontEncoding encoding)
 139         { ms_encodingDefault = encoding; }
 140
 141 protected:
 142     // get the internal data
 143     wxFontRefData *GetFontData() const
 144         { return (wxFontRefData *)m_refData; }
 145
 146 private:
 147     // the currently default encoding: by default, it's the default system
 148     // encoding, but may be changed by the application using
 149     // SetDefaultEncoding() to make all subsequent fonts created without
 150     // specifing encoding parameter using this encoding
 151     static wxFontEncoding ms_encodingDefault;
 152 };
 153
 154 // include the real class declaration
 155 #if defined(__WXMSW__)
 156     #include "wx/msw/font.h"
 157 #elif defined(__WXMOTIF__)
 158     #include "wx/motif/font.h"
 159 #elif defined(__WXGTK__)
 160     #include "wx/gtk/font.h"
 161 #elif defined(__WXQT__)
 162     #include "wx/qt/font.h"
 163 #elif defined(__WXMAC__)
 164     #include "wx/mac/font.h"
 165 #elif defined(__WXPM__)
 166     #include "wx/os2/font.h"
 167 #elif defined(__WXSTUBS__)
 168     #include "wx/stubs/font.h"
 169 #endif
 170
 171 // ----------------------------------------------------------------------------
 172 // macros
 173 // ----------------------------------------------------------------------------
 174
 175 #define M_FONTDATA GetFontData()
 176
 177 #endif
 178     // _WX_FONT_H_BASE_