2008-03-08 08:52:38 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: module.h
|
2008-03-10 11:24:38 -04:00
|
|
|
// Purpose: interface of wxModule
|
2008-03-08 08:52:38 -05:00
|
|
|
// Author: wxWidgets team
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Licence: wxWindows license
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
/**
|
|
|
|
@class wxModule
|
|
|
|
@wxheader{module.h}
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
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.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
To define a new kind of module, derive a class from wxModule, override the
|
2008-03-08 09:43:31 -05:00
|
|
|
wxModule::OnInit and wxModule::OnExit
|
2008-03-08 08:52:38 -05:00
|
|
|
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.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
Note that your module class does not have to be in a header file.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
For example:
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@code
|
|
|
|
// A module to allow DDE initialization/cleanup
|
|
|
|
// without calling these functions from app.cpp or from
|
|
|
|
// the user's application.
|
|
|
|
class wxDDEModule: public wxModule
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxDDEModule() { }
|
|
|
|
virtual bool OnInit() { wxDDEInitialize(); return @true; };
|
|
|
|
virtual void OnExit() { wxDDECleanUp(); };
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
private:
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxDDEModule)
|
|
|
|
};
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
IMPLEMENT_DYNAMIC_CLASS(wxDDEModule, wxModule)
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
// Another module which uses DDE in its OnInit()
|
|
|
|
class MyModule: public wxModule
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
MyModule() { AddDependency(CLASSINFO(wxDDEModule)); }
|
|
|
|
virtual bool OnInit() { ... code using DDE ... }
|
|
|
|
virtual void OnExit() { ... }
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
private:
|
|
|
|
DECLARE_DYNAMIC_CLASS(MyModule)
|
|
|
|
};
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
IMPLEMENT_DYNAMIC_CLASS(MyModule, wxModule)
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
// Another module which uses DDE in its OnInit()
|
|
|
|
// but uses a named dependency
|
|
|
|
class MyModule2: public wxModule
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
MyModule2() { AddDependency("wxDDEModule"); }
|
|
|
|
virtual bool OnInit() { ... code using DDE ... }
|
|
|
|
virtual void OnExit() { ... }
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
private:
|
|
|
|
DECLARE_DYNAMIC_CLASS(MyModule2)
|
|
|
|
};
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
IMPLEMENT_DYNAMIC_CLASS(MyModule2, wxModule)
|
|
|
|
@endcode
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@library{wxbase}
|
|
|
|
@category{FIXME}
|
|
|
|
*/
|
|
|
|
class wxModule : public wxObject
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
Constructs a wxModule object.
|
|
|
|
*/
|
|
|
|
wxModule();
|
|
|
|
|
|
|
|
/**
|
|
|
|
Destructor.
|
|
|
|
*/
|
|
|
|
~wxModule();
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
2008-03-09 08:33:59 -04:00
|
|
|
Call this function from the constructor of the derived class. @a dep must be
|
2008-03-10 11:24:38 -04:00
|
|
|
the CLASSINFO() of a wxModule-derived class and the
|
2008-03-08 08:52:38 -05:00
|
|
|
corresponding module will be loaded before and unloaded after
|
|
|
|
this module.
|
|
|
|
The second version of this function allows a dependency to be added by
|
|
|
|
name without access to the class info. This is useful when a module is
|
|
|
|
declared entirely in a source file and there is no header for the declaration
|
2008-03-10 11:24:38 -04:00
|
|
|
of the module needed by CLASSINFO(), however errors are
|
2008-03-08 08:52:38 -05:00
|
|
|
not detected until run-time, instead of compile-time, then.
|
|
|
|
Note that circular dependencies are detected and result in a fatal error.
|
|
|
|
|
2008-03-08 09:43:31 -05:00
|
|
|
@param dep
|
2008-03-09 08:33:59 -04:00
|
|
|
The class information object for the dependent module.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param classname
|
2008-03-09 08:33:59 -04:00
|
|
|
The class name of the dependent module.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2008-03-09 08:33:59 -04:00
|
|
|
void AddDependency(wxClassInfo* dep);
|
|
|
|
void AddDependency(const char* classname);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
/**
|
|
|
|
Provide this function with appropriate cleanup for your module.
|
|
|
|
*/
|
|
|
|
virtual void OnExit();
|
|
|
|
|
|
|
|
/**
|
|
|
|
Provide this function with appropriate initialization for your module. If the
|
|
|
|
function
|
|
|
|
returns @false, wxWidgets will exit immediately.
|
|
|
|
*/
|
|
|
|
virtual bool OnInit();
|
|
|
|
};
|
2008-03-10 11:24:38 -04:00
|
|
|
|