CLUTTER_CURRENT_TIME

#define CLUTTER_CURRENT_TIME            (0L)

Default value for "now".

Since 0.4

CLUTTER_PRIORITY_EVENTS

#define CLUTTER_PRIORITY_EVENTS         (G_PRIORITY_DEFAULT)

Priority for event handling.

Since 0.4

CLUTTER_EVENT_PROPAGATE

#define CLUTTER_EVENT_PROPAGATE         (FALSE)

Continues the propagation of an event; this macro should be used in event-related signals.

Since 1.10

CLUTTER_EVENT_STOP

#define CLUTTER_EVENT_STOP              (TRUE)

Stops the propagation of an event; this macro should be used in event-related signals.

Since 1.10

clutter_event_new ()

ClutterEvent *
clutter_event_new (ClutterEventType type);

Creates a new ClutterEvent of the specified type.

clutter_event_copy ()

ClutterEvent *
clutter_event_copy (const ClutterEvent *event);

Copies event .

clutter_event_free ()

void
clutter_event_free (ClutterEvent *event);

Frees all resources used by event .

clutter_event_type ()

ClutterEventType
clutter_event_type (const ClutterEvent *event);

Retrieves the type of the event.

clutter_event_set_coords ()

void
clutter_event_set_coords (ClutterEvent *event,
                          gfloat x,
                          gfloat y);

Sets the coordinates of the event .

Since 1.8

clutter_event_get_coords ()

void
clutter_event_get_coords (const ClutterEvent *event,
                          gfloat *x,
                          gfloat *y);

Retrieves the coordinates of event and puts them into x and y .

Since 0.4

clutter_event_set_state ()

void
clutter_event_set_state (ClutterEvent *event,
                         ClutterModifierType state);

Sets the modifier state of the event.

Since 1.8

clutter_event_get_state ()

ClutterModifierType
clutter_event_get_state (const ClutterEvent *event);

Retrieves the modifier state of the event. In case the window system supports reporting latched and locked modifiers, this function returns the effective state.

Since 0.4

clutter_event_get_state_full ()

void
clutter_event_get_state_full (const ClutterEvent *event,
                              ClutterModifierType *button_state,
                              ClutterModifierType *base_state,
                              ClutterModifierType *latched_state,
                              ClutterModifierType *locked_state,
                              ClutterModifierType *effective_state);

Retrieves the decomposition of the keyboard state into button, base, latched, locked and effective. This can be used to transmit to other applications, for example when implementing a wayland compositor.

Since 1.16

clutter_event_set_time ()

void
clutter_event_set_time (ClutterEvent *event,
                        guint32 time_);

Sets the time of the event.

Since 1.8

clutter_event_get_time ()

guint32
clutter_event_get_time (const ClutterEvent *event);

Retrieves the time of the event.

Since 0.4

clutter_event_set_source ()

void
clutter_event_set_source (ClutterEvent *event,
                          ClutterActor *actor);

Sets the source ClutterActor of event .

Since 1.8

clutter_event_get_source ()

ClutterActor *
clutter_event_get_source (const ClutterEvent *event);

Retrieves the source ClutterActor the event originated from, or NULL if the event has no source.

Since 0.6

clutter_event_set_stage ()

void
clutter_event_set_stage (ClutterEvent *event,
                         ClutterStage *stage);

Sets the source ClutterStage of the event.

Since 1.8

clutter_event_get_stage ()

ClutterStage *
clutter_event_get_stage (const ClutterEvent *event);

Retrieves the source ClutterStage the event originated for, or NULL if the event has no stage.

Since 0.8

clutter_event_set_flags ()

void
clutter_event_set_flags (ClutterEvent *event,
                         ClutterEventFlags flags);

Sets the ClutterEventFlags of event

Since 1.8

clutter_event_get_flags ()

ClutterEventFlags
clutter_event_get_flags (const ClutterEvent *event);

Retrieves the ClutterEventFlags of event

Since 1.0

clutter_event_get_axes ()

gdouble *
clutter_event_get_axes (const ClutterEvent *event,
                        guint *n_axes);

