Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

group wxPlatformInfo functions for easier browsing; add more descriptions; link the related function group

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60841 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2009-05-31 16:34:13 +00:00
parent 4b14a2f79b
commit 3b36f093d9
2 changed files with 161 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/groups/funcmacro_networkuseros.h
View File

@@ -14,7 +14,7 @@
The functions in this section are used to retrieve information about the
current computer and/or user characteristics.
Related class group: @ref group_class_net.
Related class group: @ref group_class_net, wxPlatformInfo.
*/

270
interface/wx/platinfo.h
View File

@@ -87,7 +87,7 @@ enum wxArchitecture
wxARCH_INVALID = -1, //!< returned on error
wxARCH_32, //!< 32 bit
wxARCH_64,
wxARCH_64, //!< 64 bit
wxARCH_MAX
};
@@ -111,15 +111,20 @@ enum wxEndianness
/**
@class 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.
This class holds informations about the operating system, the toolkit and the
basic architecture of the machine where the application is currently running.
This class does not only have @e getters for the informations above, it also has
@e setters. This allows you to e.g. save the current platform informations in a
data file (maybe in string form) so that when you later load it, you can easily
retrieve (see the static getters for string->enum conversion functions) the
signature of the system which generated it.
@library{wxbase}
@category{cfg}
@see ::wxGetOsVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(),
wxAppTraits
wxAppTraits, @ref group_funcmacro_networkuseros
*/
class wxPlatformInfo : public wxObject
{
@@ -165,12 +170,40 @@ public:
*/
bool CheckToolkitVersion(int major, int minor) const;
/**
Returns @true if this instance is fully initialized with valid values.
*/
bool IsOk() const;
/**
Returns @true if this wxPlatformInfo describes wxUniversal build.
*/
bool IsUsingUniversalWidgets() const;
/**
Inequality operator. Tests all class' internal variables.
*/
bool operator!=(const wxPlatformInfo& t) const;
/**
Equality operator. Tests all class' internal variables.
*/
bool operator==(const wxPlatformInfo& t) const;
/**
Returns the global wxPlatformInfo object, initialized with the values
for the currently running platform.
*/
static const wxPlatformInfo& Get();
/**
@name Static enum getters
These getters allow for easy string-to-enumeration-value conversion.
*/
//@{
/**
Converts the given string to a wxArchitecture enum value or to
@c wxARCH_INVALID if the given string is not a valid architecture string
@@ -178,21 +211,6 @@ public:
*/
static wxArchitecture GetArch(const wxString& arch);
/**
Returns the name for the given wxArchitecture enumeration value.
*/
static wxString GetArchName(wxArchitecture arch);
/**
Returns the name for the architecture of this wxPlatformInfo instance.
*/
wxString GetArchName() const;
/**
Returns the architecture ID of this wxPlatformInfo instance.
*/
wxArchitecture GetArchitecture() const;
/**
Converts the given string to a wxEndianness enum value or to
@c wxENDIAN_INVALID if the given string is not a valid endianness
@@ -201,9 +219,32 @@ public:
static wxEndianness GetEndianness(const wxString& end);
/**
Returns the endianness ID of this wxPlatformInfo instance.
Converts the given string to a wxOperatingSystemId enum value or to @c
wxOS_UNKNOWN if the given string is not a valid operating system name.
*/
wxEndianness GetEndianness() const;
static wxOperatingSystemId GetOperatingSystemId(const wxString& name);
/**
Converts the given string to a wxWidgets port ID value or to @c 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).
*/
static wxPortId GetPortId(const wxString& portname);
//@}
/**
@name Static string-form getters
These getters allow for easy enumeration-value-to-string conversion.
*/
//@{
/**
Returns the name for the given wxArchitecture enumeration value.
*/
static wxString GetArchName(wxArchitecture arch);
/**
Returns name for the given wxEndianness enumeration value.
@@ -211,9 +252,56 @@ public:
static wxString GetEndiannessName(wxEndianness end);
/**
Returns the name for the endianness of this wxPlatformInfo instance.
Returns the operating system family name for the given wxOperatingSystemId
enumeration value: @c Unix for @c wxOS_UNIX, @c Macintosh for @c wxOS_MAC,
@c Windows for @c wxOS_WINDOWS, @c DOS for @c wxOS_DOS, @c OS/2 for @c wxOS_OS2.
*/
wxString GetEndiannessName() const;
static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
/**
Returns the name for the given operating system ID value.
This can be a long name (e.g. <tt>Microsoft Windows NT</tt>);
use GetOperatingSystemFamilyName() to retrieve a short, generic name.
*/
static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
/**
Returns the name of the given wxWidgets port ID value.
The @a usingUniversal 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.
*/
static wxString GetPortIdName(wxPortId port, bool usingUniversal);
/**
Returns the short name of the given wxWidgets port ID value.
The @a usingUniversal 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.
*/
static wxString GetPortIdShortName(wxPortId port,
bool usingUniversal);
//@}
/**
@name Getters
*/
//@{
/**
Returns the architecture ID of this wxPlatformInfo instance.
*/
wxArchitecture GetArchitecture() const;
/**
Returns the endianness ID of this wxPlatformInfo instance.
*/
wxEndianness GetEndianness() const;
/**
Returns the run-time major version of the OS associated with this
@@ -231,88 +319,16 @@ public:
*/
int GetOSMinorVersion() const;
/**
Returns the operating system family name for the given wxOperatingSystemId
enumeration value: @c Unix for @c wxOS_UNIX, @c Macintosh for @c wxOS_MAC,
@c Windows for @c wxOS_WINDOWS, @c DOS for @c wxOS_DOS, @c OS/2 for @c wxOS_OS2.
*/
static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
/**
Returns the operating system family name of the OS associated with this
wxPlatformInfo instance.
*/
wxString GetOperatingSystemFamilyName() const;
/**
Converts the given string to a wxOperatingSystemId enum value or to @c
wxOS_UNKNOWN if the given string is not a valid operating system name.
*/
static wxOperatingSystemId GetOperatingSystemId(const wxString& name);
/**
Returns the operating system ID of this wxPlatformInfo instance.
*/
wxOperatingSystemId GetOperatingSystemId() const;
/**
Returns the name for the given operating system ID value.
This can be a long name (e.g. <tt>Microsoft Windows NT</tt>);
use GetOperatingSystemFamilyName() to retrieve a short, generic name.
*/
static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
/**
Returns the operating system name of the OS associated with this wxPlatformInfo
instance.
*/
wxString GetOperatingSystemIdName() const;
/**
Converts the given string to a wxWidgets port ID value or to @c 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).
*/
static wxPortId GetPortId(const wxString& portname);
/**
Returns the wxWidgets port ID associated with this wxPlatformInfo instance.
*/
wxPortId GetPortId() const;
/**
Returns the name of the given wxWidgets port ID value.
The @a usingUniversal 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.
*/
static wxString GetPortIdName(wxPortId port, bool usingUniversal);
/**
Returns the name of the wxWidgets port ID associated with this wxPlatformInfo
instance.
*/
wxString GetPortIdName() const;
/**
Returns the short name of the given wxWidgets port ID value.
The @a usingUniversal 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.
*/
static wxString GetPortIdShortName(wxPortId port,
bool usingUniversal);
/**
Returns the short name of the wxWidgets port ID associated with this
wxPlatformInfo instance.
*/
wxString GetPortIdShortName() const;
/**
Returns the run-time major version of the toolkit associated with this
wxPlatformInfo instance.
@@ -339,15 +355,56 @@ public:
*/
int GetToolkitMinorVersion() const;
/**
Returns @true if this instance is fully initialized with valid values.
*/
bool IsOk() const;
//@}
/**
Returns @true if this wxPlatformInfo describes wxUniversal build.
@name String-form getters
*/
bool IsUsingUniversalWidgets() const;
//@{
/**
Returns the name for the architecture of this wxPlatformInfo instance.
*/
wxString GetArchName() const;
/**
Returns the name for the endianness of this wxPlatformInfo instance.
*/
wxString GetEndiannessName() const;
/**
Returns the operating system family name of the OS associated with this
wxPlatformInfo instance.
*/
wxString GetOperatingSystemFamilyName() const;
/**
Returns the operating system name of the OS associated with this wxPlatformInfo
instance.
*/
wxString GetOperatingSystemIdName() const;
/**
Returns the name of the wxWidgets port ID associated with this wxPlatformInfo
instance.
*/
wxString GetPortIdName() const;
/**
Returns the short name of the wxWidgets port ID associated with this
wxPlatformInfo instance.
*/
wxString GetPortIdShortName() const;
//@}
/**
@name Setters
*/
//@{
/**
Sets the architecture enum value associated with this wxPlatformInfo instance.
@@ -380,14 +437,7 @@ public:
*/
void SetToolkitVersion(int major, int minor);
/**
Inequality operator. Tests all class' internal variables.
*/
bool operator!=(const wxPlatformInfo& t) const;
//@}
/**
Equality operator. Tests all class' internal variables.
*/
bool operator==(const wxPlatformInfo& t) const;
};