]>
Commit | Line | Data |
---|---|---|
0c5d3e1c VZ |
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$ | |
77ffb593 | 8 | // Copyright: (c) wxWidgets team |
65571936 | 9 | // Licence: wxWindows licence |
0c5d3e1c VZ |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_FONT_H_BASE_ |
13 | #define _WX_FONT_H_BASE_ | |
c801d85f | 14 | |
0c5d3e1c VZ |
15 | // ---------------------------------------------------------------------------- |
16 | // headers | |
17 | // ---------------------------------------------------------------------------- | |
18 | ||
19 | #include "wx/defs.h" // for wxDEFAULT &c | |
f6bcfd97 | 20 | #include "wx/fontenc.h" // the font encoding constants |
0c5d3e1c | 21 | #include "wx/gdiobj.h" // the base class |
9d7a8e4a | 22 | #include "wx/gdicmn.h" // for wxGDIObjListBase |
0c5d3e1c VZ |
23 | |
24 | // ---------------------------------------------------------------------------- | |
25 | // forward declarations | |
26 | // ---------------------------------------------------------------------------- | |
27 | ||
b5dbe15d VS |
28 | class WXDLLIMPEXP_FWD_CORE wxFontData; |
29 | class WXDLLIMPEXP_FWD_CORE wxFontBase; | |
30 | class WXDLLIMPEXP_FWD_CORE wxFont; | |
31 | class WXDLLIMPEXP_FWD_CORE wxSize; | |
0c5d3e1c VZ |
32 | |
33 | // ---------------------------------------------------------------------------- | |
34 | // font constants | |
35 | // ---------------------------------------------------------------------------- | |
36 | ||
409d5a58 VZ |
37 | // standard font families: these may be used only for the font creation, it |
38 | // doesn't make sense to query an existing font for its font family as, | |
39 | // especially if the font had been created from a native font description, it | |
40 | // may be unknown | |
0c5d3e1c VZ |
41 | enum wxFontFamily |
42 | { | |
43 | wxFONTFAMILY_DEFAULT = wxDEFAULT, | |
44 | wxFONTFAMILY_DECORATIVE = wxDECORATIVE, | |
45 | wxFONTFAMILY_ROMAN = wxROMAN, | |
46 | wxFONTFAMILY_SCRIPT = wxSCRIPT, | |
47 | wxFONTFAMILY_SWISS = wxSWISS, | |
48 | wxFONTFAMILY_MODERN = wxMODERN, | |
49 | wxFONTFAMILY_TELETYPE = wxTELETYPE, | |
409d5a58 VZ |
50 | wxFONTFAMILY_MAX, |
51 | wxFONTFAMILY_UNKNOWN = wxFONTFAMILY_MAX | |
0c5d3e1c VZ |
52 | }; |
53 | ||
54 | // font styles | |
55 | enum wxFontStyle | |
56 | { | |
57 | wxFONTSTYLE_NORMAL = wxNORMAL, | |
58 | wxFONTSTYLE_ITALIC = wxITALIC, | |
59 | wxFONTSTYLE_SLANT = wxSLANT, | |
60 | wxFONTSTYLE_MAX | |
61 | }; | |
62 | ||
63 | // font weights | |
64 | enum wxFontWeight | |
65 | { | |
66 | wxFONTWEIGHT_NORMAL = wxNORMAL, | |
67 | wxFONTWEIGHT_LIGHT = wxLIGHT, | |
68 | wxFONTWEIGHT_BOLD = wxBOLD, | |
69 | wxFONTWEIGHT_MAX | |
70 | }; | |
71 | ||
01cb1c26 | 72 | // the font flag bits for the new font ctor accepting one combined flags word |
0b70c946 | 73 | enum wxFontFlag |
01cb1c26 VZ |
74 | { |
75 | // no special flags: font with default weight/slant/anti-aliasing | |
76 | wxFONTFLAG_DEFAULT = 0, | |
77 | ||
78 | // slant flags (default: no slant) | |
79 | wxFONTFLAG_ITALIC = 1 << 0, | |
80 | wxFONTFLAG_SLANT = 1 << 1, | |
81 | ||
82 | // weight flags (default: medium) | |
83 | wxFONTFLAG_LIGHT = 1 << 2, | |
84 | wxFONTFLAG_BOLD = 1 << 3, | |
85 | ||
86 | // anti-aliasing flag: force on or off (default: the current system default) | |
87 | wxFONTFLAG_ANTIALIASED = 1 << 4, | |
88 | wxFONTFLAG_NOT_ANTIALIASED = 1 << 5, | |
89 | ||
90 | // underlined/strikethrough flags (default: no lines) | |
91 | wxFONTFLAG_UNDERLINED = 1 << 6, | |
92 | wxFONTFLAG_STRIKETHROUGH = 1 << 7, | |
93 | ||
94 | // the mask of all currently used flags | |
95 | wxFONTFLAG_MASK = wxFONTFLAG_ITALIC | | |
96 | wxFONTFLAG_SLANT | | |
97 | wxFONTFLAG_LIGHT | | |
98 | wxFONTFLAG_BOLD | | |
99 | wxFONTFLAG_ANTIALIASED | | |
100 | wxFONTFLAG_NOT_ANTIALIASED | | |
101 | wxFONTFLAG_UNDERLINED | | |
102 | wxFONTFLAG_STRIKETHROUGH | |
103 | }; | |
104 | ||
0c5d3e1c VZ |
105 | // ---------------------------------------------------------------------------- |
106 | // wxFontBase represents a font object | |
107 | // ---------------------------------------------------------------------------- | |
108 | ||
b5dbe15d | 109 | class WXDLLIMPEXP_FWD_CORE wxNativeFontInfo; |
4d85bcd1 | 110 | |
53a2db12 | 111 | class WXDLLIMPEXP_CORE wxFontBase : public wxGDIObject |
0c5d3e1c VZ |
112 | { |
113 | public: | |
b5791cc7 FM |
114 | /* |
115 | derived classes should provide the following ctors: | |
116 | ||
117 | wxFont(); | |
118 | wxFont(const wxString& nativeFontInfoString); | |
119 | wxFont(const wxNativeFontInfo& info); | |
120 | wxFont(int size, | |
121 | wxFontFamily family, | |
122 | wxFontStyle style, | |
123 | wxFontWeight weight, | |
124 | bool underlined = false, | |
125 | const wxString& face = wxEmptyString, | |
126 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); | |
127 | wxFont(const wxSize& pixelSize, | |
128 | wxFontFamily family, | |
129 | wxFontStyle style, | |
130 | wxFontWeight weight, | |
131 | bool underlined = false, | |
132 | const wxString& face = wxEmptyString, | |
133 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); | |
134 | */ | |
135 | ||
0c5d3e1c | 136 | // creator function |
799ea011 | 137 | virtual ~wxFontBase(); |
7826e2dd | 138 | |
0c14b6c3 FM |
139 | |
140 | #if FUTURE_WXWIN_COMPATIBILITY_3_0 | |
7826e2dd | 141 | // from the font components |
0c5d3e1c VZ |
142 | static wxFont *New( |
143 | int pointSize, // size of the font in points | |
144 | int family, // see wxFontFamily enum | |
145 | int style, // see wxFontStyle enum | |
146 | int weight, // see wxFontWeight enum | |
a62848fd | 147 | bool underlined = false, // not underlined by default |
0c5d3e1c | 148 | const wxString& face = wxEmptyString, // facename |
0c14b6c3 FM |
149 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT) // ISO8859-X, ... |
150 | { return New(pointSize, (wxFontFamily)family, (wxFontStyle)style, | |
151 | (wxFontWeight)weight, underlined, face, encoding); } | |
01cb1c26 | 152 | |
544229d1 VZ |
153 | // from the font components |
154 | static wxFont *New( | |
155 | const wxSize& pixelSize, // size of the font in pixels | |
156 | int family, // see wxFontFamily enum | |
157 | int style, // see wxFontStyle enum | |
158 | int weight, // see wxFontWeight enum | |
4055ed82 | 159 | bool underlined = false, // not underlined by default |
544229d1 | 160 | const wxString& face = wxEmptyString, // facename |
0c14b6c3 FM |
161 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT) // ISO8859-X, ... |
162 | { return New(pixelSize, (wxFontFamily)family, (wxFontStyle)style, | |
163 | (wxFontWeight)weight, underlined, face, encoding); } | |
164 | #endif | |
165 | ||
166 | // from the font components | |
167 | static wxFont *New( | |
168 | int pointSize, // size of the font in points | |
169 | wxFontFamily family, // see wxFontFamily enum | |
170 | wxFontStyle style, // see wxFontStyle enum | |
171 | wxFontWeight weight, // see wxFontWeight enum | |
172 | bool underlined = false, // not underlined by default | |
173 | const wxString& face = wxEmptyString, // facename | |
544229d1 VZ |
174 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ... |
175 | ||
0c14b6c3 FM |
176 | // from the font components |
177 | static wxFont *New( | |
178 | const wxSize& pixelSize, // size of the font in pixels | |
179 | wxFontFamily family, // see wxFontFamily enum | |
180 | wxFontStyle style, // see wxFontStyle enum | |
181 | wxFontWeight weight, // see wxFontWeight enum | |
182 | bool underlined = false, // not underlined by default | |
183 | const wxString& face = wxEmptyString, // facename | |
184 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ... | |
185 | ||
186 | // from the font components but using the font flags instead of separate | |
187 | // parameters for each flag | |
188 | static wxFont *New(int pointSize, | |
189 | wxFontFamily family, | |
190 | int flags = wxFONTFLAG_DEFAULT, | |
191 | const wxString& face = wxEmptyString, | |
192 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); | |
193 | ||
194 | ||
544229d1 VZ |
195 | // from the font components but using the font flags instead of separate |
196 | // parameters for each flag | |
197 | static wxFont *New(const wxSize& pixelSize, | |
198 | wxFontFamily family, | |
199 | int flags = wxFONTFLAG_DEFAULT, | |
200 | const wxString& face = wxEmptyString, | |
201 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); | |
202 | ||
7826e2dd VZ |
203 | // from the (opaque) native font description object |
204 | static wxFont *New(const wxNativeFontInfo& nativeFontDesc); | |
205 | ||
206 | // from the string representation of wxNativeFontInfo | |
207 | static wxFont *New(const wxString& strNativeFontDesc); | |
0c5d3e1c | 208 | |
0c5d3e1c | 209 | // comparison |
8f884a0d VZ |
210 | bool operator==(const wxFont& font) const; |
211 | bool operator!=(const wxFont& font) const { return !(*this == font); } | |
0c5d3e1c VZ |
212 | |
213 | // accessors: get the font characteristics | |
214 | virtual int GetPointSize() const = 0; | |
544229d1 VZ |
215 | virtual wxSize GetPixelSize() const; |
216 | virtual bool IsUsingSizeInPixels() const; | |
0c14b6c3 FM |
217 | virtual wxFontFamily GetFamily() const = 0; |
218 | virtual wxFontStyle GetStyle() const = 0; | |
219 | virtual wxFontWeight GetWeight() const = 0; | |
0c5d3e1c VZ |
220 | virtual bool GetUnderlined() const = 0; |
221 | virtual wxString GetFaceName() const = 0; | |
222 | virtual wxFontEncoding GetEncoding() const = 0; | |
3bf5a59b | 223 | virtual const wxNativeFontInfo *GetNativeFontInfo() const = 0; |
ab5fe833 | 224 | |
53f6aab7 VZ |
225 | virtual bool IsFixedWidth() const; |
226 | ||
7826e2dd | 227 | wxString GetNativeFontInfoDesc() const; |
ab5fe833 | 228 | wxString GetNativeFontInfoUserDesc() const; |
0c5d3e1c VZ |
229 | |
230 | // change the font characteristics | |
231 | virtual void SetPointSize( int pointSize ) = 0; | |
544229d1 | 232 | virtual void SetPixelSize( const wxSize& pixelSize ); |
0c14b6c3 FM |
233 | virtual void SetFamily( wxFontFamily family ) = 0; |
234 | virtual void SetStyle( wxFontStyle style ) = 0; | |
235 | virtual void SetWeight( wxFontWeight weight ) = 0; | |
236 | ||
0c5d3e1c VZ |
237 | virtual void SetUnderlined( bool underlined ) = 0; |
238 | virtual void SetEncoding(wxFontEncoding encoding) = 0; | |
85ab460e | 239 | virtual bool SetFaceName( const wxString& faceName ); |
9045ad9d VZ |
240 | void SetNativeFontInfo(const wxNativeFontInfo& info) |
241 | { DoSetNativeFontInfo(info); } | |
ab5fe833 | 242 | |
85ab460e VZ |
243 | bool SetNativeFontInfo(const wxString& info); |
244 | bool SetNativeFontInfoUserDesc(const wxString& info); | |
7826e2dd | 245 | |
0c5d3e1c VZ |
246 | // translate the fonts into human-readable string (i.e. GetStyleString() |
247 | // will return "wxITALIC" for an italic font, ...) | |
248 | wxString GetFamilyString() const; | |
249 | wxString GetStyleString() const; | |
250 | wxString GetWeightString() const; | |
251 | ||
2b5f62a0 | 252 | // Unofficial API, don't use |
a62848fd WS |
253 | virtual void SetNoAntiAliasing( bool WXUNUSED(no) = true ) { } |
254 | virtual bool GetNoAntiAliasing() const { return false; } | |
2b5f62a0 | 255 | |
0c5d3e1c VZ |
256 | // the default encoding is used for creating all fonts with default |
257 | // encoding parameter | |
cafbf6fb VZ |
258 | static wxFontEncoding GetDefaultEncoding() { return ms_encodingDefault; } |
259 | static void SetDefaultEncoding(wxFontEncoding encoding); | |
0c5d3e1c VZ |
260 | |
261 | protected: | |
9045ad9d VZ |
262 | // the function called by both overloads of SetNativeFontInfo() |
263 | virtual void DoSetNativeFontInfo(const wxNativeFontInfo& info); | |
264 | ||
0c5d3e1c VZ |
265 | private: |
266 | // the currently default encoding: by default, it's the default system | |
267 | // encoding, but may be changed by the application using | |
268 | // SetDefaultEncoding() to make all subsequent fonts created without | |
3103e8a9 | 269 | // specifying encoding parameter using this encoding |
0c5d3e1c VZ |
270 | static wxFontEncoding ms_encodingDefault; |
271 | }; | |
272 | ||
fc9361e3 VZ |
273 | // wxFontBase <-> wxString utilities, used by wxConfig |
274 | WXDLLIMPEXP_CORE wxString wxToString(const wxFontBase& font); | |
275 | WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxFontBase* font); | |
276 | ||
277 | ||
0c14b6c3 | 278 | #if FUTURE_WXWIN_COMPATIBILITY_3_0 |
f76c0758 | 279 | #define wxDECLARE_FONT_COMPAT_SETTER \ |
0c14b6c3 FM |
280 | wxDEPRECATED_FUTURE( void SetFamily(int family) ) \ |
281 | { SetFamily((wxFontFamily)family); } \ | |
282 | wxDEPRECATED_FUTURE( void SetStyle(int style) ) \ | |
283 | { SetStyle((wxFontStyle)style); } \ | |
284 | wxDEPRECATED_FUTURE( void SetWeight(int weight) ) \ | |
285 | { SetWeight((wxFontWeight)weight); } \ | |
286 | wxDEPRECATED_FUTURE( void SetFamily(wxDeprecatedGUIConstants family) ) \ | |
287 | { SetFamily((wxFontFamily)family); } \ | |
288 | wxDEPRECATED_FUTURE( void SetStyle(wxDeprecatedGUIConstants style) ) \ | |
289 | { SetStyle((wxFontStyle)style); } \ | |
290 | wxDEPRECATED_FUTURE( void SetWeight(wxDeprecatedGUIConstants weight) ) \ | |
291 | { SetWeight((wxFontWeight)weight); } | |
292 | #else | |
f76c0758 | 293 | #define wxDECLARE_FONT_COMPAT_SETTER /*empty*/ |
0c14b6c3 | 294 | #endif |
fc9361e3 | 295 | |
f76c0758 VZ |
296 | // this macro must be used in all derived wxFont classes declarations |
297 | #define wxDECLARE_COMMON_FONT_METHODS() \ | |
298 | wxDECLARE_FONT_COMPAT_SETTER \ | |
299 | \ | |
300 | /* functions for creating fonts based on this one */ \ | |
301 | wxFont MakeBold() const; \ | |
302 | wxFont MakeItalic() const; \ | |
303 | wxFont MakeLarger() const { return Scale(1.2f); } \ | |
304 | wxFont MakeSmaller() const { return Scale(1/1.2f); } \ | |
305 | wxFont Scale(float x) const | |
306 | ||
0c5d3e1c | 307 | // include the real class declaration |
4055ed82 | 308 | #if defined(__WXPALMOS__) |
ffecfa5a JS |
309 | #include "wx/palmos/font.h" |
310 | #elif defined(__WXMSW__) | |
0c5d3e1c | 311 | #include "wx/msw/font.h" |
2049ba38 | 312 | #elif defined(__WXMOTIF__) |
0c5d3e1c | 313 | #include "wx/motif/font.h" |
1be7a35c | 314 | #elif defined(__WXGTK20__) |
0c5d3e1c | 315 | #include "wx/gtk/font.h" |
1be7a35c MR |
316 | #elif defined(__WXGTK__) |
317 | #include "wx/gtk1/font.h" | |
83df96d6 JS |
318 | #elif defined(__WXX11__) |
319 | #include "wx/x11/font.h" | |
1e6feb95 VZ |
320 | #elif defined(__WXMGL__) |
321 | #include "wx/mgl/font.h" | |
b3c86150 VS |
322 | #elif defined(__WXDFB__) |
323 | #include "wx/dfb/font.h" | |
34138703 | 324 | #elif defined(__WXMAC__) |
ef0e9220 | 325 | #include "wx/osx/font.h" |
e64df9bc DE |
326 | #elif defined(__WXCOCOA__) |
327 | #include "wx/cocoa/font.h" | |
1777b9bb | 328 | #elif defined(__WXPM__) |
0c5d3e1c | 329 | #include "wx/os2/font.h" |
c801d85f KB |
330 | #endif |
331 | ||
82cddbd9 FM |
332 | class WXDLLIMPEXP_CORE wxFontList: public wxGDIObjListBase |
333 | { | |
334 | public: | |
335 | wxFont *FindOrCreateFont(int pointSize, | |
336 | wxFontFamily family, | |
337 | wxFontStyle style, | |
338 | wxFontWeight weight, | |
339 | bool underline = false, | |
340 | const wxString& face = wxEmptyString, | |
341 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT); | |
020eeaa8 FM |
342 | |
343 | #if FUTURE_WXWIN_COMPATIBILITY_3_0 | |
344 | wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight, | |
345 | bool underline = false, | |
346 | const wxString& face = wxEmptyString, | |
347 | wxFontEncoding encoding = wxFONTENCODING_DEFAULT) | |
348 | { return FindOrCreateFont(pointSize, (wxFontFamily)family, (wxFontStyle)style, | |
349 | (wxFontWeight)weight, underline, face, encoding); } | |
350 | #endif | |
351 | ||
82cddbd9 FM |
352 | #if WXWIN_COMPATIBILITY_2_6 |
353 | wxDEPRECATED( void AddFont(wxFont*) ); | |
354 | wxDEPRECATED( void RemoveFont(wxFont*) ); | |
355 | #endif | |
356 | }; | |
357 | ||
53a2db12 | 358 | extern WXDLLIMPEXP_DATA_CORE(wxFontList*) wxTheFontList; |
82cddbd9 | 359 | |
0c14b6c3 FM |
360 | |
361 | // provide comparison operators to allow code such as | |
362 | // | |
363 | // if ( font.GetStyle() == wxFONTSTYLE_SLANT ) | |
364 | // | |
365 | // to compile without warnings which it would otherwise provoke from some | |
366 | // compilers as it compares elements of different enums | |
367 | #if FUTURE_WXWIN_COMPATIBILITY_3_0 | |
368 | ||
369 | inline bool operator==(wxFontFamily s, wxDeprecatedGUIConstants t) | |
370 | { return static_cast<int>(s) == static_cast<int>(t); } | |
371 | inline bool operator!=(wxFontFamily s, wxDeprecatedGUIConstants t) | |
372 | { return !(s == t); } | |
373 | inline bool operator==(wxFontStyle s, wxDeprecatedGUIConstants t) | |
374 | { return static_cast<int>(s) == static_cast<int>(t); } | |
375 | inline bool operator!=(wxFontStyle s, wxDeprecatedGUIConstants t) | |
376 | { return !(s == t); } | |
377 | inline bool operator==(wxFontWeight s, wxDeprecatedGUIConstants t) | |
378 | { return static_cast<int>(s) == static_cast<int>(t); } | |
379 | inline bool operator!=(wxFontWeight s, wxDeprecatedGUIConstants t) | |
380 | { return !(s == t); } | |
381 | ||
382 | #endif // FUTURE_WXWIN_COMPATIBILITY_3_0 | |
383 | ||
c801d85f | 384 | #endif |
34138703 | 385 | // _WX_FONT_H_BASE_ |