Retrieves the array of axes values attached to the event.

Since 1.6

clutter_event_get_event_sequence ()

ClutterEventSequence *
clutter_event_get_event_sequence (const ClutterEvent *event);

Retrieves the ClutterEventSequence of event .

Since 1.10

clutter_event_get_angle ()

double
clutter_event_get_angle (const ClutterEvent *source,
                         const ClutterEvent *target);

Retrieves the angle relative from source to target .

The direction of the angle is from the position X axis towards the positive Y axis.

Since 1.12

clutter_event_get_distance ()

float
clutter_event_get_distance (const ClutterEvent *source,
                            const ClutterEvent *target);

Retrieves the distance between two events, a source and a target .

Since 1.12

clutter_event_get_position ()

void
clutter_event_get_position (const ClutterEvent *event,
                            ClutterPoint *position);

Retrieves the event coordinates as a ClutterPoint.

Since 1.12

clutter_event_has_control_modifier ()

gboolean
clutter_event_has_control_modifier (const ClutterEvent *event);

Checks whether event has the Control modifier mask set.

Since 1.12

clutter_event_has_shift_modifier ()

gboolean
clutter_event_has_shift_modifier (const ClutterEvent *event);

Checks whether event has the Shift modifier mask set.

Since 1.12

clutter_event_is_pointer_emulated ()

gboolean
clutter_event_is_pointer_emulated (const ClutterEvent *event);

Checks whether a pointer event has been generated by the windowing system. The returned value can be used to distinguish between events synthesized by the windowing system itself (as opposed by Clutter).

Since 1.12

clutter_event_get ()

ClutterEvent *
clutter_event_get (void);

Pops an event off the event queue. Applications should not need to call this.

Since 0.4

clutter_event_peek ()

ClutterEvent *
clutter_event_peek (void);

Returns a pointer to the first event from the event queue but does not remove it.

Since 0.4

clutter_event_put ()

