API reference
Preparing search index…

PluginCallbacks

Synchronous Rml::Plugin notifications.

Arguments are live borrowed facades and expire on callback return. Approved reads are context name/dimensions/getDataModel/getDataModels, element id/tagName/attribute reads, and document title/sourceURL. Other Native calls are rejected; registerPlugin and unregisterPlugin are allowed. Copy required values inside the callback. A data model is still discoverable during its destroy notification and becomes invalid immediately after Native removal. All notification callbacks must return undefined synchronously.

Source & inheritance
Member directory12

Properties

Properties

getEventClasses?: PluginEventClassesCallback

Return an integer mask 0..15; default All.

Source & inheritance
onContextCreate?: PluginContextCallback

Rml::Plugin::OnContextCreate; live context.

Source & inheritance
onContextDestroy?: PluginContextCallback

Rml::Plugin::OnContextDestroy; before documents/models.

Source & inheritance
onDataModelCreate?: PluginDataModelCallback

Rml::Plugin::OnDataModelCreate; context and model name.

Source & inheritance
onDataModelDestroy?: PluginDataModelCallback

Rml::Plugin::OnDataModelDestroy; model remains discoverable.

Source & inheritance
onDocumentLoad?: PluginDocumentCallback

Rml::Plugin::OnDocumentLoad; before load event.

Source & inheritance

Rml::Plugin::OnDocumentOpen; at the stream load entry.

Source & inheritance
onDocumentUnload?: PluginDocumentCallback

Rml::Plugin::OnDocumentUnload; after unload event.

Source & inheritance
onElementCreate?: PluginElementCallback

Rml::Plugin::OnElementCreate; initialized factory element.

Source & inheritance
onElementDestroy?: PluginElementCallback

Rml::Plugin::OnElementDestroy; live base Element destructor.

Source & inheritance

Notify the plugin that the RmlUi runtime has initialized.

Source & inheritance

Notify the plugin that the RmlUi runtime is shutting down.

Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0