X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/14d63513822a9a91697508ecd37f95bac8af662e..c11420034872e991007a53f351fc24e49cc0519e:/docs/latex/wx/function.tex?ds=inline diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 5ab7cee273..b3230a5d8e 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1962,6 +1962,8 @@ See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. Ring the system bell. +Note that this function is categorized as a GUI one and so is not thread-safe. + \wxheading{Include files} @@ -2856,6 +2858,11 @@ The clipboard must have previously been opened for this call to succeed. \param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict},\\ \param{size\_t }{*posErr = \NULL}} +\func{wxMemoryBuffer}{wxBase64Decode}{\\ +\param{const wxString\& }{src},\\ +\param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict},\\ +\param{size\_t }{*posErr = \NULL}} + These function decode a Base64-encoded string. The first version is a raw decoding function and decodes the data into the provided buffer \arg{dst} of the given size \arg{dstLen}. An error is returned if the buffer is not large @@ -2878,7 +2885,8 @@ necessary buffer size.} \docparam{dstLen}{The size of the output buffer, ignored if \arg{dst} is \NULL.} -\docparam{src}{The input string, must not be \NULL.} +\docparam{src}{The input string, must not be \NULL. For the version using +wxString, the input string should contain only ASCII characters.} \docparam{srcLen}{The length of the input string or special value \texttt{wxNO\_LEN} if the string is \NUL-terminated and the length should be @@ -3364,7 +3372,7 @@ Returns the mouse position in screen coordinates. Returns the current state of the mouse. Returns a wxMouseState instance that contains the current position of the mouse pointer in -screen coordinants, as well as boolean values indicating the up/down +screen coordinates, as well as boolean values indicating the up/down status of the mouse buttons and the modifier keys. \wxheading{Include files} @@ -3419,8 +3427,8 @@ Returns label that should be used for given {\it id} element. \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} +useful for getting labels without accelerator char code like for toolbar tooltip or +on platforms without traditional keyboard like smartphones} \docparam{accelerator}{optional accelerator string automatically added to label; useful for building labels for \helpref{wxMenuItem}{wxmenuitem}}