define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

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

diff --git a/docs/latex/wx/module.tex b/docs/latex/wx/module.tex
index 5df78e2e80f1969c58ceca00375ceb3d4a268360..b3f58fec88901a802bec61b65765e2a2cd003d95 100644 (file)
--- a/docs/latex/wx/module.tex
+++ b/docs/latex/wx/module.tex
@@ -1,13 +1,13 @@
 \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.
 
 Note that your module class does not have to be in a header file.
 function for each module instance.
 
 Note that your module class does not have to be in a header file.


@@ -24,7 +24,7 @@ For example:
   DECLARE_DYNAMIC_CLASS(wxDDEModule)
   public:
       wxDDEModule() {}
   DECLARE_DYNAMIC_CLASS(wxDDEModule)
   public:
       wxDDEModule() {}

-      bool OnInit() { wxDDEInitialize(); return TRUE; };
+      bool OnInit() { wxDDEInitialize(); return true; };

       void OnExit() { wxDDECleanUp(); };
   };
 
       void OnExit() { wxDDECleanUp(); };
   };
 


@@ -35,48 +35,24 @@ For example:
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

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

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

-\membersection{wxModule::wxModule}\label{wxmoduleconstr}
+\membersection{wxModule::wxModule}\label{wxmodulector}

 
 \func{}{wxModule}{\void}
 
 Constructs a wxModule object.
 
 
 \func{}{wxModule}{\void}
 
 Constructs a wxModule object.
 

-\membersection{wxModule::\destruct{wxModule}}
+\membersection{wxModule::\destruct{wxModule}}\label{wxmoduledtor}

 
 \func{}{\destruct{wxModule}}{\void}
 
 Destructor.
 
 
 \func{}{\destruct{wxModule}}{\void}
 
 Destructor.
 

-\membersection{wxModule::CleanupModules}\label{wxmodulecleanupmodules}
-
-\func{static void}{CleanupModules}{\void}
-
-Calls Exit for each module instance. Called by wxWindows on exit, so there is no
-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
-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
-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
-need for an application to call it.
-

 \membersection{wxModule::OnExit}\label{wxmoduleonexit}
 
 \func{virtual void}{OnExit}{\void}
 \membersection{wxModule::OnExit}\label{wxmoduleonexit}
 
 \func{virtual void}{OnExit}{\void}


@@ -88,19 +64,5 @@ 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.
-
-\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
-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
-need for an application to call it.
+returns false, wxWidgets will exit immediately.