added missing \wxheading{Parameters}

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

diff --git a/docs/latex/wx/platinfo.tex b/docs/latex/wx/platinfo.tex
index 78d075fd89d7e5d1fd61e8413233e397242ab70d..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,13 +149,46 @@ 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}
 
 \func{static wxArchitecture}{GetArch}{\param{const wxString\& }{arch}}
 
 Converts the given string to a wxArchitecture enum value or to
 
 \membersection{wxPlatformInfo::GetArch}\label{wxplatforminfogetarch}
 
 \func{static wxArchitecture}{GetArch}{\param{const wxString\& }{arch}}
 
 Converts the given string to a wxArchitecture enum value or to

-wxARCH_INVALID if the given string is not a valid architecture string
+wxARCH\_INVALID if the given string is not a valid architecture string

 (i.e. does not contain nor {\tt 32} nor {\tt 64} strings).
 
 
 (i.e. does not contain nor {\tt 32} nor {\tt 64} strings).
 
 


@@ -177,7 +217,7 @@ Returns the architecture ID of this wxPlatformInfo instance.
 \func{static wxEndianness}{GetEndianness}{\param{const wxString\& }{end}}
 
 Converts the given string to a wxEndianness enum value or to
 \func{static wxEndianness}{GetEndianness}{\param{const wxString\& }{end}}
 
 Converts the given string to a wxEndianness enum value or to

-wxENDIAN_INVALID if the given string is not a valid endianness string
+wxENDIAN\_INVALID if the given string is not a valid endianness string

 (i.e. does not contain nor {\tt little} nor {\tt big} strings).
 
 \constfunc{wxEndianness}{GetEndianness}{\void}
 (i.e. does not contain nor {\tt little} nor {\tt big} strings).
 
 \constfunc{wxEndianness}{GetEndianness}{\void}


@@ -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}

 
 
 
 
 
 


@@ -218,8 +268,8 @@ Returns the minor version of the OS associated with this wxPlatformInfo instance
 \func{static wxString}{GetOperatingSystemFamilyName}{\param{wxOperatingSystemId }{os}}
 
 Returns the operating system family name for the given wxOperatingSystemId enumeration value:
 \func{static wxString}{GetOperatingSystemFamilyName}{\param{wxOperatingSystemId }{os}}
 
 Returns the operating system family name for the given wxOperatingSystemId enumeration value:

-{\tt Unix} for wxOS_UNIX, {\tt Macintosh} for wxOS_MAC, {\tt Windows} for wxOS_WINDOWS,
-{\tt DOS} for wxOS_DOS, {\tt OS/2} for wxOS_OS2.
+{\tt Unix} for wxOS\_UNIX, {\tt Macintosh} for wxOS\_MAC, {\tt Windows} for wxOS\_WINDOWS,
+{\tt DOS} for wxOS\_DOS, {\tt OS/2} for wxOS\_OS2.

 
 \constfunc{wxString}{GetOperatingSystemFamilyName}{\void}
 
 
 \constfunc{wxString}{GetOperatingSystemFamilyName}{\void}
 


@@ -232,7 +282,7 @@ Returns the operating system family name of the OS associated with this wxPlatfo
 \func{static wxOperatingSystemId}{GetOperatingSystemId}{\param{const wxString\& }{name}}
 
 Converts the given string to a wxOperatingSystemId enum value or to
 \func{static wxOperatingSystemId}{GetOperatingSystemId}{\param{const wxString\& }{name}}
 
 Converts the given string to a wxOperatingSystemId enum value or to

-wxOS_UNKNOWN if the given string is not a valid operating system name.
+wxOS\_UNKNOWN if the given string is not a valid operating system name.

 
 \constfunc{wxOperatingSystemId}{GetOperatingSystemId}{\void}
 
 
 \constfunc{wxOperatingSystemId}{GetOperatingSystemId}{\void}
 


@@ -261,7 +311,7 @@ Returns the operating system name of the OS associated with this wxPlatformInfo
 
 \func{static wxPortId}{GetPortId}{\param{const wxString\& }{portname}}
 
 
 \func{static wxPortId}{GetPortId}{\param{const wxString\& }{portname}}
 

-Converts the given string to a wxWidgets port ID value or to wxPORT_UNKNOWN if
+Converts the given string to a wxWidgets port ID value or to 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).
 
 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).
 


@@ -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}