Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl

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

diff --git a/docs/latex/wx/module.tex b/docs/latex/wx/module.tex
index 8eee76aadfe2a3d8e41206315b0ac907e08b7cda..7d5e62dad0f8c62ebd4d3e351507fc59cc54502e 100644 (file)
--- a/docs/latex/wx/module.tex
+++ b/docs/latex/wx/module.tex
@@ -10,10 +10,35 @@ and add the DECLARE\_DYNAMIC\_CLASS and IMPLEMENT\_DYNAMIC\_CLASS to header and
 create an instance of each, and call each OnInit function. On exit, wxWindows will call the OnExit
 function for each module instance.
 
+Note that your module class does not have to be in a header file.
+
+For example:
+
+\begin{verbatim}
+  // A module to allow DDE initialization/cleanup
+  // without calling these functions from app.cpp or from
+  // the user's application.
+
+  class wxDDEModule: public wxModule
+  {
+  DECLARE_DYNAMIC_CLASS(wxDDEModule)
+  public:
+      wxDDEModule() {}
+      bool OnInit() { wxDDEInitialize(); return true; };
+      void OnExit() { wxDDECleanUp(); };
+  };
+
+  IMPLEMENT_DYNAMIC_CLASS(wxDDEModule, wxModule)
+\end{verbatim}
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/module.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxModule::wxModule}\label{wxmoduleconstr}
@@ -67,7 +92,7 @@ Provide this function with appropriate cleanup for your module.
 \func{virtual bool}{OnInit}{\void}
 
 Provide this function with appropriate initialization for your module. If the function
-returns FALSE, wxWindows will exit immediately.
+returns false, wxWindows will exit immediately.
 
 \membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule}