X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8ea92b4d7792987769774ac381685dae15c70454..1a87edf286921de9b182f3d19adb6bb63ba85ebd:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 4d40bb80ab..c6808d5e65 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -108,6 +108,7 @@ the corresponding topic. \helpref{wxGetElapsedTime}{wxgetelapsedtime}\\ \helpref{wxGetEmailAddress}{wxgetemailaddress}\\ \helpref{wxGetEnv}{wxgetenv}\\ +\helpref{wxGetFileKind}{wxgetfilekind}\\ \helpref{wxGetFontFromUser}{wxgetfontfromuser}\\ \helpref{wxGetFreeMemory}{wxgetfreememory}\\ \helpref{wxGetFullHostName}{wxgetfullhostname}\\ @@ -683,7 +684,7 @@ enum wxKillError The {\it flags} parameter can be wxKILL\_NOCHILDREN (the default), or wxKILL\_CHILDREN, in which case the child processes of this process will be killed too. Note that under Unix, for wxKILL\_CHILDREN -to work you should have created the process by passing wxEXEC\_MAKE_GROUP\_LEADER +to work you should have created the process by passing wxEXEC\_MAKE\_GROUP\_LEADER to wxExecute. \wxheading{See also} @@ -1015,6 +1016,30 @@ Mac OS and generic Unix provided the system has {\tt statfs()} function. This function first appeared in wxWidgets 2.3.2. +\membersection{::wxGetFileKind}\label{wxgetfilekind} + +\func{wxFileKind}{wxGetFileKind}{\param{int }{fd}} + +\func{wxFileKind}{wxGetFileKind}{\param{FILE *}{fp}} + +Returns the type of an open file. Possible return values are: + +\begin{verbatim} +enum wxFileKind +{ + wxFILE_KIND_UNKNOWN, + wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets + wxFILE_KIND_TERMINAL, // a tty + wxFILE_KIND_PIPE // a pipe +}; + +\end{verbatim} + +\wxheading{Include files} + + + + \membersection{::wxGetOSDirectory}\label{wxgetosdirectory} \func{wxString}{wxGetOSDirectory}{\void} @@ -2829,10 +2854,10 @@ Gets the currently active window (Windows only). \func{wxBatteryState}{wxGetBatteryState}{\void} -Returns battery state as one of \texttt{wxBATTERY_NORMAL_STATE}, -\texttt{wxBATTERY_LOW_STATE}, \texttt{wxBATTERY_CRITICAL_STATE}, -\texttt{wxBATTERY_SHUTDOWN_STATE} or \texttt{wxBATTERY_UNKNOWN_STATE}. -\texttt{wxBATTERY_UNKNOWN_STATE} is also the default on platforms where +Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE}, +\texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE}, +\texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}. +\texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where this feature is not implemented. \wxheading{Include files} @@ -2855,9 +2880,9 @@ Under X only, returns the current display name. See also \helpref{wxSetDisplayNa \func{wxPowerType}{wxGetPowerType}{\void} -Returns the type of power source as one of \texttt{wxPOWER_SOCKET}, -\texttt{wxPOWER_BATTERY} or \texttt{wxPOWER_UNKNOWN}. -\texttt{wxPOWER_UNKNOWN} is also the default on platforms where this +Returns the type of power source as one of \texttt{wxPOWER\_SOCKET}, +\texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}. +\texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this feature is not implemented. \wxheading{Include files} @@ -2911,6 +2936,28 @@ See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxco +\membersection{::wxGetStockLabel}\label{wxgetstocklabel} + +\func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{wxString }{accelerator = wxEmptyString}} + +Returns label that should be used for given {\it id} element. + +\wxheading{Parameters} + +\docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.} + +\docparam{withCodes}{if false then strip accelerator code from the label; +usefull for getting labels without accelerator char code like for toolbar tooltip or +under platforms without traditional keyboard like smartphones} + +\docparam{accelerator}{optional accelerator string automatically added to label; useful +for building labels for \helpref{wxMenuItem}{wxmenuitem}} + +\wxheading{Include files} + + + + \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent} \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}