Remove all lines containing cvs/svn "$Id$" keyword.
[wxWidgets.git] / include / wx / x11 / font.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/x11/font.h
3 // Purpose: wxFont class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // Copyright: (c) Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 #ifndef _WX_FONT_H_
12 #define _WX_FONT_H_
13
14 class wxXFont;
15
16 // Font
17 class WXDLLIMPEXP_CORE wxFont : public wxFontBase
18 {
19 public:
20 // ctors and such
21 wxFont() { }
22
23 wxFont(const wxFontInfo& info)
24 {
25 Create(info.GetPointSize(),
26 info.GetFamily(),
27 info.GetStyle(),
28 info.GetWeight(),
29 info.IsUnderlined(),
30 info.GetFaceName(),
31 info.GetEncoding());
32
33 if ( info.IsUsingSizeInPixels() )
34 SetPixelSize(info.GetPixelSize());
35 }
36
37 #if FUTURE_WXWIN_COMPATIBILITY_3_0
38 wxFont(int size,
39 int family,
40 int style,
41 int weight,
42 bool underlined = false,
43 const wxString& face = wxEmptyString,
44 wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
45 {
46 (void)Create(size, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight, underlined, face, encoding);
47 }
48 #endif
49
50 wxFont(int size,
51 wxFontFamily family,
52 wxFontStyle style,
53 wxFontWeight weight,
54 bool underlined = false,
55 const wxString& face = wxEmptyString,
56 wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
57 {
58 Create(size, family, style, weight, underlined, face, encoding);
59 }
60
61 wxFont(const wxSize& pixelSize,
62 wxFontFamily family,
63 wxFontStyle style,
64 wxFontWeight weight,
65 bool underlined = false,
66 const wxString& face = wxEmptyString,
67 wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
68 {
69 Create(10, family, style, weight, underlined, face, encoding);
70 SetPixelSize(pixelSize);
71 }
72
73 bool Create(int size,
74 wxFontFamily family,
75 wxFontStyle style,
76 wxFontWeight weight,
77 bool underlined = false,
78 const wxString& face = wxEmptyString,
79 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
80
81 wxFont(const wxNativeFontInfo& info);
82
83 // FIXME: I added the ! to make it compile;
84 // is this right? - JACS
85 #if !wxUSE_UNICODE
86 bool Create(const wxString& fontname,
87 wxFontEncoding fontenc = wxFONTENCODING_DEFAULT);
88 #endif
89 // DELETEME: no longer seems to be implemented.
90 // bool Create(const wxNativeFontInfo& fontinfo);
91
92 virtual ~wxFont();
93
94 // implement base class pure virtuals
95 virtual int GetPointSize() const;
96 virtual wxFontStyle GetStyle() const;
97 virtual wxFontWeight GetWeight() const;
98 virtual bool GetUnderlined() const;
99 virtual wxString GetFaceName() const;
100 virtual wxFontEncoding GetEncoding() const;
101 virtual const wxNativeFontInfo *GetNativeFontInfo() const;
102
103 virtual bool IsFixedWidth() const;
104
105 virtual void SetPointSize(int pointSize);
106 virtual void SetFamily(wxFontFamily family);
107 virtual void SetStyle(wxFontStyle style);
108 virtual void SetWeight(wxFontWeight weight);
109 virtual bool SetFaceName(const wxString& faceName);
110 virtual void SetUnderlined(bool underlined);
111 virtual void SetEncoding(wxFontEncoding encoding);
112
113 wxDECLARE_COMMON_FONT_METHODS();
114
115 // Implementation
116
117 #if wxUSE_PANGO
118 #else
119 // Find an existing, or create a new, XFontStruct
120 // based on this wxFont and the given scale. Append the
121 // font to list in the private data for future reference.
122
123 // TODO This is a fairly basic implementation, that doesn't
124 // allow for different facenames, and also doesn't do a mapping
125 // between 'standard' facenames (e.g. Arial, Helvetica, Times Roman etc.)
126 // and the fonts that are available on a particular system.
127 // Maybe we need to scan the user's machine to build up a profile
128 // of the fonts and a mapping file.
129
130 // Return font struct, and optionally the Motif font list
131 wxXFont *GetInternalFont(double scale = 1.0,
132 WXDisplay* display = NULL) const;
133
134 // Helper function for convenient access of the above.
135 WXFontStructPtr GetFontStruct(double scale = 1.0,
136 WXDisplay* display = NULL) const;
137 #endif
138
139 protected:
140 virtual wxGDIRefData *CreateGDIRefData() const;
141 virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
142
143 virtual void DoSetNativeFontInfo( const wxNativeFontInfo& info );
144 virtual wxFontFamily DoGetFamily() const;
145
146 void Unshare();
147
148 private:
149 DECLARE_DYNAMIC_CLASS(wxFont)
150 };
151
152 #endif
153 // _WX_FONT_H_