typo

[wxWidgets.git] / docs / latex / wx / platinfo.tex

diff --git a/docs/latex/wx/platinfo.tex b/docs/latex/wx/platinfo.tex
index 60d5c2a69d940b4dcf20d4e181b572b5e75593f9..e44d4d1a661c99620580fd268200aeb380714eed 100644 (file)
--- a/docs/latex/wx/platinfo.tex
+++ b/docs/latex/wx/platinfo.tex
@@ -20,7 +20,11 @@ is running under and some basic architecture info of the machine where it's runn
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<include/wx/platinfo.h>
+<wx/platinfo.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -92,7 +96,8 @@ enum wxPortId
     wxPORT_MAC      = 1 << 7,       // wxMac, using Carbon or Classic Mac API
     wxPORT_COCOA    = 1 << 8,       // wxCocoa, using Cocoa NextStep/Mac API
     wxPORT_WINCE    = 1 << 9,       // wxWinCE, toolkit is WinCE SDK API
     wxPORT_MAC      = 1 << 7,       // wxMac, using Carbon or Classic Mac API
     wxPORT_COCOA    = 1 << 8,       // wxCocoa, using Cocoa NextStep/Mac API
     wxPORT_WINCE    = 1 << 9,       // wxWinCE, toolkit is WinCE SDK API

-    wxPORT_PALMOS   = 1 << 10       // wxPalmOS, toolkit is PalmOS API
+    wxPORT_PALMOS   = 1 << 10,      // wxPalmOS, toolkit is PalmOS API
+    wxPORT_DFB      = 1 << 11       // wxDFB, using wxUniversal

 };
 \end{verbatim}
 
 };
 \end{verbatim}
 


@@ -135,6 +140,8 @@ enum wxEndianness
 \func{}{wxPlatformInfo}{}
 
 Initializes the instance with the values corresponding to the currently running platform.
 \func{}{wxPlatformInfo}{}
 
 Initializes the instance with the values corresponding to the currently running platform.

+This is a fast operation because it only requires to copy the values internally cached for the
+currently running platform (see also \helpref{Get}{wxplatforminfoget}).

 
 \func{}{wxPlatformInfo}{\param{wxPortId }{pid = wxPORT\_UNKNOWN}, \param{int }{tkMajor = -1}, \param{int }{tkMinor = -1}, \param{wxOperatingSystemId }{id = wxOS\_UNKNOWN}, \param{int }{osMajor = -1}, \param{int }{osMinor = -1}, \param{wxArchitecture }{arch = wxARCH\_INVALID}, \param{wxEndianness }{endian = wxENDIAN\_INVALID}}
 
 
 \func{}{wxPlatformInfo}{\param{wxPortId }{pid = wxPORT\_UNKNOWN}, \param{int }{tkMajor = -1}, \param{int }{tkMinor = -1}, \param{wxOperatingSystemId }{id = wxOS\_UNKNOWN}, \param{int }{osMajor = -1}, \param{int }{osMinor = -1}, \param{wxArchitecture }{arch = wxARCH\_INVALID}, \param{wxEndianness }{endian = wxENDIAN\_INVALID}}
 


@@ -142,6 +149,39 @@ 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::Get}\label{wxplatforminfoget}
+
+\func{static const wxPlatformInfo\& }{Get}{\void}
+
+Returns the global wxPlatformInfo object, initialized with the values for the currently running platform.
+

 
 \membersection{wxPlatformInfo::GetArch}\label{wxplatforminfogetarch}
 
 
 \membersection{wxPlatformInfo::GetArch}\label{wxplatforminfogetarch}
 


@@ -202,14 +242,24 @@ Returns the name for the endianness of this wxPlatformInfo instance.
 
 \constfunc{int}{GetOSMajorVersion}{\void}
 
 
 \constfunc{int}{GetOSMajorVersion}{\void}
 

-Returns the major version of the OS associated with this wxPlatformInfo instance.
+Returns the run-time major version of the OS associated with this wxPlatformInfo instance.
+See \helpref{wxGetOsVersion}{wxgetosversion} for more info.
+
+\wxheading{See also}
+
+\helpref{CheckOSVersion}{wxplatforminfocheckosversion}
+

 
 \membersection{wxPlatformInfo::GetOSMinorVersion}\label{wxplatforminfogetosminorversion}
 
 \constfunc{int}{GetOSMinorVersion}{\void}
 
 
 \membersection{wxPlatformInfo::GetOSMinorVersion}\label{wxplatforminfogetosminorversion}
 
 \constfunc{int}{GetOSMinorVersion}{\void}
 

