removed unneeded (after patch 1027243) disable.bmp

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

\section{\class{wxModule}}\label{wxmodule}

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
(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.

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}

\func{}{wxModule}{\void}

Constructs a wxModule object.

\membersection{wxModule::\destruct{wxModule}}

\func{}{\destruct{wxModule}}{\void}

Destructor.

\membersection{wxModule::CleanupModules}\label{wxmodulecleanupmodules}

\func{static void}{CleanupModules}{\void}

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}

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}

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}

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}

\func{virtual void}{OnExit}{\void}

Provide this function with appropriate cleanup for your module.

\membersection{wxModule::OnInit}\label{wxmoduleoninit}

\func{virtual bool}{OnInit}{\void}

Provide this function with appropriate initialization for your module. If the function
returns false, wxWidgets will exit immediately.

\membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule}

\func{static void}{RegisterModule}{\param{wxModule*}{ module}}

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}

Creates instances of and registers all modules. Called by wxWidgets on startup, so there is no
need for an application to call it.