1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _core.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13class wxFontEnumerator
14{
15    %Docstring
16        FontEnumerator()
17
18        wxFontEnumerator enumerates either all available fonts on the system
19        or only the ones with given attributes - either only fixed-width
20        (suited for use in programs such as terminal emulators and the like)
21        or the fonts available in the given encoding).
22    %End
23    %TypeHeaderCode
24        #include <wx/fontenum.h>
25    %End
26
27public:
28    wxFontEnumerator();
29    %PreMethodCode
30        if (!wxPyCheckForApp()) return NULL;
31    %End
32
33    virtual
34    ~wxFontEnumerator();
35
36    virtual
37    bool EnumerateEncodings(
38        const wxString & font = wxEmptyString
39    );
40    %Docstring
41        EnumerateEncodings(font=EmptyString) -> bool
42
43        Call OnFontEncoding() for each encoding supported by the given font -
44        or for each encoding supported by at least some font if font is not
45        specified.
46    %End
47
48    virtual
49    bool EnumerateFacenames(
50        wxFontEncoding encoding = wxFONTENCODING_SYSTEM,
51        bool fixedWidthOnly = false
52    );
53    %Docstring
54        EnumerateFacenames(encoding=FONTENCODING_SYSTEM, fixedWidthOnly=False) -> bool
55
56        Call OnFacename() for each font which supports given encoding (only if
57        it is not wxFONTENCODING_SYSTEM) and is of fixed width (if
58        fixedWidthOnly is true).
59    %End
60
61    virtual
62    bool OnFacename(
63        const wxString & font
64    );
65    %Docstring
66        OnFacename(font) -> bool
67
68        Called by EnumerateFacenames() for each match.
69    %End
70
71    virtual
72    bool OnFontEncoding(
73        const wxString & font,
74        const wxString & encoding
75    );
76    %Docstring
77        OnFontEncoding(font, encoding) -> bool
78
79        Called by EnumerateEncodings() for each match.
80    %End
81
82    static
83    wxArrayString GetEncodings(
84        const wxString & facename = wxEmptyString
85    );
86    %Docstring
87        GetEncodings(facename=EmptyString) -> ArrayString
88
89        Return array of strings containing all encodings found by
90        EnumerateEncodings().
91    %End
92
93    static
94    wxArrayString GetFacenames(
95        wxFontEncoding encoding = wxFONTENCODING_SYSTEM,
96        bool fixedWidthOnly = false
97    );
98    %Docstring
99        GetFacenames(encoding=FONTENCODING_SYSTEM, fixedWidthOnly=False) -> ArrayString
100
101        Return array of strings containing all facenames found by
102        EnumerateFacenames().
103    %End
104
105    static
106    bool IsValidFacename(
107        const wxString & facename
108    );
109    %Docstring
110        IsValidFacename(facename) -> bool
111
112        Returns true if the given string is valid face name, i.e.
113    %End
114
115    private:
116        wxFontEnumerator(const wxFontEnumerator&);
117
118
119};  // end of class wxFontEnumerator
120
121
122
123//---------------------------------------------------------------------------
124
125