X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a24db82d6879160a2e31e8f87ffe18037998eb45..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/platinfo.tex diff --git a/docs/latex/wx/platinfo.tex b/docs/latex/wx/platinfo.tex index b1223be50b..e44d4d1a66 100644 --- 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{Library} + +\helpref{wxBase}{librarieslist} \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_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} @@ -135,6 +140,8 @@ enum wxEndianness \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}} @@ -144,7 +151,7 @@ Initializes the object using given values. \membersection{wxPlatformInfo::CheckOSVersion}\label{wxplatforminfocheckosversion} -\constfunc{bool}{CheckOSVersion}{\param{int major}, \param{int minor}} +\constfunc{bool}{CheckOSVersion}{\param{int }{major}, \param{int }{minor}} Returns \true if the OS version is at least \texttt{major.minor}. @@ -157,7 +164,7 @@ Returns \true if the OS version is at least \texttt{major.minor}. \membersection{wxPlatformInfo::CheckToolkitVersion}\label{wxplatforminfochecktoolkitversion} -\constfunc{bool}{CheckToolkitVersion}{\param{int major}, \param{int minor}} +\constfunc{bool}{CheckToolkitVersion}{\param{int }{major}, \param{int }{minor}} Returns \true if the toolkit version is at least \texttt{major.minor}. @@ -169,6 +176,13 @@ Returns \true if the toolkit version is at least \texttt{major.minor}. +\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}} @@ -228,7 +242,8 @@ Returns the name for the endianness of this wxPlatformInfo instance. \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} @@ -239,7 +254,10 @@ Returns the major version of the OS associated with this wxPlatformInfo instance \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} @@ -340,8 +358,11 @@ Returns the short name of the wxWidgets port ID associated with this wxPlatformI \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} @@ -352,8 +373,10 @@ Note that if {GetPortId}{wxplatforminfogetportid} returns wxPORT\_BASE, then thi \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}