toplevel code transferred to wxTopLevelWindow

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

diff --git a/docs/latex/wx/dllload.tex b/docs/latex/wx/dllload.tex
index dc4210e08dc98e00f1bd0a192efe64b7fe630729..9884c577ce2ba26c04ed72522c9cd29ba167aa66 100644 (file)
--- a/docs/latex/wx/dllload.tex
+++ b/docs/latex/wx/dllload.tex
@@ -17,11 +17,14 @@ loading of shared libraries and the resolving of symbols in them. There are no
 instances of this class, it simply serves as a namespace for its static member
 functions.
 
+Please note that class \helpref{wxDynamicLibrary}{wxdynamiclibrary} provides 
+alternative, friendlier interface to wxDllLoader.
+
 The terms {\it DLL} and {\it shared library/object} will both be used in the
 documentation to refer to the same thing: a {\tt .dll} file under Windows or 
 {\tt .so} or {\tt .sl} one under Unix.
 
-Example of using this class to dynamically load {\tt strlen()} function:
+Example of using this class to dynamically load the {\tt strlen()} function:
 
 \begin{verbatim}
 #if defined(__WXMSW__)
@@ -142,4 +145,48 @@ FALSE; may also be {\tt NULL}.}
 This function unloads the shared library. The handle {\it dllhandle} must have
 been returned by \helpref{LoadLibrary}{wxdllloaderloadlibrary} previously.
 
+\section{\class{wxDynamicLibrary}}\label{wxdynamiclibrary}
+
+wxDynamicLibrary is a class representing dynamically loadable library
+(Windows DLL, shared library under Unix etc.). It is implemented as a wrapper
+to \helpref{wxDllLoader}{wxdllloader}.
+
+\wxheading{See also}
+
+\helpref{wxDllLoader}{wxdllloader}
+
+\membersection{wxDynamicLibrary::wxDynamicLibrary}\label{wxdynamiclibrarywxdynamiclibrary}
+
+\func{}{wxDynamicLibrary}{\void}
+
+\func{}{wxDynamicLibrary}{\param{const wxString\& }{name}}
+
+Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}.
+
+\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}}
+
+Loads DLL into memory.
+
+Returns TRUE if the library was successfully loaded, FALSE otherwise.
+
+\membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload}
+
+\func{void}{Unload}{\void}
+
+Unloads the library from memory.
+
+\membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
+
+\constfunc{void*}{GetSymbol}{\param{const wxString\& }{name}}
+
+Returns pointer to symbol {\it name} in the library or NULL if the library
+contains no such symbol.