clutter.Event
Prev General purpose API Next

clutter.Event

clutter.Event

Synopsis

class clutter.Event(gobject.GBoxed):
    __init__(type)
    def put()
    def copy()
    def type()
    def get_time()
    def get_state()
    def get_coords()
    def get_source()
    def get_stage()
    def get_flags()
    def get_button()
    def get_click_count()
    def get_key_symbol()
    def get_key_code()
    def get_key_unicode()
    def get_related()
    def get_scroll_direction()

Constructor

    __init__(type)

type :

a ClutterEventType

Returns :

a clutter.Eventof the specified type.

Methods

clutter.Event.put

    def put()

Puts a copy of the event on the back of the event queue. The event will have the EVENT_FLAG_SYNTHETIC flag set. If the source is set event signals will be emitted for this source and capture/bubbling for its ancestors. If the source is not set it will be generated by picking or use the actor that currently has keyboard focus.

clutter.Event.copy

    def copy()

Returns :

a clutter.Event

Returns a copy of the event.

clutter.Event.type

    def type()

Returns :

a ClutterEventType

Returns the type of the event.

clutter.Event.get_time

    def get_time()

Returns :

the time of the event.

Returns the time of the event.

clutter.Event.get_state

    def get_state()

Returns :

a ClutterModifierType

Returns the modifier state of the event.

clutter.Event.get_coords

    def get_coords()

Returns :

2-tuple with X and Y coordinates.

Returns the coordinates of the event.

clutter.Event.get_source

    def get_source()

Returns :

a clutter.Actor

Returns the source clutter.Actor the event originated from, or None if the event has no source.

clutter.Event.get_stage

    def get_stage()

Returns :

a clutter.Stage or None

Returns the source clutter.Stage the event originated for, or None if the event has no stage.

clutter.Event.get_flags

    def get_flags()

Returns :

the event flags

Returns the clutter.EventFlags of the event.

clutter.Event.get_button

    def get_button()

Returns :

the button number

Returns the button number of the event.

clutter.Event.get_click_count

    def get_click_count()

Returns :

the click count

Returns the number of clicks of the event.

clutter.Event.get_key_symbol

    def get_key_symbol()

Returns :

the key symbol representing the key

Returns the key symbol of the event.

clutter.Event.get_key_code

    def get_key_code()

Returns :

The keycode representing the key

Returns the keycode of the key that caused the event.

clutter.Event.get_key_unicode

    def get_key_unicode()

Returns :

The unicode value representing the key

Returns the unicode value for the key that caused the event.

clutter.Event.get_related

    def get_related()

Returns :

the related clutter.Actor or None.

Returns the related actor of a crossing event.

clutter.Event.get_scroll_direction

    def get_scroll_direction()

Returns :

the scrolling direction

Returns the direction of the scrolling of the event.

Prev Up Next
clutter.Color Home clutter.Geometry