mutter/doc/reference/tmpl/clutter-event.sgml

312 lines
3.6 KiB
Plaintext
Raw Normal View History

2006-05-29 08:59:36 +00:00
<!-- ##### SECTION Title ##### -->
clutter-event
<!-- ##### SECTION Short_Description ##### -->
User and window system event functionality
2006-05-29 08:59:36 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
Windowing events handled by Clutter.
2006-05-29 08:59:36 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_CURRENT_TIME ##### -->
<para>
</para>
<!-- ##### MACRO CLUTTER_PRIORITY_EVENTS ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION ClutterFilterFunc ##### -->
<para>
</para>
@event:
@data:
@Returns:
<!-- ##### ENUM ClutterFilterResponse ##### -->
<para>
</para>
@CLUTTER_FILTER_CONTINUE:
@CLUTTER_FILTER_TRANSLATE:
@CLUTTER_FILTER_REMOVE:
<!-- ##### ENUM ClutterScrollDirection ##### -->
<para>
</para>
@CLUTTER_SCROLL_UP:
@CLUTTER_SCROLL_DOWN:
@CLUTTER_SCROLL_LEFT:
@CLUTTER_SCROLL_RIGHT:
<!-- ##### ENUM ClutterStageState ##### -->
<para>
</para>
@CLUTTER_STAGE_STATE_FULLSCREEN:
@CLUTTER_STAGE_STATE_MAXIMIZED:
@CLUTTER_STAGE_STATE_MINIMIZED:
@CLUTTER_STAGE_STATE_OFFSCREEN:
2006-05-29 08:59:36 +00:00
<!-- ##### ENUM ClutterEventType ##### -->
<para>
</para>
2006-06-05 Emmanuele Bassi <ebassi@openedhand.com> * clutter-color.h: * clutter-color.c: Reimplement ClutterColor as a boxed type; add convenience API for color handling, like: add, subtract, shade, HSL color-space conversion, packing and unpacking. * clutter-private.h: Update ClutterMainContext, and export the main context pointer here. * clutter-rectangle.h: * clutter-rectangle.c: Update the color-related code; make clutter_rectangle_new() and empty constructor and provide clutter_rectangle_new_with_color(); provide color setter and getter API. * clutter-label.h: * clutter-label.c: Rename the "font" property to "font-name"; update the color-related code to the new ClutterColor object; rename clutter_label_new() to clutter_label_new_with_text(), and add setters and getters for the properties. * clutter-marshal.list: Add VOID:OBJECT and VOID:BOXED marshallers generators. * clutter-stage.h: * clutter-stage.c: Rework the API: provide a default constructor for a singleton object, named clutter_stage_get_default(), which supercedes the clutter_stage() function in clutter-main; provide new events: button-press-event, button-release-event, key-press-event and key-release-event; update the color-related code; (clutter_stage_snapshot): Allow negative width and height when taking a snapshot (meaning: use full width/height). (clutter_stage_get_element_at_pos): Rename clutter_stage_pick(). * clutter-element.c (clutter_element_paint): Clean up the stage and color related code. * clutter-event.h: * clutter-event.c: Add generic ClutterAnyEvent type; add clutter_event_new(), clutter_event_copy() and clutter_event_free(); make ClutterEvent a boxed type. * clutter-main.h: * clutter-main.c: Remove clutter_stage(); add clutter_main_quit(), for cleanly quitting from clutter_main(); add multiple mainloops support; allocate the ClutterCntx instead of adding it to the stack; re-work the ClutterEvent dispatching. * clutter-group.c (clutter_group_add), (clutter_group_remove): Keep a reference on the element when added to a ClutterGroup. * examples/rects.py * examples/test.c: * examples/test-text.c: * examples/video-cube.c: * examples/super-oh.c: * examples/test-video.c: Update.
2006-06-05 13:38:31 +00:00
@CLUTTER_NOTHING:
2006-05-29 08:59:36 +00:00
@CLUTTER_KEY_PRESS:
@CLUTTER_KEY_RELEASE:
@CLUTTER_MOTION:
@CLUTTER_BUTTON_PRESS:
@CLUTTER_2BUTTON_PRESS:
@CLUTTER_3BUTTON_PRESS:
2006-05-29 08:59:36 +00:00
@CLUTTER_BUTTON_RELEASE:
@CLUTTER_SCROLL:
2007-03-22 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-private.h: Remove inclusion of backend-specific headers; update the main context object; add the declarations for the event queue functions. * clutter/clutter-backend.[ch]: Add the abstract ClutterBackend object, which holds backend-specific settings, the main stage, and the event queue. Every backend must implement a subclass of ClutterBackend and ClutterStage. * clutter/clutter-feature.c: Protect the GLX specific calls behing #ifdef HAVE_CLUTTER_GLX. * clutter/clutter-actor.c: * clutter/clutter-group.c: * clutter/clutter-clone-texture.c: Include GL/gl.h * clutter/clutter-event.[ch]: Update public API and implement the event queue private API; hold a reference on the event objects; move out the keysym-to-unicode table; add the new event types. * clutter/clutter-color.h: Include clutter-fixed.h * clutter/clutter-main.c: Update API; get the main stage from the backend object; process the event received from the queue; lock/unlock the main mutex if we have one; move the initialisation process sooner in the init sequence, in order to have the backend object when we check for options; call the backed vfuncs in the pre/post parse hooks. * clutter/clutter-stage.c: Make ClutterStage and abstract class, implemented by the backends. * clutter/clutter/glx/clutter-glx.h: * clutter/clutter/glx/clutter-backend-glx.[ch]: * clutter/clutter/glx/clutter-event-glx.c: * clutter/clutter/glx/clutter-stage-glx.[ch]: * clutter/clutter/glx/Makefile.am: Add the GLX backend. * clutter/clutter/egl/clutter-backend-egl.[ch]: * clutter/clutter/egl/clutter-event-egl.c: * clutter/clutter/egl/clutter-stage-egl.[ch]: * clutter/clutter/egl/Makefile.am: Add the stub for a EGL backend. * examples/*.c: Update for the new API.
2007-03-22 18:21:59 +00:00
@CLUTTER_STAGE_STATE:
@CLUTTER_DESTROY_NOTIFY:
@CLUTTER_CLIENT_MESSAGE:
@CLUTTER_DELETE:
2006-05-29 08:59:36 +00:00
<!-- ##### UNION ClutterEvent ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterAnyEvent ##### -->
2006-05-29 08:59:36 +00:00
<para>
</para>
@type:
<!-- ##### STRUCT ClutterButtonEvent ##### -->
<para>
</para>
@type:
@time:
@x:
@y:
@modifier_state:
@button:
@axes:
@device:
<!-- ##### STRUCT ClutterKeyEvent ##### -->
<para>
</para>
@type:
@time:
@modifier_state:
@keyval:
@hardware_keycode:
2006-05-29 08:59:36 +00:00
<!-- ##### STRUCT ClutterMotionEvent ##### -->
<para>
</para>
@type:
@time:
@x:
@y:
@modifier_state:
@axes:
@device:
<!-- ##### STRUCT ClutterScrollEvent ##### -->
<para>
</para>
@type:
@time:
@x:
@y:
@direction:
@modifier_state:
@axes:
@device:
<!-- ##### STRUCT ClutterStageStateEvent ##### -->
2006-05-29 08:59:36 +00:00
<para>
</para>
@type:
@changed_mask:
@new_state:
2006-05-29 08:59:36 +00:00
<!-- ##### STRUCT ClutterInputDevice ##### -->
2006-05-29 08:59:36 +00:00
<para>
</para>
<!-- ##### FUNCTION clutter_event_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION clutter_event_copy ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_free ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION clutter_event_type ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_get_coords ##### -->
<para>
</para>
@event:
@x:
@y:
<!-- ##### FUNCTION clutter_event_get_state ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_get_time ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_get ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_event_peek ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_event_put ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION clutter_events_pending ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_button_event_button ##### -->
<para>
</para>
@buttev:
@Returns:
2006-05-29 08:59:36 +00:00
<!-- ##### FUNCTION clutter_key_event_symbol ##### -->
<para>
</para>
@keyev:
@Returns:
<!-- ##### FUNCTION clutter_key_event_code ##### -->
<para>
</para>
@keyev:
@Returns:
<!-- ##### FUNCTION clutter_key_event_unicode ##### -->
<para>
</para>
@keyev:
@Returns:
<!-- ##### FUNCTION clutter_keysym_to_unicode ##### -->
<para>
</para>
@keyval:
@Returns: