X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/af266e5bf7e064ba818c1b1619325eb8c5b874f7..85136e3bf5dadf921652519e71da5db351fb3194:/docs/latex/wx/module.tex diff --git a/docs/latex/wx/module.tex b/docs/latex/wx/module.tex index 795746352d..92a4349df1 100644 --- a/docs/latex/wx/module.tex +++ b/docs/latex/wx/module.tex @@ -38,13 +38,30 @@ For example: class MyModule: public wxModule { public: - wxDDEModule() { AddDependency(CLASSINFO(wxDDEModule)); } + MyModule() { AddDependency(CLASSINFO(wxDDEModule)); } virtual bool OnInit() { ... code using DDE ... } virtual void OnExit() { ... } private: - DECLARE_DYNAMIC_CLASS(wxDDEModule) + DECLARE_DYNAMIC_CLASS(MyModule) + }; + + IMPLEMENT_DYNAMIC_CLASS(MyModule, wxModule) + + // Another module which uses DDE in its OnInit() + // but uses a named dependency + class MyModule2: public wxModule + { + public: + MyModule2() { AddDependency("wxDDEModule"); } + virtual bool OnInit() { ... code using DDE ... } + virtual void OnExit() { ... } + + private: + DECLARE_DYNAMIC_CLASS(MyModule2) }; + + IMPLEMENT_DYNAMIC_CLASS(MyModule2, wxModule) \end{verbatim} \wxheading{Derived from} @@ -55,6 +72,10 @@ For example: +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} @@ -72,21 +93,31 @@ Constructs a wxModule object. Destructor. -\membersection{wxModule::AddDependency}\label{wxmoduleoninit} +\membersection{wxModule::AddDependency}\label{wxmoduleadddependency} \func{void}{AddDependency}{\param{wxClassInfo * }{dep}} +\func{void}{AddDependency}{\param{const char * }{classname}} + Call this function from the constructor of the derived class. \arg{dep} must be the \helpref{CLASSINFO}{classinfo} of a wxModule-derived class and the corresponding module will be loaded \emph{before} and unloaded \emph{after} this module. +The second version of this function allows a dependency to be added by +name without access to the class info. This is useful when a module is +declared entirely in a source file and there is no header for the declaration +of the module needed by \helpref{CLASSINFO}{classinfo}, however errors are +not detected until run-time, instead of compile-time, then. + Note that circular dependencies are detected and result in a fatal error. \wxheading{Parameters} \docparam{dep}{The class information object for the dependent module.} +\docparam{classname}{The class name of the dependent module.} + \membersection{wxModule::OnExit}\label{wxmoduleonexit} @@ -101,3 +132,4 @@ Provide this function with appropriate cleanup for your module. Provide this function with appropriate initialization for your module. If the function returns false, wxWidgets will exit immediately. +