]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/platinfo.tex
[ 1564113 ] wxComboCtrl and wxODComboBox documentation update
[wxWidgets.git] / docs / latex / wx / platinfo.tex
index 60d5c2a69d940b4dcf20d4e181b572b5e75593f9..3edc674fe55caf61ddf00bdc0b491a8a1fa370bc 100644 (file)
@@ -142,6 +142,32 @@ Initializes the object using given values.
 
 
 
+\membersection{wxPlatformInfo::CheckOSVersion}\label{wxplatforminfocheckosversion}
+
+\constfunc{bool}{CheckOSVersion}{\param{int }{major}, \param{int }{minor}}
+
+Returns \true if the OS version is at least \texttt{major.minor}.
+
+\wxheading{See also}
+
+\helpref{GetOSMajorVersion}{wxplatforminfogetosmajorversion},
+\helpref{GetOSMinorVersion}{wxplatforminfogetosminorversion},
+\helpref{CheckToolkitVersion}{wxplatforminfochecktoolkitversion}
+
+
+\membersection{wxPlatformInfo::CheckToolkitVersion}\label{wxplatforminfochecktoolkitversion}
+
+\constfunc{bool}{CheckToolkitVersion}{\param{int }{major}, \param{int }{minor}}
+
+Returns \true if the toolkit version is at least \texttt{major.minor}.
+
+\wxheading{See also}
+
+\helpref{GetToolkitMajorVersion}{wxplatforminfogettoolkitmajorversion},
+\helpref{GetToolkitMinorVersion}{wxplatforminfogettoolkitminorversion},
+\helpref{CheckOSVersion}{wxplatforminfocheckosversion}
+
+
 
 \membersection{wxPlatformInfo::GetArch}\label{wxplatforminfogetarch}
 
@@ -204,12 +230,18 @@ Returns the name for the endianness of this wxPlatformInfo instance.
 
 Returns the major version of the OS associated with this wxPlatformInfo instance.
 
+\wxheading{See also}
+
+\helpref{CheckOSVersion}{wxplatforminfocheckosversion}
+
+
 \membersection{wxPlatformInfo::GetOSMinorVersion}\label{wxplatforminfogetosminorversion}
 
 \constfunc{int}{GetOSMinorVersion}{\void}
 
 Returns the minor version of the OS associated with this wxPlatformInfo instance.
 
+\helpref{CheckOSVersion}{wxplatforminfocheckosversion}
 
 
 
@@ -271,10 +303,13 @@ Returns the wxWidgets port ID associated with this wxPlatformInfo instance.
 
 \membersection{wxPlatformInfo::GetPortIdName}\label{wxplatforminfogetportidname}
 
-\func{static wxString}{GetPortIdName}{\param{wxPortId }{port}}
+\func{static wxString}{GetPortIdName}{\param{wxPortId }{port}, \param{bool }{usingUniversal}}
 
-Returns the name of the given wxWidgets port ID value. The returned string always starts with
-the "wx" prefix and is a mixed-case string.
+Returns the name of the given wxWidgets port ID value. The \arg{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.
 
 \constfunc{wxString}{GetPortIdName}{\void}
 
@@ -285,10 +320,14 @@ Returns the name of the wxWidgets port ID associated with this wxPlatformInfo in
 
 \membersection{wxPlatformInfo::GetPortIdShortName}\label{wxplatforminfogetportidshortname}
 
-\func{static wxString}{GetPortIdShortName}{\param{wxPortId }{port}}
+\func{static wxString}{GetPortIdShortName}{\param{wxPortId }{port}, \param{bool }{usingUniversal}}
+
+Returns the short name of the given wxWidgets port ID value. The
+\arg{usingUniversal} argument specifies whether the port is in its native or
+wxUniversal variant.
 
-Returns the short name of the given wxWidgets port ID value. The returned string does not start with
-the "wx" prefix and is always lower case.
+The returned string does not start with the "wx" prefix and is always lower
+case.
 
 \constfunc{wxString}{GetPortIdShortName}{\void}
 
@@ -304,6 +343,11 @@ Returns the short name of the wxWidgets port ID associated with this wxPlatformI
 Returns the major version of the toolkit associated with this wxPlatformInfo instance.
 Note that if {GetPortId}{wxplatforminfogetportid} returns wxPORT\_BASE, then this value is zero (unless externally modified with SetToolkitVersion); that is, no native toolkit is in use.
 
+\wxheading{See also}
+
+\helpref{CheckToolkitVersion}{wxplatforminfochecktoolkitversion}
+
+
 \membersection{wxPlatformInfo::GetToolkitMinorVersion}\label{wxplatforminfogettoolkitminorversion}
 
 \constfunc{int}{GetToolkitMinorVersion}{\void}
@@ -311,6 +355,10 @@ Note that if {GetPortId}{wxplatforminfogetportid} returns wxPORT\_BASE, then thi
 Returns the minor version of the toolkit associated with this wxPlatformInfo instance.
 Note that if {GetPortId}{wxplatforminfogetportid} returns wxPORT\_BASE, then this value is zero (unless externally modified with SetToolkitVersion); that is, no native toolkit is in use.
 
+\wxheading{See also}
+
+\helpref{CheckToolkitVersion}{wxplatforminfochecktoolkitversion}
+
 
 
 
@@ -324,10 +372,9 @@ Returns \true if this instance is fully initialized with valid values.
 
 \membersection{wxPlatformInfo::IsUsingUniversalWidgets}\label{wxplatforminfoisusinguniversalwidgets}
 
-\func{bool}{IsUsingUniversalWidgets}{\void}
+\constfunc{bool}{IsUsingUniversalWidgets}{\void}
 
-Returns \true if \_\_WXUNIVERSAL\_\_ symbol is defined. Note that this function always
-returns a constant value defined at compile-time and exists just for completeness.
+Returns \true if this wxPlatformInfo describes wxUniversal build.
 
 
 \membersection{wxPlatformInfo::SetArchitecture}\label{wxplatforminfosetarchitecture}