GdomeEvent

Name

GdomeEvent -- Interface Event implementation.

Synopsis



struct      GdomeEvent;
GdomeEvent* gdome_evnt_mkref                (void);
void        gdome_evnt_ref                  (GdomeEvent *self,
                                             GdomeException *exc);
void        gdome_evnt_unref                (GdomeEvent *self,
                                             GdomeException *exc);
gpointer    gdome_evnt_query_interface      (GdomeEvent *self,
                                             const char *interface,
                                             GdomeException *exc);
GdomeBoolean gdome_evnt_bubbles             (GdomeEvent *self,
                                             GdomeException *exc);
GdomeBoolean gdome_evnt_cancelable          (GdomeEvent *self,
                                             GdomeException *exc);
GdomeEventTarget* gdome_evnt_currentTarget  (GdomeEvent *self,
                                             GdomeException *exc);
unsigned short gdome_evnt_eventPhase        (GdomeEvent *self,
                                             GdomeException *exc);
GdomeEventTarget* gdome_evnt_target         (GdomeEvent *self,
                                             GdomeException *exc);
GdomeDOMTimeStamp gdome_evnt_timeStamp      (GdomeEvent *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_evnt_type             (GdomeEvent *self,
                                             GdomeException *exc);
void        gdome_evnt_initEvent            (GdomeEvent *self,
                                             GdomeDOMString *eventTypeArg,
                                             GdomeBoolean canBubbleArg,
                                             GdomeBoolean cancelableArg,
                                             GdomeException *exc);
void        gdome_evnt_preventDefault       (GdomeEvent *self,
                                             GdomeException *exc);
void        gdome_evnt_stopPropagation      (GdomeEvent *self,
                                             GdomeException *exc);

Description

The GdomeEvent interface is used to provide contextual information about an event to the handler processing the event. An object which implements the GdomeEvent interface is generally passed as the first parameter to an event handler. More specific context information is passed to event handlers by deriving additional interfaces from GdomeEvent which contain information directly relating to the type of event they accompany. These derived interfaces are also implemented by the object passed to the event listener.

Details

struct GdomeEvent

struct GdomeEvent {
	gpointer user_data;
};


gdome_evnt_mkref ()

GdomeEvent* gdome_evnt_mkref                (void);


gdome_evnt_ref ()

void        gdome_evnt_ref                  (GdomeEvent *self,
                                             GdomeException *exc);

Increase the reference count of the specified Event.


gdome_evnt_unref ()

void        gdome_evnt_unref                (GdomeEvent *self,
                                             GdomeException *exc);

Decrease the reference count of the specified Event. Free the Event structure if the Event will have zero reference.


gdome_evnt_query_interface ()

gpointer    gdome_evnt_query_interface      (GdomeEvent *self,
                                             const char *interface,
                                             GdomeException *exc);


gdome_evnt_bubbles ()

GdomeBoolean gdome_evnt_bubbles             (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_cancelable ()

GdomeBoolean gdome_evnt_cancelable          (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_currentTarget ()

GdomeEventTarget* gdome_evnt_currentTarget  (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_eventPhase ()

unsigned short gdome_evnt_eventPhase        (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_target ()

GdomeEventTarget* gdome_evnt_target         (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_timeStamp ()

GdomeDOMTimeStamp gdome_evnt_timeStamp      (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_type ()

GdomeDOMString* gdome_evnt_type             (GdomeEvent *self,
                                             GdomeException *exc);


gdome_evnt_initEvent ()

void        gdome_evnt_initEvent            (GdomeEvent *self,
                                             GdomeDOMString *eventTypeArg,
                                             GdomeBoolean canBubbleArg,
                                             GdomeBoolean cancelableArg,
                                             GdomeException *exc);

The initEvent method is used to initialize the value of an Event created through the gdome_doc_createEvent() API. This method may only be called before the Event has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of Event interface only the values specified in the initEvent method are modified, all other attributes are left unchanged.


gdome_evnt_preventDefault ()

void        gdome_evnt_preventDefault       (GdomeEvent *self,
                                             GdomeException *exc);

If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. If, during any stage of event flow, the preventDefault method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.


gdome_evnt_stopPropagation ()

void        gdome_evnt_stopPropagation      (GdomeEvent *self,
                                             GdomeException *exc);

The stopPropagation method is used prevent further propagation of an event during event flow. If this method is called by any EventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow.