csApplicationFramework Class Reference
[Application Framework]
Application framework class.
More...
#include <csapplicationframework.h>
Inheritance diagram for csApplicationFramework:

Public Methods | |
virtual | ~csApplicationFramework () |
Destructor. | |
operator iObjectRegistry * () | |
Allow a csApplicationFramework object to be used as an iObjectRegistry*. | |
bool | Open () |
Open plugins and open application window. | |
Static Public Methods | |
void | Quit (void) |
Quit running the appliation. | |
iObjectRegistry * | GetObjectRegistry () |
Returns a pointer to the object registry. | |
void | SetApplicationName (char *name) |
Set the application's string name identifier. | |
void | ProcessQueue () |
Start event queue. | |
bool | DisplayError (const char *description) |
Display an error notification. | |
void | DisplayInfo (const char *description) |
Display an information notification. | |
Protected Methods | |
csApplicationFramework () | |
Constructor. | |
virtual bool | OnInitialize (int argc, char *argv[])=0 |
Initialize the subclassed csApplicationFramework object. | |
virtual bool | Application ()=0 |
Perform application logic. | |
virtual void | OnExit () |
Perform any end of program processing. |
Detailed Description
Application framework class.
- Remarks:
-
In order to properly use this class, you must derive a class from it and provide a constructor and implementation for the OnInitialize() and Application() methods. You may only have one csApplicationFramework derived object in existence at any time (and generally, you will only have one such object in your application). The library containing the implementation of this class contains an implementation of the main() function that controls the use of this class. When using the csApplicationFramework class, do not provide your own implementation of main(). In your source code create a global instance of the overridden object, as follows:
// Example.h class myDerivedEngine : public csApplicationFramework { public: myDerivedEngine(); virtual bool OnInitialize(); virtual bool Application(); }; extern myDerivedEngine myApp; //-------------------------- // Example.cpp // File scope myDerivedEngine myApp; myDerivedEngine::myDerivedEngine() : myDerivedEngine() { SetApplicationName ("crystal.space.example.app"); } myDerivedEngine::OnIntialize() { // Request plugins, initialize any global non-CS data and structures return true; } myDerivedEngine::Application() { // Perform initialization of CS data and structures, set event handler, // load world, etc. if ( ! Open()) { return false; } ProcessQueue(); return true; }
This class is derived from csInitializer for convenience, allowing overridden members to call csInitializer methods without qualifying them with csInitializer::.
This class is not related to csApp or other classes related to the CSWS.
Definition at line 98 of file csapplicationframework.h.
Constructor & Destructor Documentation
|
Constructor.
|
|
Destructor.
|
Member Function Documentation
|
Perform application logic.
|
|
Display an error notification.
Definition at line 311 of file csapplicationframework.h. References CS_REPORTER_SEVERITY_ERROR, and csReport. |
|
Display an information notification.
Definition at line 325 of file csapplicationframework.h. References CS_REPORTER_SEVERITY_NOTIFY, and csReport. |
|
Returns a pointer to the object registry.
Definition at line 245 of file csapplicationframework.h. |
|
Perform any end of program processing. /remarks This method is called after the crystal space engine has been shut down, just before the framework is about to end the program. Unlike the other overridables of this class, you need not bother overriding this method. In general, this is provided to allow end of program debugging support. |
|
Initialize the subclassed csApplicationFramework object.
|
|
Open plugins and open application window.
Definition at line 260 of file csapplicationframework.h. References csInitializer::OpenApplication(). |
|
Allow a csApplicationFramework object to be used as an iObjectRegistry*.
Definition at line 255 of file csapplicationframework.h. |
|
Start event queue.
Definition at line 284 of file csapplicationframework.h. References csDefaultRunLoop(). |
|
Quit running the appliation.
|
|
Set the application's string name identifier.
Definition at line 274 of file csapplicationframework.h. |
The documentation for this class was generated from the following file:
- csappframe/csapplicationframework.h
Generated for Crystal Space by doxygen 1.2.18