Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).

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

diff --git a/docs/latex/wx/module.tex b/docs/latex/wx/module.tex
index 795746352d0d8772e8b29db783c280f6981151d9..92a4349df140dad82073ca386e1463cd69f9f270 100644 (file)
--- a/docs/latex/wx/module.tex
+++ b/docs/latex/wx/module.tex
@@ -38,13 +38,30 @@ For example:
   class MyModule: public wxModule
   {
   public:
   class MyModule: public wxModule
   {
   public:

-      wxDDEModule() { AddDependency(CLASSINFO(wxDDEModule)); }
+      MyModule() { AddDependency(CLASSINFO(wxDDEModule)); }

       virtual bool OnInit() { ... code using DDE ... }
       virtual void OnExit() { ... }
 
   private:
       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}
 \end{verbatim}
 
 \wxheading{Derived from}


@@ -55,6 +72,10 @@ For example:
 
 <wx/module.h>
 
 
 <wx/module.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 


@@ -72,21 +93,31 @@ Constructs a wxModule object.
 Destructor.
 
 
 Destructor.
 
 

-\membersection{wxModule::AddDependency}\label{wxmoduleoninit}
+\membersection{wxModule::AddDependency}\label{wxmoduleadddependency}

 
 \func{void}{AddDependency}{\param{wxClassInfo * }{dep}}
 
 
 \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.
 
 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.}
 
 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}
 
 
 \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.
 
 Provide this function with appropriate initialization for your module. If the function
 returns false, wxWidgets will exit immediately.

+