RmlEvent

from acron.rmlui import RmlEvent

class RmlEvent

Bases:

Bases: CallbackData

The CallbackData passed to a callback registered with RmlElement.add_event_listener(). Wraps the underlying Rml::Event.

The wrapped event is only valid for the duration of the callback; do not store an RmlEvent (or anything returned by its element accessors) past the return of the callback.

Inheritance diagram

digraph inheritance0403fa8762 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "CallbackData" [URL="acron.core.CallbackData.html#acron.core.CallbackData",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedObject" -> "CallbackData" [arrowsize=0.75,style=""]; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "RmlEvent" [URL="acron.rmlui.RmlEvent.html#acron.rmlui.RmlEvent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "CallbackData" -> "RmlEvent" [arrowsize=0.75,style=""]; "TypedObject" [URL="acron.core.TypedObject.html#acron.core.TypedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "TypedObject" [arrowsize=0.75,style=""]; }

property event_type → string

The DOM event type, e.g. “click”, “mousemove”, “submit”. (Named get_event_type() to avoid clashing with TypedObject::get_type.)

The DOM event type, e.g. “click”, “mousemove”, “submit”. (Named get_event_type() to avoid clashing with TypedObject::get_type.)

The DOM event type, e.g. “click”, “mousemove”, “submit”. (Named get_event_type() to avoid clashing with TypedObject::get_type.)

static get_class_type()

get_current_element()

get_event_type()

The DOM event type, e.g. “click”, “mousemove”, “submit”. (Named get_event_type to avoid clashing with TypedObject::get_type.)

The DOM event type, e.g. “click”, “mousemove”, “submit”. (Named get_event_type to avoid clashing with TypedObject::get_type.)

get_mouse_x()

Convenience accessors for the common mouse parameters.

Convenience accessors for the common mouse parameters.

get_mouse_y()

get_parameter()

Looks up a named event parameter (mouse_x, button, value, …). Returns default_value if the parameter is absent.

get_parameter_float()

get_parameter_int()

get_target_element()

The element the event was dispatched to / is currently bubbling through. The returned wrapper is non-owning and valid only during the callback.

has_parameter()

property mouse_x → float

Convenience accessors for the common mouse parameters.

Convenience accessors for the common mouse parameters.

Convenience accessors for the common mouse parameters.

property mouse_y → float

stop_propagation()

Stops the event from propagating further up the DOM tree.