clutter-event

clutter-event — User and window system event functionality

Synopsis




enum                ClutterEventType;
                    ClutterAnyEvent;
                    ClutterKeyEvent;
                    ClutterButtonEvent;
                    ClutterMotionEvent;
                    ClutterInputDevice;
union               ClutterEvent;
ClutterEvent*       clutter_event_new                   (ClutterEventType type);
ClutterEvent*       clutter_event_copy                  (ClutterEvent *event);
void                clutter_event_free                  (ClutterEvent *event);
ClutterEventType    clutter_event_type                  (ClutterEvent *event);
guint32             clutter_button_event_time           (ClutterButtonEvent *buttev);
gint                clutter_button_event_x              (ClutterButtonEvent *buttev);
gint                clutter_button_event_y              (ClutterButtonEvent *buttev);
guint32             clutter_key_event_time              (ClutterKeyEvent *keyev);
guint               clutter_key_event_state             (ClutterKeyEvent *keyev);
guint               clutter_key_event_symbol            (ClutterKeyEvent *keyev);
guint16             clutter_key_event_code              (ClutterKeyEvent *keyev);
guint32             clutter_key_event_unicode           (ClutterKeyEvent *keyev);
guint32             clutter_keysym_to_unicode           (guint keyval);


Description

Windowing events handled by Clutter.

Details

enum ClutterEventType

typedef enum 
{
  CLUTTER_NOTHING,
  
  CLUTTER_KEY_PRESS,
  CLUTTER_KEY_RELEASE,
  CLUTTER_MOTION,
  CLUTTER_BUTTON_PRESS,
  CLUTTER_2BUTTON_PRESS, 	/* Double click */
  CLUTTER_BUTTON_RELEASE
} ClutterEventType;


ClutterAnyEvent

typedef struct {
  ClutterEventType  type;
} ClutterAnyEvent;


ClutterKeyEvent

typedef struct {
  ClutterEventType type;
  guint32          time;
  guint            modifier_state;
  guint            keyval;
  guint16          hardware_keycode;
} ClutterKeyEvent;


ClutterButtonEvent

typedef struct {
  ClutterEventType     type;
  guint32              time;
  gint                 x;
  gint                 y;
  guint32              modifier_state;
  guint32              button;
  gdouble             *axes;   /* Future use */
  ClutterInputDevice *device;  /* Future use */
} ClutterButtonEvent;


ClutterMotionEvent

typedef struct {
  ClutterEventType     type;
  guint32              time;
  gint                 x;
  gint                 y;
  guint32              modifier_state;
  gdouble             *axes;	/* Future use */
  ClutterInputDevice *device; 	/* Future use */
} ClutterMotionEvent;


ClutterInputDevice

typedef struct _ClutterInputDevice ClutterInputDevice;


union ClutterEvent

union ClutterEvent
{
  ClutterEventType   type;
  
  ClutterAnyEvent    any;
  ClutterKeyEvent    key;
  ClutterButtonEvent button;
  ClutterMotionEvent motion;
};


clutter_event_new ()

ClutterEvent*       clutter_event_new                   (ClutterEventType type);

Creates a new ClutterEvent of the specified type.

type : The type of event.
Returns : A newly allocated ClutterEvent.

clutter_event_copy ()

ClutterEvent*       clutter_event_copy                  (ClutterEvent *event);

Copies event.

event : A ClutterEvent.
Returns : A newly allocated ClutterEvent

clutter_event_free ()

void                clutter_event_free                  (ClutterEvent *event);

Frees all resources used by event.

event : A ClutterEvent.

clutter_event_type ()

ClutterEventType    clutter_event_type                  (ClutterEvent *event);

Retrieves the type of the event.

event : a ClutterEvent
Returns : a ClutterEventType

clutter_button_event_time ()

guint32             clutter_button_event_time           (ClutterButtonEvent *buttev);

Retrieves the time of the event.

buttev : a ClutterButtonEvent
Returns : the time of the event.

clutter_button_event_x ()

gint                clutter_button_event_x              (ClutterButtonEvent *buttev);

Retrieve the x coordinate of the event.

buttev : a ClutterButtonEvent
Returns : the x coordinate.

clutter_button_event_y ()

gint                clutter_button_event_y              (ClutterButtonEvent *buttev);

Retrieve the y coordinate of the event.

buttev : a ClutterButtonEvent
Returns : the y coordinate

clutter_key_event_time ()

guint32             clutter_key_event_time              (ClutterKeyEvent *keyev);

Retrieves the time of keyev

keyev : A ClutterKeyEvent
Returns : The time that the event occurred

clutter_key_event_state ()

guint               clutter_key_event_state             (ClutterKeyEvent *keyev);

Retrieves the state of the modifier keys whenever the event occurred

keyev : A ClutterKeyEvent
Returns : A mask representing the state of the modifier keys

clutter_key_event_symbol ()

guint               clutter_key_event_symbol            (ClutterKeyEvent *keyev);

Retrieves the value of the key that caused keyev.

keyev : A ClutterKeyEvent
Returns : The keysym representing the key

clutter_key_event_code ()

guint16             clutter_key_event_code              (ClutterKeyEvent *keyev);

Retrieves the keycode of the key that caused keyev.

keyev : A ClutterKeyEvent
Returns : The keycode representing the key

clutter_key_event_unicode ()

guint32             clutter_key_event_unicode           (ClutterKeyEvent *keyev);

Retrieves the unicode value for the key that caused keyev.

keyev : A ClutterKeyEvent
Returns : The unicode value representing the key

clutter_keysym_to_unicode ()

guint32             clutter_keysym_to_unicode           (guint keyval);

Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) character.

keyval : a clutter key symbol
Returns : the corresponding unicode character, or 0 if there is no corresponding character.