Changes between Version 1 and Version 2 of documentation/C++Manual/Plugins

Show
Ignore:
Author:
lloydw (IP: 203.96.63.172)
Timestamp:
04/01/08 12:40:51 (9 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • documentation/C++Manual/Plugins

    v1 v2  
    1111// Called when Rocket is initialised. 
    1212virtual void OnInitialise(); 
    13  
    1413// Called when Rocket shuts down. 
    1514virtual void OnShutdown(); 
    1615 
     16// Called when a document load request occurs, before the document's file is opened. 
     17virtual void OnDocumentOpen(Context* context, const EMP::Core::String& document_path); 
     18// 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. 
     19virtual void OnDocumentLoad(ElementDocument* document); 
     20// Called when a document is unloaded from its context. This is called after the document's 'unload' event. 
     21virtual void OnDocumentUnload(ElementDocument* document); 
     22 
    1723// Called when a new context is created. 
    1824virtual void OnContextCreate(Rocket::Core::Context* context); 
    19  
    2025// Called when a context is destroyed. 
    2126virtual void OnContextDestroy(Rocket::Core::Context* context); 
    2328// Called when a new element is created. 
    2429virtual void OnElementCreate(Rocket::Core::Element* element); 
    25  
    2630// Called when an element is destroyed. 
    2731virtual void OnElementDestroy(Rocket::Core::Element* element); 
    3337 
    3438OnShutdown() is called on all registered plugins when Rocket is shut down, immediately after all the contexts and elements are destroyed. Plugins must release any resources they have allocated, including themselves, during this call. 
     39 
     40=== Document events === 
     41 
     42OnDocumentOpen is called when a RML stream is opened, Load/Unload are global callbacks called before and after the documents load/unload respectively. 
    3543 
    3644=== Context events ===