| 1 | \section{\class{wxModule}}\label{wxmodule} |
| 2 | |
| 3 | The module system is a very simple mechanism to allow applications (and parts of wxWindows itself) to |
| 4 | define initialization and cleanup functions that are automatically called on wxWindows |
| 5 | startup and exit. |
| 6 | |
| 7 | To define a new kind of module, derive a class from wxModule, override the OnInit and OnExit functions, |
| 8 | and add the DECLARE\_DYNAMIC\_CLASS and IMPLEMENT\_DYNAMIC\_CLASS to header and implementation files |
| 9 | (which can be the same file). On initialization, wxWindows will find all classes derived from wxModule, |
| 10 | create an instance of each, and call each OnInit function. On exit, wxWindows will call the OnExit |
| 11 | function for each module instance. |
| 12 | |
| 13 | Note that your module class does not have to be in a header file. |
| 14 | |
| 15 | For example: |
| 16 | |
| 17 | \begin{verbatim} |
| 18 | // A module to allow DDE initialization/cleanup |
| 19 | // without calling these functions from app.cpp or from |
| 20 | // the user's application. |
| 21 | |
| 22 | class wxDDEModule: public wxModule |
| 23 | { |
| 24 | DECLARE_DYNAMIC_CLASS(wxDDEModule) |
| 25 | public: |
| 26 | wxDDEModule() {} |
| 27 | bool OnInit() { wxDDEInitialize(); return TRUE; }; |
| 28 | void OnExit() { wxDDECleanUp(); }; |
| 29 | }; |
| 30 | |
| 31 | IMPLEMENT_DYNAMIC_CLASS(wxDDEModule, wxModule) |
| 32 | \end{verbatim} |
| 33 | |
| 34 | \wxheading{Derived from} |
| 35 | |
| 36 | \helpref{wxObject}{wxobject} |
| 37 | |
| 38 | \wxheading{Include files} |
| 39 | |
| 40 | <wx/module.h> |
| 41 | |
| 42 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 43 | |
| 44 | \membersection{wxModule::wxModule}\label{wxmoduleconstr} |
| 45 | |
| 46 | \func{}{wxModule}{\void} |
| 47 | |
| 48 | Constructs a wxModule object. |
| 49 | |
| 50 | \membersection{wxModule::\destruct{wxModule}} |
| 51 | |
| 52 | \func{}{\destruct{wxModule}}{\void} |
| 53 | |
| 54 | Destructor. |
| 55 | |
| 56 | \membersection{wxModule::CleanupModules}\label{wxmodulecleanupmodules} |
| 57 | |
| 58 | \func{static void}{CleanupModules}{\void} |
| 59 | |
| 60 | Calls Exit for each module instance. Called by wxWindows on exit, so there is no |
| 61 | need for an application to call it. |
| 62 | |
| 63 | \membersection{wxModule::Exit}\label{wxmoduleexit} |
| 64 | |
| 65 | \func{void}{Exit}{\void} |
| 66 | |
| 67 | Calls OnExit. This function is called by wxWindows and should not need to be called |
| 68 | by an application. |
| 69 | |
| 70 | \membersection{wxModule::Init}\label{wxmoduleinit} |
| 71 | |
| 72 | \func{bool}{Init}{\void} |
| 73 | |
| 74 | Calls OnInit. This function is called by wxWindows and should not need to be called |
| 75 | by an application. |
| 76 | |
| 77 | \membersection{wxModule::InitializeModules}\label{wxmoduleinitializemodules} |
| 78 | |
| 79 | \func{static bool}{InitializeModules}{\void} |
| 80 | |
| 81 | Calls Init for each module instance. Called by wxWindows on startup, so there is no |
| 82 | need for an application to call it. |
| 83 | |
| 84 | \membersection{wxModule::OnExit}\label{wxmoduleonexit} |
| 85 | |
| 86 | \func{virtual void}{OnExit}{\void} |
| 87 | |
| 88 | Provide this function with appropriate cleanup for your module. |
| 89 | |
| 90 | \membersection{wxModule::OnInit}\label{wxmoduleoninit} |
| 91 | |
| 92 | \func{virtual bool}{OnInit}{\void} |
| 93 | |
| 94 | Provide this function with appropriate initialization for your module. If the function |
| 95 | returns FALSE, wxWindows will exit immediately. |
| 96 | |
| 97 | \membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule} |
| 98 | |
| 99 | \func{static void}{RegisterModule}{\param{wxModule*}{ module}} |
| 100 | |
| 101 | Registers this module with wxWindows. Called by wxWindows on startup, so there is no |
| 102 | need for an application to call it. |
| 103 | |
| 104 | \membersection{wxModule::RegisterModules}\label{wxmoduleregistermodules} |
| 105 | |
| 106 | \func{static bool}{RegisterModules}{\void} |
| 107 | |
| 108 | Creates instances of and registers all modules. Called by wxWindows on startup, so there is no |
| 109 | need for an application to call it. |
| 110 | |