![]() |
![]() |
![]() |
Clutter Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#define CLUTTER_CURRENT_TIME #define CLUTTER_PRIORITY_EVENTS enum ClutterModifierType; enum ClutterScrollDirection; enum ClutterStageState; enum ClutterEventType; union ClutterEvent; enum ClutterEventFlags; ClutterButtonEvent; ClutterKeyEvent; ClutterMotionEvent; ClutterScrollEvent; ClutterStageStateEvent; ClutterCrossingEvent; ClutterInputDevice; ClutterEvent * clutter_event_new (ClutterEventType type); ClutterEvent * clutter_event_copy (ClutterEvent *event); void clutter_event_free (ClutterEvent *event); ClutterEventType clutter_event_type (ClutterEvent *event); void clutter_event_get_coords (ClutterEvent *event, gfloat *x, gfloat *y); ClutterModifierType clutter_event_get_state (ClutterEvent *event); guint32 clutter_event_get_time (ClutterEvent *event); ClutterActor * clutter_event_get_source (ClutterEvent *event); ClutterStage * clutter_event_get_stage (ClutterEvent *event); ClutterEventFlags clutter_event_get_flags (ClutterEvent *event); ClutterEvent * clutter_event_get (void); ClutterEvent * clutter_event_peek (void); void clutter_event_put (ClutterEvent *event); gboolean clutter_events_pending (void); guint32 clutter_event_get_button (ClutterEvent *event); guint clutter_event_get_click_count (ClutterEvent *event); guint clutter_event_get_key_symbol (ClutterEvent *event); guint16 clutter_event_get_key_code (ClutterEvent *event); guint32 clutter_event_get_key_unicode (ClutterEvent *event); guint32 clutter_keysym_to_unicode (guint keyval); ClutterActor * clutter_event_get_related (ClutterEvent *event); ClutterScrollDirection clutter_event_get_scroll_direction (ClutterEvent *event); enum ClutterInputDeviceType; ClutterInputDevice * clutter_event_get_device (ClutterEvent *event); gint clutter_event_get_device_id (ClutterEvent *event); ClutterInputDeviceType clutter_event_get_device_type (ClutterEvent *event); ClutterInputDevice * clutter_get_input_device_for_id (gint id); gint clutter_input_device_get_device_id (ClutterInputDevice *device); ClutterInputDeviceType clutter_input_device_get_device_type (ClutterInputDevice *device); guint32 clutter_get_current_event_time (void);
Windowing events handled by Clutter.
The events usually come from the windowing backend, but can also be synthesized by Clutter itself or by the application code.
#define CLUTTER_PRIORITY_EVENTS (G_PRIORITY_DEFAULT)
Priority for event handling.
Since 0.4
typedef enum { CLUTTER_SHIFT_MASK = 1 << 0, CLUTTER_LOCK_MASK = 1 << 1, CLUTTER_CONTROL_MASK = 1 << 2, CLUTTER_MOD1_MASK = 1 << 3, CLUTTER_MOD2_MASK = 1 << 4, CLUTTER_MOD3_MASK = 1 << 5, CLUTTER_MOD4_MASK = 1 << 6, CLUTTER_MOD5_MASK = 1 << 7, CLUTTER_BUTTON1_MASK = 1 << 8, CLUTTER_BUTTON2_MASK = 1 << 9, CLUTTER_BUTTON3_MASK = 1 << 10, CLUTTER_BUTTON4_MASK = 1 << 11, CLUTTER_BUTTON5_MASK = 1 << 12, /* bits 15 to 25 are currently unused; bit 29 is used internally */ CLUTTER_SUPER_MASK = 1 << 26, CLUTTER_HYPER_MASK = 1 << 27, CLUTTER_META_MASK = 1 << 28, CLUTTER_RELEASE_MASK = 1 << 30, CLUTTER_MODIFIER_MASK = 0x5c001fff } ClutterModifierType;
Masks applied to a ClutterEvent by modifiers.
Mask applied by the Shift key | |
Mask applied by the Caps Lock key | |
Mask applied by the Control key | |
Mask applied by the first Mod key | |
Mask applied by the second Mod key | |
Mask applied by the third Mod key | |
Mask applied by the fourth Mod key | |
Mask applied by the fifth Mod key | |
Mask applied by the first pointer button | |
Mask applied by the second pointer button | |
Mask applied by the third pointer button | |
Mask applied by the fourth pointer button | |
Mask applied by the fifth pointer button | |
Mask applied by the Super key | |
Mask applied by the Hyper key | |
Mask applied by the Meta key | |
Mask applied during release | |
A mask covering all modifier types |
Since 0.4
typedef enum { CLUTTER_SCROLL_UP, CLUTTER_SCROLL_DOWN, CLUTTER_SCROLL_LEFT, CLUTTER_SCROLL_RIGHT } ClutterScrollDirection;
Direction of a pointer scroll event.
Scroll up | |
Scroll down | |
Scroll left | |
Scroll right |
Since 0.4
typedef enum { CLUTTER_STAGE_STATE_FULLSCREEN = (1<<1), CLUTTER_STAGE_STATE_OFFSCREEN = (1<<2), CLUTTER_STAGE_STATE_ACTIVATED = (1<<3) } ClutterStageState;
Stage state masks
Fullscreen mask | |
Offscreen mask | |
Activated mask |
Since 0.4
typedef enum { CLUTTER_NOTHING = 0, CLUTTER_KEY_PRESS, CLUTTER_KEY_RELEASE, CLUTTER_MOTION, CLUTTER_ENTER, CLUTTER_LEAVE, CLUTTER_BUTTON_PRESS, CLUTTER_BUTTON_RELEASE, CLUTTER_SCROLL, CLUTTER_STAGE_STATE, CLUTTER_DESTROY_NOTIFY, CLUTTER_CLIENT_MESSAGE, CLUTTER_DELETE } ClutterEventType;
Types of events.
Empty event | |
Key press event | |
Key release event | |
Pointer motion event | |
Actor enter event | |
Actor leave event | |
Pointer button press event | |
Pointer button release event | |
Pointer scroll event | |
Stage stage change event | |
Destroy notification event | |
Client message event | |
Stage delete event |
Since 0.4
union ClutterEvent { ClutterEventType type; ClutterAnyEvent any; ClutterButtonEvent button; ClutterKeyEvent key; ClutterMotionEvent motion; ClutterScrollEvent scroll; ClutterStageStateEvent stage_state; ClutterCrossingEvent crossing; };
Generic event wrapper.
Since 0.2
typedef enum { CLUTTER_EVENT_NONE = 0, CLUTTER_EVENT_FLAG_SYNTHETIC = 1 << 0, } ClutterEventFlags;
Flags for the ClutterEvent
Since 0.6
typedef struct { ClutterEventType type; guint32 time; ClutterEventFlags flags; ClutterStage *stage; ClutterActor *source; gfloat x; gfloat y; ClutterModifierType modifier_state; guint32 button; guint click_count; gdouble *axes; /* Future use */ ClutterInputDevice *device; } ClutterButtonEvent;
Button event.
The event coordinates are relative to the stage that received the
event, and can be transformed into actor-relative coordinates by
using clutter_actor_transform_stage_point()
.
ClutterEventType |
event type |
guint32 |
event time |
ClutterEventFlags |
event flags |
ClutterStage * |
event source stage |
ClutterActor * |
event source actor |
gfloat |
event X coordinate, relative to the stage |
gfloat |
event Y coordinate, relative to the stage |
ClutterModifierType |
button modifiers |
guint32 |
event button |
guint |
number of button presses within the default time and radius |
gdouble * |
reserved for future use |
ClutterInputDevice * |
reserved for future use |
Since 0.2
typedef struct { ClutterEventType type; guint32 time; ClutterEventFlags flags; ClutterStage *stage; ClutterActor *source; ClutterModifierType modifier_state; guint keyval; guint16 hardware_keycode; gunichar unicode_value; ClutterInputDevice *device; } ClutterKeyEvent;
Key event
ClutterEventType |
event type |
guint32 |
event time |
ClutterEventFlags |
event flags |
ClutterStage * |
event source stage |
ClutterActor * |
event source actor |
ClutterModifierType |
key modifiers |
guint |
raw key value |
guint16 |
raw hardware key value |
gunichar |
Unicode representation |
ClutterInputDevice * |
reserved for future use |
Since 0.2
typedef struct { ClutterEventType type; guint32 time; ClutterEventFlags flags; ClutterStage *stage; ClutterActor *source; gfloat x; gfloat y; ClutterModifierType modifier_state; gdouble *axes; /* Future use */ ClutterInputDevice *device; } ClutterMotionEvent;
Event for the pointer motion
ClutterEventType |
event type |
guint32 |
event time |
ClutterEventFlags |
event flags |
ClutterStage * |
event source stage |
ClutterActor * |
event source actor |
gfloat |
event X coordinate |
gfloat |
event Y coordinate |
ClutterModifierType |
button modifiers |
gdouble * |
reserved for future use |
ClutterInputDevice * |
reserved for future use |
Since 0.2
typedef struct { ClutterEventType type; guint32 time; ClutterEventFlags flags; ClutterStage *stage; ClutterActor *source; gfloat x; gfloat y; ClutterScrollDirection direction; ClutterModifierType modifier_state; gdouble *axes; /* future use */ ClutterInputDevice *device; } ClutterScrollEvent;
Scroll wheel (or similar device) event
ClutterEventType |
event type |
guint32 |
event time |
ClutterEventFlags |
event flags |
ClutterStage * |
event source stage |
ClutterActor * |
event source actor |
gfloat |
event X coordinate |
gfloat |
event Y coordinate |
ClutterScrollDirection |
direction of the scrolling |
ClutterModifierType |
button modifiers |
gdouble * |
reserved for future use |
ClutterInputDevice * |
reserved for future use |
Since 0.2
typedef struct { ClutterEventType type; guint32 time; ClutterEventFlags flags; ClutterStage *stage; ClutterActor *source; /* XXX: should probably be the stage itself */ ClutterStageState changed_mask; ClutterStageState new_state; } ClutterStageStateEvent;
Event signalling a change in the ClutterStage state.
ClutterEventType |
event type |
guint32 |
event time |
ClutterEventFlags |
event flags |
ClutterStage * |
event source stage |
ClutterActor * |
event source actor (unused) |
ClutterStageState |
bitwise OR of the changed flags |
ClutterStageState |
bitwise OR of the current state flags |
Since 0.2
typedef struct { ClutterEventType type; guint32 time; ClutterEventFlags flags; ClutterStage *stage; ClutterActor *source; gfloat x; gfloat y; ClutterInputDevice *device; ClutterActor *related; } ClutterCrossingEvent;
Event for the movement of the pointer across different actors
ClutterEventType |
event type |
guint32 |
event time |
ClutterEventFlags |
event flags |
ClutterStage * |
event source stage |
ClutterActor * |
event source actor |
gfloat |
event X coordinate |
gfloat |
event Y coordinate |
ClutterInputDevice * |
reserved for future use |
ClutterActor * |
actor related to the crossing |
Since 0.2
typedef struct _ClutterInputDevice ClutterInputDevice;
Generic representation of an input device. The actual contents of this structure depend on the backend used.
ClutterEvent * clutter_event_new (ClutterEventType type);
Creates a new ClutterEvent of the specified type.
|
The type of event. |
Returns : |
A newly allocated ClutterEvent. |
ClutterEvent * clutter_event_copy (ClutterEvent *event);
Copies event
.
|
A ClutterEvent. |
Returns : |
A newly allocated ClutterEvent |
void clutter_event_free (ClutterEvent *event);
Frees all resources used by event
.
|
A ClutterEvent. |
ClutterEventType clutter_event_type (ClutterEvent *event);
Retrieves the type of the event.
|
a ClutterEvent |
Returns : |
a ClutterEventType |
void clutter_event_get_coords (ClutterEvent *event, gfloat *x, gfloat *y);
Retrieves the coordinates of event
and puts them into x
and y
.
|
a ClutterEvent |
|
return location for the X coordinate |
|
return location for the Y coordinate |
Since 0.4
ClutterModifierType clutter_event_get_state (ClutterEvent *event);
Retrieves the modifier state of the event.
|
a ClutterEvent |
Returns : |
the modifier state parameter, or 0 |
Since 0.4
guint32 clutter_event_get_time (ClutterEvent *event);
Retrieves the time of the event.
|
a ClutterEvent |
Returns : |
the time of the event, or CLUTTER_CURRENT_TIME
|
Since 0.4
ClutterActor * clutter_event_get_source (ClutterEvent *event);
Retrieves the source ClutterActor the event originated from, or NULL if the event has no source.
|
a ClutterEvent |
Returns : |
a ClutterActor. transfer none. |
Since 0.6
ClutterStage * clutter_event_get_stage (ClutterEvent *event);
Retrieves the source ClutterStage the event originated for, or
NULL
if the event has no stage.
|
a ClutterEvent |
Returns : |
a ClutterStage. transfer none. |
Since 0.8
ClutterEventFlags clutter_event_get_flags (ClutterEvent *event);
Retrieves the ClutterEventFlags of event
|
a ClutterEvent |
Returns : |
the event flags |
Since 1.0
ClutterEvent * clutter_event_get (void);
Pops an event off the event queue. Applications should not need to call this.
Returns : |
A ClutterEvent or NULL if queue empty |
Since 0.4
ClutterEvent * clutter_event_peek (void);
Returns a pointer to the first event from the event queue but does not remove it.
Returns : |
A ClutterEvent or NULL if queue empty.. transfer none. |
Since 0.4
void clutter_event_put (ClutterEvent *event);
Puts a copy of the event on the back of the event queue. The event will
have the CLUTTER_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
|
a ClutterEvent |
Since 0.6
gboolean clutter_events_pending (void);
Checks if events are pending in the event queue.
Returns : |
TRUE if there are pending events, FALSE otherwise. |
Since 0.4
guint32 clutter_event_get_button (ClutterEvent *event);
Retrieves the button number of event
|
a ClutterEvent of type CLUTTER_BUTTON_PRESS or
of type CLUTTER_BUTTON_RELEASE
|
Returns : |
the button number |
Since 1.0
guint clutter_event_get_click_count (ClutterEvent *event);
Retrieves the number of clicks of event
|
a ClutterEvent of type CLUTTER_BUTTON_PRESS or
of type CLUTTER_BUTTON_RELEASE
|
Returns : |
the click count |
Since 1.0
guint clutter_event_get_key_symbol (ClutterEvent *event);
Retrieves the key symbol of event
|
a ClutterEvent of type CLUTTER_KEY_PRESS or
of type CLUTTER_KEY_RELEASE
|
Returns : |
the key symbol representing the key |
Since 1.0
guint16 clutter_event_get_key_code (ClutterEvent *event);
Retrieves the keycode of the key that caused event
|
a ClutterEvent of type CLUTTER_KEY_PRESS or
of type CLUTTER_KEY_RELEASE
|
Returns : |
The keycode representing the key |
Since 1.0
guint32 clutter_event_get_key_unicode (ClutterEvent *event);
Retrieves the unicode value for the key that caused keyev
.
|
A ClutterKeyEvent |
Returns : |
The unicode value representing the key |
guint32 clutter_keysym_to_unicode (guint keyval);
Convert from a Clutter key symbol to the corresponding ISO10646 (Unicode) character.
|
a key symbol |
Returns : |
a Unicode character, or 0 if there is no corresponding character. |
ClutterActor * clutter_event_get_related (ClutterEvent *event);
Retrieves the related actor of a crossing event.
|
a ClutterEvent of type CLUTTER_ENTER or of
type CLUTTER_LEAVE
|
Returns : |
the related ClutterActor, or NULL . transfer none. |
Since 1.0
ClutterScrollDirection clutter_event_get_scroll_direction (ClutterEvent *event);
Retrieves the direction of the scrolling of event
|
a ClutterEvent of type CLUTTER_SCROLL
|
Returns : |
the scrolling direction |
Since 1.0
typedef enum { CLUTTER_POINTER_DEVICE, CLUTTER_KEYBOARD_DEVICE, CLUTTER_EXTENSION_DEVICE, CLUTTER_N_DEVICE_TYPES } ClutterInputDeviceType;
The types of input devices available.
The ClutterInputDeviceType enumeration can be extended at later date; not every platform supports every input device type.
A pointer device | |
A keyboard device | |
A generic extension device | |
The number of device types |
Since 1.0
ClutterInputDevice * clutter_event_get_device (ClutterEvent *event);
Retrieves the ClutterInputDevice for the event.
The ClutterInputDevice structure is completely opaque and should be cast to the platform-specific implementation.
|
a ClutterEvent |
Returns : |
the ClutterInputDevice or NULL
|
Since 1.0
gint clutter_event_get_device_id (ClutterEvent *event);
Retrieves the events device id if set.
|
a clutter event |
Returns : |
A unique identifier for the device or -1 if the event has no specific device set. |
ClutterInputDeviceType clutter_event_get_device_type (ClutterEvent *event);
Retrieves the type of the device for event
|
a ClutterEvent |
Returns : |
the ClutterInputDeviceType for the device, if any is set |
Since 1.0
ClutterInputDevice * clutter_get_input_device_for_id (gint id);
Retrieves the ClutterInputDevice from its id.
|
a device id |
Returns : |
a ClutterInputDevice, or NULL . transfer none. |
Since 0.8
gint clutter_input_device_get_device_id (ClutterInputDevice *device);
Retrieves the unique identifier of device
|
a ClutterInputDevice |
Returns : |
the identifier of the device |
Since 1.0
ClutterInputDeviceType clutter_input_device_get_device_type (ClutterInputDevice *device);
Retrieves the type of device
|
a ClutterInputDevice |
Returns : |
the type of the device |
Since 1.0
guint32 clutter_get_current_event_time (void);
Retrieves the timestamp of the last event, if there is an event or if the event has a timestamp.
Returns : |
the event timestamp, or CLUTTER_CURRENT_TIME
|
Since 1.0