/////////////////////////////////////////////////////////////////////////////
// Name: platinfo.h
-// Purpose: documentation for wxPlatformInfo class
+// Purpose: interface of wxPlatformInfo
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxPlatformInfo
@wxheader{platinfo.h}
-
+
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.
-
+
@library{wxbase}
@category{FIXME}
-
- @seealso
- wxGetOSVersion, wxIsPlatformLittleEndian, wxIsPlatform64Bit, wxAppTraits
+
+ @see wxGetOSVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(),
+ wxAppTraits
*/
class wxPlatformInfo : public wxObject
{
Initializes the object using given values.
*/
wxPlatformInfo();
- wxPlatformInfo(wxPortId pid = wxPORT_UNKNOWN,
- int tkMajor = -1,
- int tkMinor = -1,
- wxOperatingSystemId id = wxOS_UNKNOWN,
- int osMajor = -1,
- int osMinor = -1,
- wxArchitecture arch = wxARCH_INVALID,
- wxEndianness endian = wxENDIAN_INVALID);
+ wxPlatformInfo(wxPortId pid = wxPORT_UNKNOWN,
+ int tkMajor = -1,
+ int tkMinor = -1,
+ wxOperatingSystemId id = wxOS_UNKNOWN,
+ int osMajor = -1,
+ int osMinor = -1,
+ wxArchitecture arch = wxARCH_INVALID,
+ wxEndianness endian = wxENDIAN_INVALID);
//@}
/**
Returns @true if the OS version is at least @c major.minor.
-
- @sa GetOSMajorVersion(), GetOSMinorVersion(),
- CheckToolkitVersion()
+
+ @see GetOSMajorVersion(), GetOSMinorVersion(),
+ CheckToolkitVersion()
*/
- bool CheckOSVersion(int major, int minor);
+ bool CheckOSVersion(int major, int minor) const;
/**
Returns @true if the toolkit version is at least @c major.minor.
-
- @sa GetToolkitMajorVersion(),
- GetToolkitMinorVersion(),
- CheckOSVersion()
+
+ @see GetToolkitMajorVersion(),
+ GetToolkitMinorVersion(), CheckOSVersion()
*/
- bool CheckToolkitVersion(int major, int minor);
+ bool CheckToolkitVersion(int major, int minor) const;
/**
Returns the global wxPlatformInfo object, initialized with the values for the
currently running platform.
*/
-#define static const wxPlatformInfo Get() /* implementation is private */
+ static const wxPlatformInfo Get();
/**
Converts the given string to a wxArchitecture enum value or to
/**
Returns the name for the architecture of this wxPlatformInfo instance.
*/
- static wxString GetArchName(wxArchitecture arch);
- wxString GetArchName();
+ static wxString GetArchName(wxArchitecture arch) const;
+ wxString GetArchName() const;
//@}
/**
Returns the architecture ID of this wxPlatformInfo instance.
*/
- wxArchitecture GetArchitecture();
+ wxArchitecture GetArchitecture() const;
//@{
/**
Returns the endianness ID of this wxPlatformInfo instance.
*/
- static wxEndianness GetEndianness(const wxString& end);
- wxEndianness GetEndianness();
+ static wxEndianness GetEndianness(const wxString& end) const;
+ wxEndianness GetEndianness() const;
//@}
//@{
/**
Returns the name for the endianness of this wxPlatformInfo instance.
*/
- static wxString GetEndiannessName(wxEndianness end);
- wxString GetEndiannessName();
+ static wxString GetEndiannessName(wxEndianness end) const;
+ wxString GetEndiannessName() const;
//@}
/**
Returns the run-time major version of the OS associated with this
wxPlatformInfo instance.
- See wxGetOsVersion for more info.
-
- @sa CheckOSVersion()
+ See wxGetOsVersion() for more info.
+
+ @see CheckOSVersion()
*/
- int GetOSMajorVersion();
+ int GetOSMajorVersion() const;
/**
Returns the run-time minor version of the OS associated with this
wxPlatformInfo instance.
- See wxGetOsVersion for more info.
-
- @sa CheckOSVersion()
+ See wxGetOsVersion() for more info.
+
+ @see CheckOSVersion()
*/
- int GetOSMinorVersion();
+ int GetOSMinorVersion() const;
//@{
/**
Returns the operating system family name of the OS associated with this
wxPlatformInfo instance.
*/
- static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
- wxString GetOperatingSystemFamilyName();
+ static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os) const;
+ wxString GetOperatingSystemFamilyName() const;
//@}
//@{
/**
Returns the operating system ID of this wxPlatformInfo instance.
*/
- static wxOperatingSystemId GetOperatingSystemId(const wxString& name);
- wxOperatingSystemId GetOperatingSystemId();
+ static wxOperatingSystemId GetOperatingSystemId(const wxString& name) const;
+ wxOperatingSystemId GetOperatingSystemId() const;
//@}
//@{
Returns the operating system name of the OS associated with this wxPlatformInfo
instance.
*/
- static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
- wxString GetOperatingSystemIdName();
+ static wxString GetOperatingSystemIdName(wxOperatingSystemId os) const;
+ wxString GetOperatingSystemIdName() const;
//@}
//@{
/**
Returns the wxWidgets port ID associated with this wxPlatformInfo instance.
*/
- static wxPortId GetPortId(const wxString& portname);
- wxPortId GetPortId();
+ static wxPortId GetPortId(const wxString& portname) const;
+ wxPortId GetPortId() const;
//@}
//@{
Returns the name of the wxWidgets port ID associated with this wxPlatformInfo
instance.
*/
- static wxString GetPortIdName(wxPortId port, bool usingUniversal);
- wxString GetPortIdName();
+ static wxString GetPortIdName(wxPortId port, bool usingUniversal) const;
+ wxString GetPortIdName() const;
//@}
//@{
wxPlatformInfo instance.
*/
static wxString GetPortIdShortName(wxPortId port,
- bool usingUniversal);
- wxString GetPortIdShortName();
+ bool usingUniversal) const;
+ wxString GetPortIdShortName() const;
//@}
/**
wxPlatformInfo instance.
Note that if GetPortId() returns wxPORT_BASE, then this value is zero (unless
externally modified with wxPlatformInfo::SetToolkitVersion); that is, no native toolkit is in use.
-
See wxAppTraits::GetToolkitVersion for more info.
-
- @sa CheckToolkitVersion()
+
+ @see CheckToolkitVersion()
*/
- int GetToolkitMajorVersion();
+ int GetToolkitMajorVersion() const;
/**
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 (unless
externally modified with wxPlatformInfo::SetToolkitVersion); that is, no native toolkit is in use.
-
See wxAppTraits::GetToolkitVersion for more info.
-
- @sa CheckToolkitVersion()
+
+ @see CheckToolkitVersion()
*/
- int GetToolkitMinorVersion();
+ int GetToolkitMinorVersion() const;
/**
Returns @true if this instance is fully initialized with valid values.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
/**
Returns @true if this wxPlatformInfo describes wxUniversal build.
*/
- bool IsUsingUniversalWidgets();
+ bool IsUsingUniversalWidgets() const;
/**
Sets the architecture enum value associated with this wxPlatformInfo instance.
/**
Inequality operator. Tests all class' internal variables.
*/
- bool operator!=(const wxPlatformInfo& t);
+ bool operator!=(const wxPlatformInfo& t) const;
/**
Equality operator. Tests all class' internal variables.
*/
- bool operator==(const wxPlatformInfo& t);
+ bool operator==(const wxPlatformInfo& t) const;
};
+
projects / wxWidgets.git / blobdiff