sorting support for generic version (patch 1765087 from Bo)

[wxWidgets.git] / docs / latex / wx / dynlib.tex

diff --git a/docs/latex/wx/dynlib.tex b/docs/latex/wx/dynlib.tex
index a47d026205d3df38b92a264704d9f7a313235714..8c15876b0cb2ab96ac8d7b334dbf02767a064f3b 100644 (file)
--- a/docs/latex/wx/dynlib.tex
+++ b/docs/latex/wx/dynlib.tex
@@ -16,12 +16,6 @@ wxDynamicLibrary is a class representing dynamically loadable library
 this class to load a library and don't worry about unloading it -- it will be
 done in the objects destructor automatically.
 
-% deprecated now...
-%
-%\wxheading{See also}
-%
-%\helpref{wxDllLoader}{wxdllloader}
-
 \wxheading{Derived from}
 
 No base class.
@@ -30,6 +24,10 @@ No base class.
 
 <wx/dynlib.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 (only available if \texttt{wxUSE\_DYNLIB\_CLASS} is set to $1$)
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -45,7 +43,7 @@ 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{static 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 
@@ -66,7 +64,7 @@ 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{static wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory}{ cat = wxDL\_PLUGIN\_GUI}}
 
 This function does the same thing as 
 \helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWidgets
@@ -88,7 +86,7 @@ The possible values for \arg{cat} are:
 
 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}.
+responsibility to do this using \helpref{Unload}{wxdynamiclibraryunload}.
 
 
 \membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
@@ -103,6 +101,27 @@ contains no such symbol.
 \helpref{wxDYNLIB\_FUNCTION}{wxdynlibfunction}
 
 
+\membersection{wxDynamicLibrary::GetSymbolAorW}\label{wxdynamiclibrarygetsymbolaorw}
+
+\constfunc{void *}{GetSymbolAorW}{\param{const wxString\& }{name}}
+
+This function is available only under Windows as it is only useful when
+dynamically loading symbols from standard Windows DLLs. Such functions have
+either \texttt{'A'} (in ANSI build) or \texttt{'W'} (in Unicode, or wide
+character build) suffix if they take string parameters. Using this function you
+can use just the base name of the function and the correct suffix is appende
+automatically depending on the current build. Otherwise, this method is
+identical to \helpref{GetSymbol}{wxdynamiclibrarygetsymbol}.
+
+
+\membersection{wxDynamicLibrary::GetProgramHandle}\label{wxdynamiclibrarygetprogramhandle}
+
+\func{static wxDllType}{GetProgramHandle}{\void}
+
+Return a valid handle for the main program itself or \texttt{NULL} if symbols
+from the main program can't be loaded on this platform.
+
+
 \membersection{wxDynamicLibrary::HasSymbol}\label{wxdynamiclibraryhassymbol}
 
 \constfunc{bool}{HasSymbol}{\param{const wxString\& }{name}}
@@ -128,7 +147,7 @@ Returns \true if the library was successfully loaded, \false otherwise.
 This static method returns an \helpref{array}{wxarray} containing the details
 of all modules loaded into the address space of the current project, the array
 elements are object of \texttt{wxDynamicLibraryDetails} class. The array will
-be empty if an error occured.
+be empty if an error occurred.
 
 This method is currently implemented only under Win32 and Linux and is useful
 mostly for diagnostics purposes.
@@ -147,6 +166,7 @@ be a combination of the following bits:
 \twocolitem{wxDL\_GLOBAL}{equivalent of RTLD\_GLOBAL under Unix, ignored elsewhere}
 \twocolitem{wxDL\_VERBATIM}{don't try to append the appropriate extension to
 the library name (this is done by default).}
+\twocolitem{wxDL\_DEFAULT}{default flags, same as wxDL\_NOW currently}
 \end{twocollist}
 
 Returns \true if the library was successfully loaded, \false otherwise.
@@ -184,6 +204,10 @@ No base class.
 
 <wx/dynlib.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 (only available if \texttt{wxUSE\_DYNLIB\_CLASS} is set to $1$)
 
 \latexignore{\rtfignore{\wxheading{Members}}}