]> git.saurik.com Git - wxWidgets.git/blob - include/wx/font.h
fixed gcc warnings about not calling base class ctor explicitly in copy ctors (patch...
[wxWidgets.git] / 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) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_FONT_H_BASE_
13 #define _WX_FONT_H_BASE_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
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: these may be used only for the font creation, it
40 // doesn't make sense to query an existing font for its font family as,
41 // especially if the font had been created from a native font description, it
42 // may be unknown
43 enum wxFontFamily
44 {
45 wxFONTFAMILY_DEFAULT = wxDEFAULT,
46 wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
47 wxFONTFAMILY_ROMAN = wxROMAN,
48 wxFONTFAMILY_SCRIPT = wxSCRIPT,
49 wxFONTFAMILY_SWISS = wxSWISS,
50 wxFONTFAMILY_MODERN = wxMODERN,
51 wxFONTFAMILY_TELETYPE = wxTELETYPE,
52 wxFONTFAMILY_MAX,
53 wxFONTFAMILY_UNKNOWN = wxFONTFAMILY_MAX
54 };
55
56 // font styles
57 enum wxFontStyle
58 {
59 wxFONTSTYLE_NORMAL = wxNORMAL,
60 wxFONTSTYLE_ITALIC = wxITALIC,
61 wxFONTSTYLE_SLANT = wxSLANT,
62 wxFONTSTYLE_MAX
63 };
64
65 // font weights
66 enum wxFontWeight
67 {
68 wxFONTWEIGHT_NORMAL = wxNORMAL,
69 wxFONTWEIGHT_LIGHT = wxLIGHT,
70 wxFONTWEIGHT_BOLD = wxBOLD,
71 wxFONTWEIGHT_MAX
72 };
73
74 // the font flag bits for the new font ctor accepting one combined flags word
75 enum
76 {
77 // no special flags: font with default weight/slant/anti-aliasing
78 wxFONTFLAG_DEFAULT = 0,
79
80 // slant flags (default: no slant)
81 wxFONTFLAG_ITALIC = 1 << 0,
82 wxFONTFLAG_SLANT = 1 << 1,
83
84 // weight flags (default: medium)
85 wxFONTFLAG_LIGHT = 1 << 2,
86 wxFONTFLAG_BOLD = 1 << 3,
87
88 // anti-aliasing flag: force on or off (default: the current system default)
89 wxFONTFLAG_ANTIALIASED = 1 << 4,
90 wxFONTFLAG_NOT_ANTIALIASED = 1 << 5,
91
92 // underlined/strikethrough flags (default: no lines)
93 wxFONTFLAG_UNDERLINED = 1 << 6,
94 wxFONTFLAG_STRIKETHROUGH = 1 << 7,
95
96 // the mask of all currently used flags
97 wxFONTFLAG_MASK = wxFONTFLAG_ITALIC |
98 wxFONTFLAG_SLANT |
99 wxFONTFLAG_LIGHT |
100 wxFONTFLAG_BOLD |
101 wxFONTFLAG_ANTIALIASED |
102 wxFONTFLAG_NOT_ANTIALIASED |
103 wxFONTFLAG_UNDERLINED |
104 wxFONTFLAG_STRIKETHROUGH
105 };
106
107 // ----------------------------------------------------------------------------
108 // wxFontBase represents a font object
109 // ----------------------------------------------------------------------------
110
111 class WXDLLEXPORT wxFontRefData;
112 struct WXDLLEXPORT wxNativeFontInfo;
113
114 class WXDLLEXPORT wxFontBase : public wxGDIObject
115 {
116 public:
117 // creator function
118 virtual ~wxFontBase();
119
120 // from the font components
121 static wxFont *New(
122 int pointSize, // size of the font in points
123 int family, // see wxFontFamily enum
124 int style, // see wxFontStyle enum
125 int weight, // see wxFontWeight enum
126 bool underlined = false, // not underlined by default
127 const wxString& face = wxEmptyString, // facename
128 wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
129
130 // from the font components but using the font flags instead of separate
131 // parameters for each flag
132 static wxFont *New(int pointSize,
133 wxFontFamily family,
134 int flags = wxFONTFLAG_DEFAULT,
135 const wxString& face = wxEmptyString,
136 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
137
138 // from the (opaque) native font description object
139 static wxFont *New(const wxNativeFontInfo& nativeFontDesc);
140
141 // from the string representation of wxNativeFontInfo
142 static wxFont *New(const wxString& strNativeFontDesc);
143
144 // was the font successfully created?
145 bool Ok() const { return m_refData != NULL; }
146
147 // comparison
148 bool operator == (const wxFont& font) const;
149 bool operator != (const wxFont& font) const;
150
151 // accessors: get the font characteristics
152 virtual int GetPointSize() const = 0;
153 virtual int GetFamily() const = 0;
154 virtual int GetStyle() const = 0;
155 virtual int GetWeight() const = 0;
156 virtual bool GetUnderlined() const = 0;
157 virtual wxString GetFaceName() const = 0;
158 virtual wxFontEncoding GetEncoding() const = 0;
159 virtual const wxNativeFontInfo *GetNativeFontInfo() const = 0;
160
161 virtual bool IsFixedWidth() const;
162
163 wxString GetNativeFontInfoDesc() const;
164 wxString GetNativeFontInfoUserDesc() const;
165
166 // change the font characteristics
167 virtual void SetPointSize( int pointSize ) = 0;
168 virtual void SetFamily( int family ) = 0;
169 virtual void SetStyle( int style ) = 0;
170 virtual void SetWeight( int weight ) = 0;
171 virtual void SetFaceName( const wxString& faceName ) = 0;
172 virtual void SetUnderlined( bool underlined ) = 0;
173 virtual void SetEncoding(wxFontEncoding encoding) = 0;
174 void SetNativeFontInfo(const wxNativeFontInfo& info)
175 { DoSetNativeFontInfo(info); }
176
177 void SetNativeFontInfo(const wxString& info);
178 void SetNativeFontInfoUserDesc(const wxString& info);
179
180 // translate the fonts into human-readable string (i.e. GetStyleString()
181 // will return "wxITALIC" for an italic font, ...)
182 wxString GetFamilyString() const;
183 wxString GetStyleString() const;
184 wxString GetWeightString() const;
185
186 // Unofficial API, don't use
187 virtual void SetNoAntiAliasing( bool WXUNUSED(no) = true ) { }
188 virtual bool GetNoAntiAliasing() const { return false; }
189
190 // the default encoding is used for creating all fonts with default
191 // encoding parameter
192 static wxFontEncoding GetDefaultEncoding() { return ms_encodingDefault; }
193 static void SetDefaultEncoding(wxFontEncoding encoding);
194
195 protected:
196 // get the internal data
197 wxFontRefData *GetFontData() const
198 { return (wxFontRefData *)m_refData; }
199
200 // the function called by both overloads of SetNativeFontInfo()
201 virtual void DoSetNativeFontInfo(const wxNativeFontInfo& info);
202
203 private:
204 // the currently default encoding: by default, it's the default system
205 // encoding, but may be changed by the application using
206 // SetDefaultEncoding() to make all subsequent fonts created without
207 // specifing encoding parameter using this encoding
208 static wxFontEncoding ms_encodingDefault;
209 };
210
211 // include the real class declaration
212 #if defined(__WXMSW__)
213 #include "wx/msw/font.h"
214 #elif defined(__WXMOTIF__)
215 #include "wx/motif/font.h"
216 #elif defined(__WXGTK__)
217 #include "wx/gtk/font.h"
218 #elif defined(__WXX11__)
219 #include "wx/x11/font.h"
220 #elif defined(__WXMGL__)
221 #include "wx/mgl/font.h"
222 #elif defined(__WXMAC__)
223 #include "wx/mac/font.h"
224 #elif defined(__WXCOCOA__)
225 #include "wx/cocoa/font.h"
226 #elif defined(__WXPM__)
227 #include "wx/os2/font.h"
228 #endif
229
230 // ----------------------------------------------------------------------------
231 // macros
232 // ----------------------------------------------------------------------------
233
234 #define M_FONTDATA GetFontData()
235
236 #endif
237 // _WX_FONT_H_BASE_