-Returns the minor version of the OS associated with this wxPlatformInfo instance.
+Returns the run-time minor version of the OS associated with this wxPlatformInfo instance.
+See \helpref{wxGetOsVersion}{wxgetosversion} for more info.

 
 

+\wxheading{See also}
+
+\helpref{CheckOSVersion}{wxplatforminfocheckosversion}

 
 
 
 
 
 


@@ -271,10 +321,13 @@ Returns the wxWidgets port ID associated with this wxPlatformInfo instance.
 
 \membersection{wxPlatformInfo::GetPortIdName}\label{wxplatforminfogetportidname}
 
 
 \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 \arg{usingUniversal}
+argument specifies whether the port is in its native or wxUniversal variant.

 
 

-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.
+The returned string always starts with the "wx" prefix and is a mixed-case
+string.

 
 \constfunc{wxString}{GetPortIdName}{\void}
 
 
 \constfunc{wxString}{GetPortIdName}{\void}
 


@@ -285,10 +338,14 @@ Returns the name of the wxWidgets port ID associated with this wxPlatformInfo in
 
 \membersection{wxPlatformInfo::GetPortIdShortName}\label{wxplatforminfogetportidshortname}
 
 
 \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 returned string does not start with
-the "wx" prefix and is always lower case.
+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.
+
+The returned string does not start with the "wx" prefix and is always lower
+case.

 
 \constfunc{wxString}{GetPortIdShortName}{\void}
 
 
 \constfunc{wxString}{GetPortIdShortName}{\void}
 


@@ -301,15 +358,29 @@ Returns the short name of the wxWidgets port ID associated with this wxPlatformI
 
 \constfunc{int}{GetToolkitMajorVersion}{\void}
 
 
 \constfunc{int}{GetToolkitMajorVersion}{\void}
 

-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.
+Returns the run-time major version of the toolkit associated with this wxPlatformInfo instance.
+Note that if \helpref{GetPortId}{wxplatforminfogetportid} returns wxPORT\_BASE, then this value is zero (unless externally modified with \helpref{SetToolkitVersion}{wxplatforminfosettoolkitversion}); that is, no native toolkit is in use.
+
+See \helpref{wxAppTraits::GetToolkitVersion}{wxapptraitsgettoolkitversion} for more info.
+
+
+\wxheading{See also}
+
+\helpref{CheckToolkitVersion}{wxplatforminfochecktoolkitversion}
+

 
 \membersection{wxPlatformInfo::GetToolkitMinorVersion}\label{wxplatforminfogettoolkitminorversion}
 
 \constfunc{int}{GetToolkitMinorVersion}{\void}
 
 
 \membersection{wxPlatformInfo::GetToolkitMinorVersion}\label{wxplatforminfogettoolkitminorversion}
 
 \constfunc{int}{GetToolkitMinorVersion}{\void}
 

-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.
+Returns the run-time minor version of the toolkit associated with this wxPlatformInfo instance.
+Note that if \helpref{GetPortId}{wxplatforminfogetportid} returns wxPORT\_BASE, then this value is zero (unless externally modified with \helpref{SetToolkitVersion}{wxplatforminfosettoolkitversion}); that is, no native toolkit is in use.
+
+See \helpref{wxAppTraits::GetToolkitVersion}{wxapptraitsgettoolkitversion} for more info.
+
+\wxheading{See also}
+
+\helpref{CheckToolkitVersion}{wxplatforminfochecktoolkitversion}

 
 
 
 
 
 


@@ -324,10 +395,9 @@ Returns \true if this instance is fully initialized with valid values.
 
 \membersection{wxPlatformInfo::IsUsingUniversalWidgets}\label{wxplatforminfoisusinguniversalwidgets}
 
 
 \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}
 
 
 \membersection{wxPlatformInfo::SetArchitecture}\label{wxplatforminfosetarchitecture}