1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxFontBase class: the interface of wxFont
4 // Author: Vadim Zeitlin
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_FONT_H_BASE_
13 #define _WX_FONT_H_BASE_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 #include "wx/defs.h" // for wxDEFAULT &c
20 #include "wx/fontenc.h" // the font encoding constants
21 #include "wx/gdiobj.h" // the base class
22 #include "wx/gdicmn.h" // for wxGDIObjListBase
24 // ----------------------------------------------------------------------------
25 // forward declarations
26 // ----------------------------------------------------------------------------
28 class WXDLLIMPEXP_FWD_CORE wxFontData
;
29 class WXDLLIMPEXP_FWD_CORE wxFontBase
;
30 class WXDLLIMPEXP_FWD_CORE wxFont
;
31 class WXDLLIMPEXP_FWD_CORE wxSize
;
33 // ----------------------------------------------------------------------------
35 // ----------------------------------------------------------------------------
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
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
,
51 wxFONTFAMILY_UNKNOWN
= wxFONTFAMILY_MAX
57 wxFONTSTYLE_NORMAL
= wxNORMAL
,
58 wxFONTSTYLE_ITALIC
= wxITALIC
,
59 wxFONTSTYLE_SLANT
= wxSLANT
,
66 wxFONTWEIGHT_NORMAL
= wxNORMAL
,
67 wxFONTWEIGHT_LIGHT
= wxLIGHT
,
68 wxFONTWEIGHT_BOLD
= wxBOLD
,
72 // the font flag bits for the new font ctor accepting one combined flags word
75 // no special flags: font with default weight/slant/anti-aliasing
76 wxFONTFLAG_DEFAULT
= 0,
78 // slant flags (default: no slant)
79 wxFONTFLAG_ITALIC
= 1 << 0,
80 wxFONTFLAG_SLANT
= 1 << 1,
82 // weight flags (default: medium)
83 wxFONTFLAG_LIGHT
= 1 << 2,
84 wxFONTFLAG_BOLD
= 1 << 3,
86 // anti-aliasing flag: force on or off (default: the current system default)
87 wxFONTFLAG_ANTIALIASED
= 1 << 4,
88 wxFONTFLAG_NOT_ANTIALIASED
= 1 << 5,
90 // underlined/strikethrough flags (default: no lines)
91 wxFONTFLAG_UNDERLINED
= 1 << 6,
92 wxFONTFLAG_STRIKETHROUGH
= 1 << 7,
94 // the mask of all currently used flags
95 wxFONTFLAG_MASK
= wxFONTFLAG_ITALIC
|
99 wxFONTFLAG_ANTIALIASED
|
100 wxFONTFLAG_NOT_ANTIALIASED
|
101 wxFONTFLAG_UNDERLINED
|
102 wxFONTFLAG_STRIKETHROUGH
105 // ----------------------------------------------------------------------------
106 // wxFontBase represents a font object
107 // ----------------------------------------------------------------------------
109 class WXDLLIMPEXP_FWD_CORE wxNativeFontInfo
;
111 class WXDLLEXPORT wxFontBase
: public wxGDIObject
115 virtual ~wxFontBase();
117 // from the font components
119 int pointSize
, // size of the font in points
120 int family
, // see wxFontFamily enum
121 int style
, // see wxFontStyle enum
122 int weight
, // see wxFontWeight enum
123 bool underlined
= false, // not underlined by default
124 const wxString
& face
= wxEmptyString
, // facename
125 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
); // ISO8859-X, ...
127 // from the font components but using the font flags instead of separate
128 // parameters for each flag
129 static wxFont
*New(int pointSize
,
131 int flags
= wxFONTFLAG_DEFAULT
,
132 const wxString
& face
= wxEmptyString
,
133 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
135 // from the font components
137 const wxSize
& pixelSize
, // size of the font in pixels
138 int family
, // see wxFontFamily enum
139 int style
, // see wxFontStyle enum
140 int weight
, // see wxFontWeight enum
141 bool underlined
= false, // not underlined by default
142 const wxString
& face
= wxEmptyString
, // facename
143 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
); // ISO8859-X, ...
145 // from the font components but using the font flags instead of separate
146 // parameters for each flag
147 static wxFont
*New(const wxSize
& pixelSize
,
149 int flags
= wxFONTFLAG_DEFAULT
,
150 const wxString
& face
= wxEmptyString
,
151 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
153 // from the (opaque) native font description object
154 static wxFont
*New(const wxNativeFontInfo
& nativeFontDesc
);
156 // from the string representation of wxNativeFontInfo
157 static wxFont
*New(const wxString
& strNativeFontDesc
);
160 bool operator==(const wxFont
& font
) const;
161 bool operator!=(const wxFont
& font
) const { return !(*this == font
); }
163 // accessors: get the font characteristics
164 virtual int GetPointSize() const = 0;
165 virtual wxSize
GetPixelSize() const;
166 virtual bool IsUsingSizeInPixels() const;
167 virtual int GetFamily() const = 0;
168 virtual int GetStyle() const = 0;
169 virtual int GetWeight() const = 0;
170 virtual bool GetUnderlined() const = 0;
171 virtual wxString
GetFaceName() const = 0;
172 virtual wxFontEncoding
GetEncoding() const = 0;
173 virtual const wxNativeFontInfo
*GetNativeFontInfo() const = 0;
175 virtual bool IsFixedWidth() const;
177 wxString
GetNativeFontInfoDesc() const;
178 wxString
GetNativeFontInfoUserDesc() const;
180 // change the font characteristics
181 virtual void SetPointSize( int pointSize
) = 0;
182 virtual void SetPixelSize( const wxSize
& pixelSize
);
183 virtual void SetFamily( int family
) = 0;
184 virtual void SetStyle( int style
) = 0;
185 virtual void SetWeight( int weight
) = 0;
186 virtual void SetUnderlined( bool underlined
) = 0;
187 virtual void SetEncoding(wxFontEncoding encoding
) = 0;
188 virtual bool SetFaceName( const wxString
& faceName
);
189 void SetNativeFontInfo(const wxNativeFontInfo
& info
)
190 { DoSetNativeFontInfo(info
); }
192 bool SetNativeFontInfo(const wxString
& info
);
193 bool SetNativeFontInfoUserDesc(const wxString
& info
);
195 // translate the fonts into human-readable string (i.e. GetStyleString()
196 // will return "wxITALIC" for an italic font, ...)
197 wxString
GetFamilyString() const;
198 wxString
GetStyleString() const;
199 wxString
GetWeightString() const;
201 // Unofficial API, don't use
202 virtual void SetNoAntiAliasing( bool WXUNUSED(no
) = true ) { }
203 virtual bool GetNoAntiAliasing() const { return false; }
205 // the default encoding is used for creating all fonts with default
206 // encoding parameter
207 static wxFontEncoding
GetDefaultEncoding() { return ms_encodingDefault
; }
208 static void SetDefaultEncoding(wxFontEncoding encoding
);
211 // the function called by both overloads of SetNativeFontInfo()
212 virtual void DoSetNativeFontInfo(const wxNativeFontInfo
& info
);
215 // the currently default encoding: by default, it's the default system
216 // encoding, but may be changed by the application using
217 // SetDefaultEncoding() to make all subsequent fonts created without
218 // specifying encoding parameter using this encoding
219 static wxFontEncoding ms_encodingDefault
;
222 // wxFontBase <-> wxString utilities, used by wxConfig
223 WXDLLIMPEXP_CORE wxString
wxToString(const wxFontBase
& font
);
224 WXDLLIMPEXP_CORE
bool wxFromString(const wxString
& str
, wxFontBase
* font
);
228 // include the real class declaration
229 #if defined(__WXPALMOS__)
230 #include "wx/palmos/font.h"
231 #elif defined(__WXMSW__)
232 #include "wx/msw/font.h"
233 #elif defined(__WXMOTIF__)
234 #include "wx/motif/font.h"
235 #elif defined(__WXGTK20__)
236 #include "wx/gtk/font.h"
237 #elif defined(__WXGTK__)
238 #include "wx/gtk1/font.h"
239 #elif defined(__WXX11__)
240 #include "wx/x11/font.h"
241 #elif defined(__WXMGL__)
242 #include "wx/mgl/font.h"
243 #elif defined(__WXDFB__)
244 #include "wx/dfb/font.h"
245 #elif defined(__WXMAC__)
246 #include "wx/mac/font.h"
247 #elif defined(__WXCOCOA__)
248 #include "wx/cocoa/font.h"
249 #elif defined(__WXPM__)
250 #include "wx/os2/font.h"
253 class WXDLLIMPEXP_CORE wxFontList
: public wxGDIObjListBase
256 wxFont
*FindOrCreateFont(int pointSize
,
260 bool underline
= false,
261 const wxString
& face
= wxEmptyString
,
262 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
264 #if FUTURE_WXWIN_COMPATIBILITY_3_0
265 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
266 bool underline
= false,
267 const wxString
& face
= wxEmptyString
,
268 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
)
269 { return FindOrCreateFont(pointSize
, (wxFontFamily
)family
, (wxFontStyle
)style
,
270 (wxFontWeight
)weight
, underline
, face
, encoding
); }
273 #if WXWIN_COMPATIBILITY_2_6
274 wxDEPRECATED( void AddFont(wxFont
*) );
275 wxDEPRECATED( void RemoveFont(wxFont
*) );
279 extern WXDLLEXPORT_DATA(wxFontList
*) wxTheFontList
;