wxPlatformInfo

wxPlatformInfo

This class holds informations about the operating system and the toolkit that the application is running under and some basic architecture info of the machine where it's running.

The following are the operating systems which are recognized by wxWidgets and whose version can be detected at run-time. The values of the constants are chosen so that they can be combined as flags; this allows to check for operating system families like e.g. wxOS_MAC and wxOS_UNIX.

The list of wxWidgets ports. Some of them can be used with more than a single (native) toolkit; e.g. wxWinCE port sources can be used with smartphones, pocket PCs and handheld devices SDKs.

The architecture of the operating system (regardless of the build environment of wxWidgets library - see is_platform_64bit documentation for more info).

The endian-ness of the machine.

Functions/Procedures
Supertopics

wxPlatformInfo

[func]
check_os_version
( atom major, atom minor )

Category: wxPlatformInfo

Returns true if the OS version is at least major.minor.


wxPlatformInfo

[func]
check_toolkit_version
( atom major, atom minor )

Category: wxPlatformInfo

Returns true if the toolkit version is at least major.minor.


wxPlatformInfo

[func]
get_arch
()

Category: wxPlatformInfo

Converts the given string to a wxArchitecture enum value or to wxARCH_INVALID if the given string is not a valid architecture string (i.e. does not contain nor 32 nor 64 strings).


wxPlatformInfo

[func]
get_arch_from_name
( object arch )

Category: wxPlatformInfo

Converts the given string to a wxArchitecture enum value or to wxARCH_INVALID if the given string is not a valid architecture string (i.e. does not contain nor 32 nor 64 strings).


wxPlatformInfo

[func]
get_arch_name
()

Category: wxPlatformInfo

Returns the name for the architecture of this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_arch_name_from_enum
( atom arch )

Category: wxPlatformInfo

Returns the name for the given wxArchitecture enumeration value.


wxPlatformInfo

[func]
get_endianness
()

Category: wxPlatformInfo

Returns the endianness ID of this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_endianness_from_name
( object endian )

Category: wxPlatformInfo

Converts the given string to a wxEndianness enum value or to wxENDIAN_INVALID if the given string is not a valid endianness string (i.e. does not contain nor little nor big strings).


wxPlatformInfo

[func]
get_endianness_name
()

Category: wxPlatformInfo

Returns the name for the endianness of this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_endianness_name_from_enum
( atom endian )

Category: wxPlatformInfo

Returns name for the given wxEndianness enumeration value.


wxPlatformInfo

[func]
get_os_family_name
()

Category: wxPlatformInfo

Returns the operating system family name of the OS associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_os_family_name_from_enum
( atom os )

Category: wxPlatformInfo

Returns the operating system family name for the given wxOperatingSystemId enumeration value: Unix for wxOS_UNIX, Macintosh for wxOS_MAC, Windows for wxOS_WINDOWS, DOS for wxOS_DOS, OS/2 for wxOS_OS2.


wxPlatformInfo

[func]
get_os_id
()

Category: wxPlatformInfo

Returns the operating system ID of this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_os_id_from_name
( object os )

Category: wxPlatformInfo

Converts the given string to a wxOperatingSystemId enum value or to wxOS_UNKNOWN if the given string is not a valid operating system name.


wxPlatformInfo

[func]
get_os_id_name
()

Category: wxPlatformInfo

Returns the operating system name of the OS associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_os_id_name_from_enum
( atom os )

Category: wxPlatformInfo

Returns the name for the given operating system ID value. This can be a long name (e.g. Microsoft Windows NT); use get_os_family_name to retrieve a short, generic name.


wxPlatformInfo

[func]
get_os_major_version
()

Category: wxPlatformInfo

Returns the run-time major version of the OS associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_os_minor_version
()

Category: wxPlatformInfo

Returns the run-time minor version of the OS associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_port_id
()

Category: wxPlatformInfo

Returns the wxWidgets port ID associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_port_id_from_name
( object portname )

Category: wxPlatformInfo

Converts the given string to a wxWidgets port ID value or to wxPORT_UNKNOWN if the given string does not match any of the wxWidgets canonical name ports ("wxGTK", "wxMSW", etc) nor any of the short wxWidgets name ports ("gtk", "msw", etc).


wxPlatformInfo

[func]
get_port_id_name
()

Category: wxPlatformInfo

Returns the name of the wxWidgets port ID associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_port_id_name_from_enum
( atom port, atom using_universal )

Category: wxPlatformInfo

Returns the name of the given wxWidgets port ID value. The using_universal argument specifies whether the port is in its native or wxUniversal variant.

The returned string always starts with the "wx" prefix and is a mixed-case string.


wxPlatformInfo

[func]
get_port_id_short_name
()

Category: wxPlatformInfo

Returns the short name of the wxWidgets port ID associated with this wxPlatformInfo instance.


wxPlatformInfo

[func]
get_port_id_short_name_from_enum
( atom port, atom using_universal )

Category: wxPlatformInfo

Returns the short name of the given wxWidgets port ID value. The using_universal argument specifies whether the port is in its native or wxUniversal variant.

The returned string does not start with the "wx" prefix and is always lower case.


wxPlatformInfo

[func]
get_toolkit_major_version
()

Category: wxPlatformInfo

Returns the run-time major version of the toolkit associated with this wxPlatformInfo instance. Note that if GetPortId returns wxPORT_BASE, then this value is zero; that is, no native toolkit is in use.


wxPlatformInfo

[func]
get_toolkit_minor_version
()

Category: wxPlatformInfo

Returns the run-time minor version of the toolkit associated with this wxPlatformInfo instance. Note that if GetPortId returns wxPORT_BASE, then this value is zero; that is, no native toolkit is in use.


wxPlatformInfo

[func]
platform_info_ok
()

Category: wxPlatformInfo

Returns true if this instance is fully initialized with valid values.


wxPlatformInfo

[func]
using_universal_widgets
()

Category: wxPlatformInfo

Returns true if this wxPlatformInfo describes wxUniversal build.