AeonGUI_PluginContext Struct Reference

Plugin context passed to OnLoad and OnUnload. More...

#include </d/a/AeonGUI/AeonGUI/include/aeongui/PluginAPI.h>

Public Attributes
AeonGUI_Document *	document
	The document that loaded this plugin.
AeonGUI_Element *(*	getElementById )(AeonGUI_Document *doc, const char *id)
	Find an element by its id attribute.
void(*	addEventListener )(AeonGUI_Element *element, const char *type, AeonGUI_EventCallback callback, void *userData)
	Register an event listener on an element.
void(*	removeEventListener )(AeonGUI_Element *element, const char *type, AeonGUI_EventCallback callback, void *userData)
	Remove a previously registered event listener.
const char *(*	getAttribute )(AeonGUI_Element *element, const char *name)
	Read an attribute value from an element.
const char *(*	getEventType )(AeonGUI_Event *event)
	Get the type string of an event.
void(*	setAttribute )(AeonGUI_Element *element, const char *name, const char *value)
	Set (or add) an attribute on an element.
AeonGUI_Element *(*	querySelector )(AeonGUI_Element *element, const char *selector)
	Find the first descendant element matching a CSS selector.

Detailed Description

Plugin context passed to OnLoad and OnUnload.

Contains the document handle and function pointers for interacting with the DOM. The plugin does not need to link against AeonGUI — all calls go through these pointers.

Member Data Documentation

addEventListener

void(* AeonGUI_PluginContext::addEventListener) (AeonGUI_Element *element, const char *type, AeonGUI_EventCallback callback, void *userData)

Register an event listener on an element.

Parameters

element	The target element.
type	Event type (e.g. "click", "mouseenter").
callback	Function to call when the event fires.
userData	Opaque pointer forwarded to the callback.

getAttribute

const char *(* AeonGUI_PluginContext::getAttribute) (AeonGUI_Element *element, const char *name)

Read an attribute value from an element.

Parameters

element	The element.
name	Attribute name.

Returns

The attribute value string, or NULL if not found. The pointer is valid until the element is destroyed.

getElementById

AeonGUI_Element *(* AeonGUI_PluginContext::getElementById) (AeonGUI_Document *doc, const char *id)

Find an element by its id attribute.

Parameters

doc	The document handle.
id	The id string to search for.

Returns

Element handle, or NULL if not found.

getEventType

const char *(* AeonGUI_PluginContext::getEventType) (AeonGUI_Event *event)

Get the type string of an event.

Parameters

event

The event handle.

Returns

The event type (e.g. "click"). Valid for the lifetime of the event.

querySelector

AeonGUI_Element *(* AeonGUI_PluginContext::querySelector) (AeonGUI_Element *element, const char *selector)

Find the first descendant element matching a CSS selector.

Parameters

element	The root element to search within.
selector	CSS selector string.

Returns

Element handle, or NULL if not found.

removeEventListener

void(* AeonGUI_PluginContext::removeEventListener) (AeonGUI_Element *element, const char *type, AeonGUI_EventCallback callback, void *userData)

Remove a previously registered event listener.

Parameters

element	The target element.
type	Event type.
callback	The callback to remove.
userData	The same userData used during registration.

setAttribute

void(* AeonGUI_PluginContext::setAttribute) (AeonGUI_Element *element, const char *name, const char *value)

Set (or add) an attribute on an element.

Parameters

element	The element.
name	Attribute name.
value	New value.

---

The documentation for this struct was generated from the following file:

• /d/a/AeonGUI/AeonGUI/include/aeongui/PluginAPI.h