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
13enum wxOperatingSystemId
14{
15    wxOS_UNKNOWN,
16    wxOS_MAC_OS,
17    wxOS_MAC_OSX_DARWIN,
18    wxOS_MAC,
19    wxOS_WINDOWS_9X,
20    wxOS_WINDOWS_NT,
21    wxOS_WINDOWS_MICRO,
22    wxOS_WINDOWS_CE,
23    wxOS_WINDOWS,
24    wxOS_UNIX_LINUX,
25    wxOS_UNIX_FREEBSD,
26    wxOS_UNIX_OPENBSD,
27    wxOS_UNIX_NETBSD,
28    wxOS_UNIX_SOLARIS,
29    wxOS_UNIX_AIX,
30    wxOS_UNIX_HPUX,
31    wxOS_UNIX,
32    wxOS_DOS,
33    wxOS_OS2
34};
35
36enum wxPortId
37{
38    wxPORT_UNKNOWN,
39    wxPORT_BASE,
40    wxPORT_MSW,
41    wxPORT_MOTIF,
42    wxPORT_GTK,
43    wxPORT_DFB,
44    wxPORT_X11,
45    wxPORT_OS2,
46    wxPORT_MAC,
47    wxPORT_COCOA,
48    wxPORT_WINCE
49};
50
51enum wxArchitecture
52{
53    wxARCH_INVALID,
54    wxARCH_32,
55    wxARCH_64,
56    wxARCH_MAX
57};
58
59enum wxEndianness
60{
61    wxENDIAN_INVALID,
62    wxENDIAN_BIG,
63    wxENDIAN_LITTLE,
64    wxENDIAN_PDP,
65    wxENDIAN_MAX
66};
67
68class wxPlatformInfo   /PyName=PlatformInformation/
69{
70    %Docstring
71        PlatformInfo()
72        PlatformInfo(pid, tkMajor=-1, tkMinor=-1, id=OS_UNKNOWN, osMajor=-1, osMinor=-1, arch=ARCH_INVALID, endian=ENDIAN_INVALID)
73
74        This class holds information about the operating system, the toolkit
75        and the basic architecture of the machine where the application is
76        currently running.
77    %End
78    %TypeHeaderCode
79        #include <wx/platinfo.h>
80    %End
81
82public:
83    wxPlatformInfo();
84
85    wxPlatformInfo(
86        wxPortId pid,
87        int tkMajor = -1,
88        int tkMinor = -1,
89        wxOperatingSystemId id = wxOS_UNKNOWN,
90        int osMajor = -1,
91        int osMinor = -1,
92        wxArchitecture arch = wxARCH_INVALID,
93        wxEndianness endian = wxENDIAN_INVALID
94    );
95
96    static
97    wxArchitecture GetArch(
98        const wxString & arch
99    );
100    %Docstring
101        GetArch(arch) -> Architecture
102
103        Converts the given string to a wxArchitecture enum value or to
104        wxARCH_INVALID if the given string is not a valid architecture string
105        (i.e.
106    %End
107
108    wxEndianness GetEndianness() const;
109    %Docstring
110        GetEndianness() -> Endianness
111
112        Returns the endianness ID of this wxPlatformInfo instance.
113    %End
114
115    wxOperatingSystemId GetOperatingSystemId() const;
116    %Docstring
117        GetOperatingSystemId() -> OperatingSystemId
118
119        Returns the operating system ID of this wxPlatformInfo instance.
120    %End
121
122    wxPortId GetPortId() const;
123    %Docstring
124        GetPortId() -> PortId
125
126        Returns the wxWidgets port ID associated with this wxPlatformInfo
127        instance.
128    %End
129
130    wxString GetArchName() const;
131    %Docstring
132        GetArchName() -> String
133
134        Returns the name for the architecture of this wxPlatformInfo instance.
135    %End
136
137    wxString GetEndiannessName() const;
138    %Docstring
139        GetEndiannessName() -> String
140
141        Returns the name for the endianness of this wxPlatformInfo instance.
142    %End
143
144    wxString GetOperatingSystemFamilyName() const;
145    %Docstring
146        GetOperatingSystemFamilyName() -> String
147
148        Returns the operating system family name of the OS associated with
149        this wxPlatformInfo instance.
150    %End
151
152    wxString GetOperatingSystemIdName() const;
153    %Docstring
154        GetOperatingSystemIdName() -> String
155
156        Returns the operating system name of the OS associated with this
157        wxPlatformInfo instance.
158    %End
159
160    wxString GetPortIdName() const;
161    %Docstring
162        GetPortIdName() -> String
163
164        Returns the name of the wxWidgets port ID associated with this
165        wxPlatformInfo instance.
166    %End
167
168    wxString GetPortIdShortName() const;
169    %Docstring
170        GetPortIdShortName() -> String
171
172        Returns the short name of the wxWidgets port ID associated with this
173        wxPlatformInfo instance.
174    %End
175
176    static
177    wxString GetOperatingSystemDirectory();
178    %Docstring
179        GetOperatingSystemDirectory() -> String
180
181        Returns the operating system directory.
182    %End
183
184    wxArchitecture GetArchitecture() const;
185    %Docstring
186        GetArchitecture() -> Architecture
187
188        Returns the architecture ID of this wxPlatformInfo instance.
189    %End
190
191    int GetOSMajorVersion() const;
192    %Docstring
193        GetOSMajorVersion() -> int
194
195        Returns the run-time major version of the OS associated with this
196        wxPlatformInfo instance.
197    %End
198
199    int GetOSMinorVersion() const;
200    %Docstring
201        GetOSMinorVersion() -> int
202
203        Returns the run-time minor version of the OS associated with this
204        wxPlatformInfo instance.
205    %End
206
207    wxString GetOperatingSystemDescription() const;
208    %Docstring
209        GetOperatingSystemDescription() -> String
210
211        Returns the description of the operating system of this wxPlatformInfo
212        instance.
213    %End
214
215    wxLinuxDistributionInfo GetLinuxDistributionInfo() const;
216    %Docstring
217        GetLinuxDistributionInfo() -> LinuxDistributionInfo
218
219        Returns the Linux distribution info associated with this
220        wxPlatformInfo instance.
221    %End
222
223    wxString GetDesktopEnvironment() const;
224    %Docstring
225        GetDesktopEnvironment() -> String
226
227        Returns the desktop environment associated with this wxPlatformInfo
228        instance.
229    %End
230
231    int GetToolkitMajorVersion() const;
232    %Docstring
233        GetToolkitMajorVersion() -> int
234
235        Returns the run-time major version of the toolkit associated with this
236        wxPlatformInfo instance.
237    %End
238
239    int GetToolkitMinorVersion() const;
240    %Docstring
241        GetToolkitMinorVersion() -> int
242
243        Returns the run-time minor version of the toolkit associated with this
244        wxPlatformInfo instance.
245    %End
246
247    void SetArchitecture(
248        wxArchitecture n
249    );
250    %Docstring
251        SetArchitecture(n)
252
253        Sets the architecture enum value associated with this wxPlatformInfo
254        instance.
255    %End
256
257    void SetEndianness(
258        wxEndianness n
259    );
260    %Docstring
261        SetEndianness(n)
262
263        Sets the endianness enum value associated with this wxPlatformInfo
264        instance.
265    %End
266
267    void SetOSVersion(
268        int major,
269        int minor
270    );
271    %Docstring
272        SetOSVersion(major, minor)
273
274        Sets the version of the operating system associated with this
275        wxPlatformInfo instance.
276    %End
277
278    void SetOperatingSystemId(
279        wxOperatingSystemId n
280    );
281    %Docstring
282        SetOperatingSystemId(n)
283
284        Sets the operating system associated with this wxPlatformInfo
285        instance.
286    %End
287
288    void SetPortId(
289        wxPortId n
290    );
291    %Docstring
292        SetPortId(n)
293
294        Sets the wxWidgets port ID associated with this wxPlatformInfo
295        instance.
296    %End
297
298    void SetToolkitVersion(
299        int major,
300        int minor
301    );
302    %Docstring
303        SetToolkitVersion(major, minor)
304
305        Sets the version of the toolkit associated with this wxPlatformInfo
306        instance.
307    %End
308
309    void SetOperatingSystemDescription(
310        const wxString & desc
311    );
312    %Docstring
313        SetOperatingSystemDescription(desc)
314
315        Sets the operating system description associated with this
316        wxPlatformInfo instance.
317    %End
318
319    void SetDesktopEnvironment(
320        const wxString & de
321    );
322    %Docstring
323        SetDesktopEnvironment(de)
324
325        Sets the desktop environment associated with this wxPlatformInfo
326        instance.
327    %End
328
329    void SetLinuxDistributionInfo(
330        const wxLinuxDistributionInfo & di
331    );
332    %Docstring
333        SetLinuxDistributionInfo(di)
334
335        Sets the linux distribution info associated with this wxPlatformInfo
336        instance.
337    %End
338
339    bool CheckOSVersion(
340        int major,
341        int minor
342    ) const;
343    %Docstring
344        CheckOSVersion(major, minor) -> bool
345
346        Returns true if the OS version is at least major.minor.
347    %End
348
349    bool CheckToolkitVersion(
350        int major,
351        int minor
352    ) const;
353    %Docstring
354        CheckToolkitVersion(major, minor) -> bool
355
356        Returns true if the toolkit version is at least major.minor.
357    %End
358
359    bool IsOk() const;
360    %Docstring
361        IsOk() -> bool
362
363        Returns true if this instance is fully initialized with valid values.
364    %End
365
366    bool IsUsingUniversalWidgets() const;
367    %Docstring
368        IsUsingUniversalWidgets() -> bool
369
370        Returns true if this wxPlatformInfo describes wxUniversal build.
371    %End
372
373    bool operator!=(
374        const wxPlatformInfo & t
375    ) const;
376
377    bool operator==(
378        const wxPlatformInfo & t
379    ) const;
380
381    static
382    const wxPlatformInfo & Get();
383    %Docstring
384        Get() -> PlatformInfo
385
386        Returns the global wxPlatformInfo object, initialized with the values
387        for the currently running platform.
388    %End
389
390    public:
391
392
393    %Property(name=ArchName, get=GetArchName)
394    %Property(name=Architecture, get=GetArchitecture, set=SetArchitecture)
395    %Property(name=DesktopEnvironment, get=GetDesktopEnvironment, set=SetDesktopEnvironment)
396    %Property(name=Endianness, get=GetEndianness, set=SetEndianness)
397    %Property(name=EndiannessName, get=GetEndiannessName)
398    %Property(name=LinuxDistributionInfo, get=GetLinuxDistributionInfo, set=SetLinuxDistributionInfo)
399    %Property(name=OSMajorVersion, get=GetOSMajorVersion)
400    %Property(name=OSMinorVersion, get=GetOSMinorVersion)
401    %Property(name=OperatingSystemDescription, get=GetOperatingSystemDescription, set=SetOperatingSystemDescription)
402    %Property(name=OperatingSystemFamilyName, get=GetOperatingSystemFamilyName)
403    %Property(name=OperatingSystemId, get=GetOperatingSystemId, set=SetOperatingSystemId)
404    %Property(name=OperatingSystemIdName, get=GetOperatingSystemIdName)
405    %Property(name=PortId, get=GetPortId, set=SetPortId)
406    %Property(name=PortIdName, get=GetPortIdName)
407    %Property(name=PortIdShortName, get=GetPortIdShortName)
408    %Property(name=ToolkitMajorVersion, get=GetToolkitMajorVersion)
409    %Property(name=ToolkitMinorVersion, get=GetToolkitMinorVersion)
410};  // end of class wxPlatformInfo
411
412
413struct wxLinuxDistributionInfo
414{
415    %Docstring
416        A structure containing information about a Linux distribution as
417        returned by the lsb_release utility.
418    %End
419    %TypeHeaderCode
420        #include <wx/platinfo.h>
421    %End
422
423    wxString Id;
424
425    wxString Release;
426
427    wxString CodeName;
428
429    wxString Description;
430
431    bool operator==(
432        const wxLinuxDistributionInfo & ldi
433    ) const;
434
435    bool operator!=(
436        const wxLinuxDistributionInfo & ldi
437    ) const;
438
439};  // end of class wxLinuxDistributionInfo
440
441
442
443//---------------------------------------------------------------------------
444
445