Struct
ClutterEvent
Description [src]
union ClutterEvent {
/* No available fields */
}
User and window system events
The events usually come from the windowing backend, but can also be synthesized by Clutter itself or by the application code.
Constructors
clutter_event_new
Creates a new ClutterEvent
of the specified type.
Functions
clutter_event_add_filter
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.
clutter_event_get
Pops an event off the event queue. Applications should not need to call this.
clutter_event_remove_filter
Removes an event filter that was previously added with clutter_event_add_filter().
Instance methods
clutter_event_copy
Copies event
.
clutter_event_free
Frees all resources used by event
.
clutter_event_get_angle
Retrieves the angle relative from source
to target
.
clutter_event_get_axes
Retrieves the array of axes values attached to the event.
clutter_event_get_button
Retrieves the button number of event
.
clutter_event_get_coords
Retrieves the coordinates of event
and puts them into x
and y
.
clutter_event_get_device
Retrieves the ClutterInputDevice
for the event.
If you want the physical device the event originated from, use clutter_event_get_source_device().
clutter_event_get_device_tool
Returns the device tool that originated this event.
clutter_event_get_device_type
Retrieves the type of the device for event
.
clutter_event_get_distance
Retrieves the distance between two events, a source
and a target
.
clutter_event_get_event_code
clutter_event_get_event_sequence
Retrieves the ClutterEventSequence
of event
.
clutter_event_get_flags
Retrieves the ClutterEventFlags
of event
.
clutter_event_get_gesture_motion_delta
Returns the gesture motion deltas relative to the current pointer position.4
clutter_event_get_gesture_motion_delta_unaccelerated
Returns the unaccelerated gesture motion deltas relative to the current pointer position. Unlike clutter_event_get_gesture_motion_delta(), pointer acceleration is ignored.
clutter_event_get_gesture_phase
Returns the phase of the event, See ClutterTouchpadGesturePhase
.
clutter_event_get_gesture_pinch_angle_delta
Returns the angle delta reported by this specific event.
clutter_event_get_gesture_pinch_scale
Returns the current scale as reported by event
, 1.0 being the original
distance at the time the corresponding event with phase
CLUTTER_TOUCHPAD_GESTURE_PHASE_BEGIN
is received.
is received.
clutter_event_get_key_code
Retrieves the keycode of the key that caused event
.
clutter_event_get_key_symbol
Retrieves the key symbol of event
.
clutter_event_get_key_unicode
Retrieves the unicode value for the key that caused keyev
.
clutter_event_get_mode_group
clutter_event_get_pad_event_details
Returns the details of a pad event.
clutter_event_get_position
Retrieves the event coordinates as a #graphene_point_t.
clutter_event_get_related
Retrieves the related actor of a crossing event.
clutter_event_get_relative_motion
clutter_event_get_scroll_delta
Retrieves the precise scrolling information of event
.
clutter_event_get_scroll_direction
Retrieves the direction of the scrolling of event
.
clutter_event_get_scroll_finish_flags
Returns the ClutterScrollFinishFlags
of an scroll event. Those
can be used to determine whether post-scroll effects like kinetic
scrolling should be applied.
clutter_event_get_scroll_source
Returns the ClutterScrollSource
that applies to an scroll event.
clutter_event_get_source
Retrieves the source ClutterActor
the event originated from, or
NULL if the event has no source.
clutter_event_get_source_device
Retrieves the hardware device that originated the event.
clutter_event_get_stage
Retrieves the source ClutterStage
the event originated for, or
NULL
if the event has no stage.
clutter_event_get_state
Retrieves the modifier state of the event. In case the window system supports reporting latched and locked modifiers, this function returns the effective state.
clutter_event_get_state_full
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.
clutter_event_get_time
Retrieves the time of the event.
clutter_event_get_time_us
clutter_event_get_touchpad_gesture_finger_count
Returns the number of fingers that is triggering the touchpad gesture.
clutter_event_has_control_modifier
Checks whether event
has the Control modifier mask set.
clutter_event_has_shift_modifier
Checks whether event
has the Shift modifier mask set.
clutter_event_is_pointer_emulated
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).
clutter_event_put
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.
clutter_event_set_button
Sets the button number of event
.
clutter_event_set_coords
Sets the coordinates of the event
.
clutter_event_set_device
Sets the device for event
.
clutter_event_set_device_tool
Sets the tool in use for this event8
clutter_event_set_flags
Sets the ClutterEventFlags
of event
.
clutter_event_set_key_code
Sets the keycode of the event
.
clutter_event_set_key_symbol
Sets the key symbol of event
.
clutter_event_set_key_unicode
Sets the Unicode value of event
.
clutter_event_set_related
Sets the related actor of a crossing event.
clutter_event_set_scroll_delta
Sets the precise scrolling information of event
.
clutter_event_set_scroll_direction
Sets the direction of the scrolling of event
.
clutter_event_set_source
Sets the source ClutterActor
of event
.
clutter_event_set_source_device
Sets the source ClutterInputDevice
for event
.
clutter_event_set_stage
Sets the source ClutterStage
of the event.
clutter_event_set_state
Sets the modifier state of the event.
clutter_event_set_time
Sets the time of the event.
clutter_event_type
Retrieves the type of the event.