define wxInvalidOffset properly (as wxFileOffset, not off_t)

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

diff --git a/docs/latex/wx/module.tex b/docs/latex/wx/module.tex
index 3bd382e9203389cd4aece1937bf23e833d3dc70b..42e38fd4fda724876242a22282d20fca6c4b8d40 100644 (file)
--- a/docs/latex/wx/module.tex
+++ b/docs/latex/wx/module.tex
@@ -1,19 +1,44 @@
 \section{\class{wxModule}}\label{wxmodule}
 
 \section{\class{wxModule}}\label{wxmodule}
 

-The module system is a very simple mechanism to allow applications (and parts of wxWindows itself) to
-define initialization and cleanup functions that are automatically called on wxWindows
+The module system is a very simple mechanism to allow applications (and parts of wxWidgets itself) to
+define initialization and cleanup functions that are automatically called on wxWidgets

 startup and exit.
 
 To define a new kind of module, derive a class from wxModule, override the OnInit and OnExit functions,
 and add the DECLARE\_DYNAMIC\_CLASS and IMPLEMENT\_DYNAMIC\_CLASS to header and implementation files
 startup and exit.
 
 To define a new kind of module, derive a class from wxModule, override the OnInit and OnExit functions,
 and add the DECLARE\_DYNAMIC\_CLASS and IMPLEMENT\_DYNAMIC\_CLASS to header and implementation files

-(which can be the same file). On initialization, wxWindows will find all classes derived from wxModule,
-create an instance of each, and call each OnInit function. On exit, wxWindows will call the OnExit
+(which can be the same file). On initialization, wxWidgets will find all classes derived from wxModule,
+create an instance of each, and call each OnInit function. On exit, wxWidgets will call the OnExit

 function for each module instance.
 
 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{Derived from}
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/module.h>
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxModule::wxModule}\label{wxmoduleconstr}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxModule::wxModule}\label{wxmoduleconstr}


@@ -32,33 +57,33 @@ Destructor.
 
 \func{static void}{CleanupModules}{\void}
 
 
 \func{static void}{CleanupModules}{\void}
 

-Calls Exit for each module instance. Called by wxWindows on exit, so there is no
+Calls Exit for each module instance. Called by wxWidgets on exit, so there is no

 need for an application to call it.
 
 \membersection{wxModule::Exit}\label{wxmoduleexit}
 
 \func{void}{Exit}{\void}
 
 need for an application to call it.
 
 \membersection{wxModule::Exit}\label{wxmoduleexit}
 
 \func{void}{Exit}{\void}
 

-Calls OnExit. This function is called by wxWindows and should not need to be called
+Calls OnExit. This function is called by wxWidgets and should not need to be called

 by an application.
 
 \membersection{wxModule::Init}\label{wxmoduleinit}
 
 \func{bool}{Init}{\void}
 
 by an application.
 
 \membersection{wxModule::Init}\label{wxmoduleinit}
 
 \func{bool}{Init}{\void}
 

-Calls OnInit. This function is called by wxWindows and should not need to be called
+Calls OnInit. This function is called by wxWidgets and should not need to be called

 by an application.
 
 \membersection{wxModule::InitializeModules}\label{wxmoduleinitializemodules}
 
 \func{static bool}{InitializeModules}{\void}
 
 by an application.
 
 \membersection{wxModule::InitializeModules}\label{wxmoduleinitializemodules}
 
 \func{static bool}{InitializeModules}{\void}
 

-Calls Init for each module instance. Called by wxWindows on startup, so there is no
+Calls Init for each module instance. Called by wxWidgets on startup, so there is no

 need for an application to call it.
 
 \membersection{wxModule::OnExit}\label{wxmoduleonexit}
 
 need for an application to call it.
 
 \membersection{wxModule::OnExit}\label{wxmoduleonexit}
 

-\func{virtual bool}{OnExit}{\void}
+\func{virtual void}{OnExit}{\void}

 
 Provide this function with appropriate cleanup for your module.
 
 
 Provide this function with appropriate cleanup for your module.
 


@@ -67,19 +92,19 @@ 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
 \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, wxWidgets will exit immediately.

 
 \membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule}
 
 \func{static void}{RegisterModule}{\param{wxModule*}{ module}}
 
 
 \membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule}
 
 \func{static void}{RegisterModule}{\param{wxModule*}{ module}}
 

-Registers this module with wxWindows. Called by wxWindows on startup, so there is no
+Registers this module with wxWidgets. Called by wxWidgets on startup, so there is no

 need for an application to call it.
 
 \membersection{wxModule::RegisterModules}\label{wxmoduleregistermodules}
 
 \func{static bool}{RegisterModules}{\void}
 
 need for an application to call it.
 
 \membersection{wxModule::RegisterModules}\label{wxmoduleregistermodules}
 
 \func{static bool}{RegisterModules}{\void}
 

-Creates instances of and registers all modules. Called by wxWindows on startup, so there is no
+Creates instances of and registers all modules. Called by wxWidgets on startup, so there is no

 need for an application to call it.
 
 need for an application to call it.