Rocket::Core::Plugin Class Reference
#include <Plugin.h>
Inheritance diagram for Rocket::Core::Plugin:
Public Member Functions | |
| virtual void | OnInitialise () |
| virtual void | OnShutdown () |
| Called when Rocket shuts down. | |
| virtual void | OnContextCreate (Context *context) |
| Called when a new context is created. | |
| virtual void | OnContextDestroy (Context *context) |
| Called when a context is destroyed. | |
| virtual void | OnDocumentOpen (Context *context, const String &document_path) |
| Called when a document load request occurs, before the document's file is opened. | |
| virtual void | OnDocumentLoad (ElementDocument *document) |
| virtual void | OnDocumentUnload (ElementDocument *document) |
| virtual void | OnElementCreate (Element *element) |
| Called when a new element is created. | |
| virtual void | OnElementDestroy (Element *element) |
| Called when an element is destroyed. | |
Detailed Description
Generic Interface for plugins to Rocket.
Member Function Documentation
| void Rocket::Core::Plugin::OnInitialise | ( | ) | [virtual] |
Called when Rocket is initialised, or immediately when the plugin registers itself if Rocket has already been initialised.
Reimplemented in Rocket::Controls::Python::Module.
| virtual void Rocket::Core::Plugin::OnDocumentLoad | ( | ElementDocument * | document | ) | [virtual] |
Called when a document is successfully loaded from file or instanced, initialised and added to its context. This is called before the document's 'load' event.
| virtual void Rocket::Core::Plugin::OnDocumentUnload | ( | ElementDocument * | document | ) | [virtual] |
Called when a document is unloaded from its context. This is called after the document's 'unload' event.
The documentation for this class was generated from the following files:
- Include/Rocket/Core/Plugin.h
- Source/Core/Plugin.cpp
