X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6d98f9631aa3fbebb420cf8322cf7a75fc8e1db1..a9c98d7dd3a089e47a14369dcaf30a5e983079d5:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index dc8ef98b9d..b6de53e475 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -169,6 +169,7 @@ the corresponding topic. \helpref{wxGetenv}{wxgetenvmacro}\\ \helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions}\\ \helpref{wxICON}{wxiconmacro}\\ +\helpref{wxInfoMessageBox}{wxinfomessagebox}\\ \helpref{wxINTXX\_SWAP\_ALWAYS}{intswapalways}\\ \helpref{wxINTXX\_SWAP\_ON\_BE}{intswaponbe}\\ \helpref{wxINTXX\_SWAP\_ON\_LE}{intswaponle}\\ @@ -224,6 +225,7 @@ the corresponding topic. \helpref{wxRemoveFile}{wxremovefile}\\ \helpref{wxRenameFile}{wxrenamefile}\\ \helpref{wxRmdir}{wxrmdir}\\ +\helpref{wxS}{wxs}\\ \helpref{wxSafeShowMessage}{wxsafeshowmessage}\\ \helpref{wxSafeYield}{wxsafeyield}\\ \helpref{wxSetClipboardData}{wxsetclipboarddata}\\ @@ -1695,6 +1697,25 @@ Returns \true if the pointer is either {\tt NULL} or points to an empty string, \false otherwise. +\membersection{wxS}\label{wxs} + +\func{wxStringCharType}{wxS}{\param{char }{ch}} + +\func{const wxStringCharType *}{wxS}{\param{const char *}{s}} + +wxS is macro which can be used with character and string literals to either +convert them to wide characters or strings in \texttt{wchar\_t}-based Unicode +builds or keep them unchanged in UTF-8 builds. The use of this macro is +optional as the translation will always be done at run-time even if there is a +mismatch between the kind of the literal used and wxStringCharType used in the +current build, but using it can be beneficial in performance-sensitive code to +do the conversion at compile-time instead. + +\wxheading{See also} + +\helpref{wxT}{wxt} + + \membersection{::wxStrcmp}\label{wxstrcmp} \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}} @@ -2109,7 +2130,7 @@ customization. \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser} -\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}} +\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}, \param{wxColourData *}{data = \NULL}} Shows the colour selection dialog and returns the colour selected by user or invalid colour (use \helpref{wxColour:IsOk}{wxcolourisok} to test whether a colour @@ -2123,6 +2144,10 @@ is valid) if the dialog was cancelled. \docparam{caption}{If given, this will be used for the dialog caption.} +\docparam{data}{Optional object storing additional colour dialog settings, such +as custom colours. If none is provided the same settings as the last time are +used.} + \wxheading{Include files} @@ -2351,6 +2376,23 @@ and {\tt choices}, and the client data array must have the same length as the choices array.} +\membersection{::wxInfoMessageBox}\label{wxinfomessagebox} + +\func{void}{wxInfoMessageBox}{\param{wxWindow (}{parent = \NULL}} + +Shows a message box with the information about the wxWidgets build used, +including its version, most important build parameters and the version of the +underlying GUI toolkit. This is mainly used for diagnostic purposes and can be +invoked by Ctrl-Alt-middle clicking on any wxWindow which doesn't otherwise +handle this event. + +\newsince{2.9.0} + +\wxheading{Include files} + + + + \membersection{::wxIsBusy}\label{wxisbusy} \func{bool}{wxIsBusy}{\void} @@ -2969,6 +3011,26 @@ to \helpref{wxBase64Encode}{wxbase64encode}. This macro returns the concatenation of two tokens \arg{x} and \arg{y}. +\membersection{wxDECLARE\_APP}\label{wxdeclareapp} + +\func{}{wxDECLARE\_APP}{className} + +This is used in headers to create a forward declaration of the +\helpref{wxGetApp}{wxgetapp} function implemented by +\helpref{wxIMPLEMENT\_APP}{wximplementapp}. It creates the declaration +{\tt className\& wxGetApp(void)}. + +Example: + +\begin{verbatim} + wxDECLARE_APP(MyApp) +\end{verbatim} + +\wxheading{Include files} + + + + \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction} \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}