Expand wxString overview and document some problems due to its dual nature.
[wxWidgets.git] / interface / wx / fontutil.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: fontutil.h
3 // Purpose: interface of wxNativeFontInfo
4 // Author: wxWidgets team
5 // RCS-ID: $Id: $
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
8
9
10 /**
11 @class wxNativeFontInfo
12
13 wxNativeFontInfo is platform-specific font representation: this class
14 should be considered as an opaque font description only used by the native
15 functions, the user code can only get the objects of this type from
16 somewhere and pass it somewhere else (possibly save them somewhere using
17 ToString() and restore them using FromString())
18
19 @library{wxcore}
20 @category{gdi}
21 */
22 class wxNativeFontInfo
23 {
24 public:
25 wxNativeFontInfo();
26 wxNativeFontInfo(const wxNativeFontInfo& info);
27 ~wxNativeFontInfo();
28
29 wxNativeFontInfo& operator=(const wxNativeFontInfo& info);
30
31 void Init();
32 void InitFromFont(const wxFont& font);
33
34 int GetPointSize() const;
35 wxSize GetPixelSize() const;
36 wxFontStyle GetStyle() const;
37 wxFontWeight GetWeight() const;
38 bool GetUnderlined() const;
39 wxString GetFaceName() const;
40 wxFontFamily GetFamily() const;
41 wxFontEncoding GetEncoding() const;
42
43 void SetPointSize(int pointsize);
44 void SetPixelSize(const wxSize& pixelSize);
45 void SetStyle(wxFontStyle style);
46 void SetWeight(wxFontWeight weight);
47 void SetUnderlined(bool underlined);
48 bool SetFaceName(const wxString& facename);
49 void SetFamily(wxFontFamily family);
50 void SetEncoding(wxFontEncoding encoding);
51
52 void SetFaceName(const wxArrayString &facenames);
53
54 bool FromString(const wxString& s);
55 wxString ToString() const;
56
57 bool FromUserString(const wxString& s);
58 wxString ToUserString() const;
59 };
60
61
62
63