X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..d9faa1fede04455b98de64001bcad46fa2061231:/interface/platinfo.h diff --git a/interface/platinfo.h b/interface/platinfo.h index 4f3d6a455b..17101b23c4 100644 --- a/interface/platinfo.h +++ b/interface/platinfo.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: platinfo.h -// Purpose: documentation for wxPlatformInfo class +// Purpose: interface of wxPlatformInfo // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,8 @@ @library{wxbase} @category{FIXME} - @seealso - wxGetOSVersion, wxIsPlatformLittleEndian, wxIsPlatform64Bit, wxAppTraits + @see wxGetOSVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(), + wxAppTraits */ class wxPlatformInfo : public wxObject { @@ -41,19 +41,19 @@ public: /** Returns @true if the OS version is at least @c major.minor. - + @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. - + @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 @@ -72,64 +72,64 @@ public: /** 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. - + 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. - + 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; //@} //@{ @@ -137,16 +137,16 @@ public: 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; //@} //@{ @@ -154,8 +154,8 @@ public: 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; //@} //@{ @@ -164,8 +164,8 @@ public: wxPlatformInfo instance. */ static wxString GetPortIdShortName(wxPortId port, - bool usingUniversal); - wxString GetPortIdShortName(); + bool usingUniversal) const; + wxString GetPortIdShortName() const; //@} /** @@ -174,10 +174,10 @@ public: 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. - + @see CheckToolkitVersion() */ - int GetToolkitMajorVersion(); + int GetToolkitMajorVersion() const; /** Returns the run-time minor version of the toolkit associated with this @@ -185,20 +185,20 @@ public: 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. - + @see CheckToolkitVersion() */ - int GetToolkitMinorVersion(); + int GetToolkitMinorVersion() const; /** Returns @true if this instance is fully initialized with valid values. */ - bool IsOk(); + 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. @@ -234,10 +234,11 @@ public: /** 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; }; +