X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/169948a05ff0707ecddc12f9e26d2a0a994fa0ae..751731864888f00e31e6dce1092ac28a1fac5358:/docs/latex/wx/dynlib.tex diff --git a/docs/latex/wx/dynlib.tex b/docs/latex/wx/dynlib.tex index c9da6923b0..61accb8f3d 100644 --- a/docs/latex/wx/dynlib.tex +++ b/docs/latex/wx/dynlib.tex @@ -6,7 +6,7 @@ %% Created: 14.01.02 (extracted from dllload.tex) %% RCS-ID: $Id$ %% Copyright: (c) Vadim Zeitlin -%% License: wxWindows license +%% License: wxWidgets license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxDynamicLibrary}}\label{wxdynamiclibrary} @@ -31,16 +31,16 @@ done in the objects destructor automatically. Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}. - \membersection{wxDynamicLibrary::CanonicalizeName}\label{wxdynamiclibrarycanonicalizename} -\func{wxString}{CanonicalizeName}{\param{const wxString\& }{name}, \param{wxDynamicLibraryCategory cat = wxDL\_LIBRARY}} +\func{wxString}{CanonicalizeName}{\param{const wxString\& }{name}, \param{wxDynamicLibraryCategory}{ cat = wxDL\_LIBRARY}} Returns the platform-specific full name for the library called \arg{name}. E.g. it adds a {\tt ".dll"} extension under Windows and {\tt "lib"} prefix and {\tt ".so"}, {\tt ".sl"} or maybe {\tt ".dylib"} extension under Unix. The possible values for \arg{cat} are: + \begin{twocollist} \twocolitem{wxDL\_LIBRARY}{normal library} \twocolitem{wxDL\_MODULE}{a loadable module or plugin} @@ -53,21 +53,21 @@ The possible values for \arg{cat} are: \membersection{wxDynamicLibrary::CanonicalizePluginName}\label{wxdynamiclibrarycanonicalizepluginname} -\func{wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory cat = wxDL\_PLUGIN\_GUI}} +\func{wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory}{ cat = wxDL\_PLUGIN\_GUI}} This function does the same thing as -\helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWindows +\helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWidgets plugins. The only difference is that compiler and version information are added to the name to ensure that the plugin which is going to be loaded will be compatible with the main program. The possible values for \arg{cat} are: + \begin{twocollist} \twocolitem{wxDL\_PLUGIN\_GUI}{plugin which uses GUI classes (default)} \twocolitem{wxDL\_PLUGIN\_BASE}{plugin which only uses wxBase} \end{twocollist} - \membersection{wxDynamicLibrary::Detach}\label{wxdynamiclibrarydetach} \func{wxDllType}{Detach}{\void} @@ -76,7 +76,6 @@ Detaches this object from its library handle, i.e. the object will not unload the library any longer in its destructor but it is now the callers responsability to do this using \helpref{Unload}{wxdynamiclibraryunload}. - \membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol} \constfunc{void*}{GetSymbol}{\param{const wxString\& }{name}} @@ -88,20 +87,19 @@ contains no such symbol. \helpref{wxDYNLIB\_FUNCTION}{wxdynlibfunction} - \membersection{wxDynamicLibrary::IsLoaded}\label{wxdynamiclibraryisloaded} \constfunc{bool}{IsLoaded}{\void} Returns \true if the library was successfully loaded, \false otherwise. - \membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload} \func{bool}{Load}{\param{const wxString\& }{name}, \param{int }{flags = wxDL\_DEFAULT}} Loads DLL with the given \arg{name} into memory. The \arg{flags} argument can be a combination of the following bits: + \begin{twocollist} \twocolitem{wxDL\_LAZY}{equivalent of RTLD\_LAZY under Unix, ignored elsewhere} \twocolitem{wxDL\_NOW}{equivalent of RTLD\_NOW under Unix, ignored elsewhere} @@ -112,11 +110,6 @@ the library name (this is done by default).} Returns \true if the library was successfully loaded, \false otherwise. -\wxheading{See also} - -\helpref{}{} - - \membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload} \func{void}{Unload}{\void}