void
clutter_event_put (const 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

Since 0.6

clutter_events_pending ()

gboolean
clutter_events_pending (void);

Checks if events are pending in the event queue.

Since 0.4

ClutterEventFilterFunc ()

gboolean
(*ClutterEventFilterFunc) (const ClutterEvent *event,
                           gpointer user_data);

A function pointer type used by event filters that are added with clutter_event_add_filter().

Since 1.18

clutter_event_add_filter ()

guint
clutter_event_add_filter (ClutterStage *stage,
                          ClutterEventFilterFunc func,
                          GDestroyNotify notify,
                          gpointer user_data);

Adds a function which will be called for all events that Clutter processes. The function will be called before any signals are emitted for the event and it will take precedence over any grabs.

Since 1.18

clutter_event_remove_filter ()

void
clutter_event_remove_filter (guint id);

Removes an event filter that was previously added with clutter_event_add_filter().

Since 1.18

CLUTTER_BUTTON_PRIMARY

#define CLUTTER_BUTTON_PRIMARY          (1)

The primary button of a pointer device.

This is typically the left mouse button in a right-handed mouse configuration.

Since 1.10

CLUTTER_BUTTON_MIDDLE

#define CLUTTER_BUTTON_MIDDLE           (2)

The middle button of a pointer device.

Since 1.10

CLUTTER_BUTTON_SECONDARY

#define CLUTTER_BUTTON_SECONDARY        (3)

The secondary button of a pointer device.

This is typically the right mouse button in a right-handed mouse configuration.

Since 1.10

clutter_event_set_button ()

void
clutter_event_set_button (ClutterEvent *event,
                          guint32 button);

Sets the button number of event

Since 1.8

clutter_event_get_button ()

guint32
clutter_event_get_button (const ClutterEvent *event);

Retrieves the button number of event

Since 1.0

clutter_event_get_click_count ()

guint
clutter_event_get_click_count (const ClutterEvent *event);

Retrieves the number of clicks of event

Since 1.0

clutter_event_set_key_symbol ()

void
clutter_event_set_key_symbol (ClutterEvent *event,
                              guint key_sym);

Sets the key symbol of event .

Since 1.8

clutter_event_get_key_symbol ()

guint
clutter_event_get_key_symbol (const ClutterEvent *event);

Retrieves the key symbol of event

Since 1.0

clutter_event_set_key_code ()

void
clutter_event_set_key_code (ClutterEvent *event,
                            guint16 key_code);

Sets the keycode of the event .

Since 1.8

clutter_event_get_key_code ()

guint16
clutter_event_get_key_code (const ClutterEvent *event);

Retrieves the keycode of the key that caused event

Since 1.0

clutter_event_set_key_unicode ()

void
clutter_event_set_key_unicode (ClutterEvent *event,
                               gunichar key_unicode);

Sets the Unicode value of event .

Since 1.8

clutter_event_get_key_unicode ()

gunichar
clutter_event_get_key_unicode (const ClutterEvent *event);

Retrieves the unicode value for the key that caused keyev .

clutter_keysym_to_unicode ()

guint32
clutter_keysym_to_unicode (guint keyval);

Converts keyval from a Clutter key symbol to the corresponding ISO10646 (Unicode) character.

clutter_unicode_to_keysym ()

guint
clutter_unicode_to_keysym (guint32 wc);

Convert from a ISO10646 character to a key symbol.

Since 1.10

clutter_event_set_related ()

void
clutter_event_set_related (ClutterEvent *event,
                           ClutterActor *actor);

Sets the related actor of a crossing event

Since 1.8

clutter_event_get_related ()

ClutterActor *
clutter_event_get_related (const ClutterEvent *event);

Retrieves the related actor of a crossing event.

Since 1.0

clutter_event_set_scroll_direction ()

void
clutter_event_set_scroll_direction (ClutterEvent *event,
                                    ClutterScrollDirection direction);

Sets the direction of the scrolling of event

Since 1.8

clutter_event_get_scroll_direction ()

ClutterScrollDirection
clutter_event_get_scroll_direction (const ClutterEvent *event);

Retrieves the direction of the scrolling of event

Since 1.0

clutter_event_get_scroll_delta ()

void
clutter_event_get_scroll_delta (const ClutterEvent *event,
                                gdouble *dx,
                                gdouble *dy);

Retrieves the precise scrolling information of event .

The event has to have a ClutterScrollEvent.direction value of CLUTTER_SCROLL_SMOOTH.

Since 1.10

clutter_event_set_scroll_delta ()

void
clutter_event_set_scroll_delta (ClutterEvent *event,
                                gdouble dx,
                                gdouble dy);

Sets the precise scrolling information of event .

Since 1.10

clutter_event_set_device ()

void
clutter_event_set_device (ClutterEvent *event,
                          ClutterInputDevice *device);

Sets the device for event .

Since 1.6

clutter_event_get_device ()

ClutterInputDevice *
clutter_event_get_device (const ClutterEvent *event);

Retrieves the ClutterInputDevice for the event. If you want the physical device the event originated from, use clutter_event_get_source_device().

The ClutterInputDevice structure is completely opaque and should be cast to the platform-specific implementation.

Since 1.0

clutter_event_set_source_device ()

void
clutter_event_set_source_device (ClutterEvent *event,
                                 ClutterInputDevice *device);

Sets the source ClutterInputDevice for event .

The ClutterEvent must have been created using clutter_event_new().

Since 1.8

clutter_event_get_source_device ()

ClutterInputDevice *
clutter_event_get_source_device (const ClutterEvent *event);

Retrieves the hardware device that originated the event.

If you need the virtual device, use clutter_event_get_device().

If no hardware device originated this event, this function will return the same device as clutter_event_get_device().

Since 1.6

clutter_event_get_device_id ()

gint
clutter_event_get_device_id (const ClutterEvent *event);

Retrieves the events device id if set.

clutter_event_get_device_type ()

ClutterInputDeviceType
clutter_event_get_device_type (const ClutterEvent *event);

Retrieves the type of the device for event

Since 1.0

clutter_get_current_event_time ()

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.

Since 1.0

clutter_get_current_event ()

const ClutterEvent *
clutter_get_current_event (void);

If an event is currently being processed, return that event. This function is intended to be used to access event state that might not be exposed by higher-level widgets. For example, to get the key modifier state from a Button 'clicked' event.

Since 1.2

enum ClutterModifierType

Masks applied to a ClutterEvent by modifiers.

Note that Clutter may add internal values to events which include reserved values such as CLUTTER_MODIFIER_RESERVED_13_MASK. Your code should preserve and ignore them. You can use CLUTTER_MODIFIER_MASK to remove all reserved values.

Since 0.4

enum ClutterScrollDirection

Direction of a pointer scroll event.

The CLUTTER_SCROLL_SMOOTH value implies that the ClutterScrollEvent has precise scrolling delta information.

Since 0.4

enum ClutterStageState

Stage state masks, used by the ClutterEvent of type CLUTTER_STAGE_STATE.

Since 0.4

enum ClutterEventType

Types of events.

Since 0.4

union ClutterEvent

Generic event wrapper.

Since 0.2

enum ClutterEventFlags

Flags for the ClutterEvent

Since 0.6

struct ClutterButtonEvent

struct ClutterButtonEvent {
  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;
};

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().

Since 0.2

struct ClutterKeyEvent

struct ClutterKeyEvent {
  ClutterEventType type;
  guint32 time;
  ClutterEventFlags flags;
  ClutterStage *stage;
  ClutterActor *source;

  ClutterModifierType modifier_state;
  guint keyval;
  guint16 hardware_keycode;
  gunichar unicode_value;
  ClutterInputDevice *device;
};

Key event

Since 0.2

struct ClutterMotionEvent

struct ClutterMotionEvent {
  ClutterEventType type;
  guint32 time;
  ClutterEventFlags flags;
  ClutterStage *stage;
  ClutterActor *source;

  gfloat x;
  gfloat y;
  ClutterModifierType modifier_state;
  gdouble *axes; /* Future use */
  ClutterInputDevice *device;
};

Event for the pointer motion

Since 0.2

struct ClutterScrollEvent

struct ClutterScrollEvent {
  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;
};

Scroll wheel (or similar device) event

Since 0.2

struct ClutterStageStateEvent

struct ClutterStageStateEvent {
  ClutterEventType type;
  guint32 time;
  ClutterEventFlags flags;
  ClutterStage *stage;
  ClutterActor *source; /* XXX: should probably be the stage itself */

  ClutterStageState changed_mask;
  ClutterStageState new_state;
};

Event signalling a change in the ClutterStage state.

Since 0.2

struct ClutterCrossingEvent

struct ClutterCrossingEvent {
  ClutterEventType type;
  guint32 time;
  ClutterEventFlags flags;
  ClutterStage *stage;
  ClutterActor *source;

  gfloat x;
  gfloat y;
  ClutterInputDevice *device;
  ClutterActor *related;
};

Event for the movement of the pointer across different actors

Since 0.2

struct ClutterTouchEvent

struct ClutterTouchEvent {
  ClutterEventType type;
  guint32 time;
  ClutterEventFlags flags;
  ClutterStage *stage;
  ClutterActor *source;

  gfloat x;
  gfloat y;
  ClutterEventSequence *sequence;
  ClutterModifierType modifier_state;
  gdouble *axes; /* reserved */
  ClutterInputDevice *device;
};

Used for touch events.

The type field will be one of CLUTTER_TOUCH_BEGIN, CLUTTER_TOUCH_END, CLUTTER_TOUCH_UPDATE, or CLUTTER_TOUCH_CANCEL.

Touch events are grouped into sequences; each touch sequence will begin with a CLUTTER_TOUCH_BEGIN event, progress with CLUTTER_TOUCH_UPDATE events, and end either with a CLUTTER_TOUCH_END event or with a CLUTTER_TOUCH_CANCEL event.

With multi-touch capable devices there can be multiple event sequence running at the same time.

Since 1.10

ClutterEventSequence

typedef struct _ClutterEventSequence ClutterEventSequence;

The ClutterEventSequence structure is an opaque type used to denote the event sequence of a touch event.

Since 1.12