From a1ea7d2051eca1f385d791100103aa171212c223 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 22 Mar 2007 20:23:29 +0000 Subject: [PATCH] 2007-03-22 Emmanuele Bassi * clutter-sections.txt: Update with the backend and API changes * Makefile.am: Don't check into the backend subdirs. --- doc/reference/ChangeLog | 7 + doc/reference/Makefile.am | 7 +- doc/reference/clutter-sections.txt | 89 +++++++++--- doc/reference/tmpl/clutter-alpha.sgml | 17 +++ doc/reference/tmpl/clutter-event.sgml | 173 ++++++++++++++++++++++-- doc/reference/tmpl/clutter-fixed.sgml | 8 ++ doc/reference/tmpl/clutter-group.sgml | 8 ++ doc/reference/tmpl/clutter-main.sgml | 24 ++++ doc/reference/tmpl/clutter-stage.sgml | 57 ++++++++ doc/reference/tmpl/clutter-version.sgml | 7 + 10 files changed, 365 insertions(+), 32 deletions(-) diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog index a63479000..f70c559ab 100644 --- a/doc/reference/ChangeLog +++ b/doc/reference/ChangeLog @@ -1,3 +1,10 @@ +2007-03-22 Emmanuele Bassi + + * clutter-sections.txt: Update with the backend and API + changes + + * Makefile.am: Don't check into the backend subdirs. + 2007-01-18 Emmanuele Bassi * clutter-sections.txt: Add forgotten ClutterGroup API. diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 4eaccb4ff..3134b1ac1 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -42,7 +42,7 @@ FIXXREF_OPTIONS= # Used for dependencies. The docs will be rebuilt if any of these change. # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c -HFILE_GLOB=$(top_srcdir)/clutter/*.h +HFILE_GLOB=$(top_srcdir)/clutter/*.h $(top_srcdir)/clutter/glx/clutter-glx.h CFILE_GLOB=$(top_srcdir)/clutter/*.c # Header files to ignore when scanning. @@ -52,10 +52,13 @@ IGNORE_HFILES=\ clutter-private.h \ clutter-marshal.h \ clutter-keysyms.h \ + clutter-keysyms-table.h \ clutter-enum-types.h \ stamp-clutter-enum-types.h \ stamp-clutter-marshal.h \ - pango + pango \ + glx \ + egl # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt index 0f232f80a..d6e8cc233 100644 --- a/doc/reference/clutter-sections.txt +++ b/doc/reference/clutter-sections.txt @@ -109,6 +109,8 @@ CLUTTER_ALPHA_RAMP clutter_ramp_func CLUTTER_ALPHA_SINE clutter_sine_func +CLUTTER_ALPHA_SQUARE +clutter_square_func CLUTTER_ALPHA CLUTTER_IS_ALPHA @@ -155,6 +157,7 @@ clutter_group_add clutter_group_add_many_valist clutter_group_add_many clutter_group_remove +clutter_group_remove_all clutter_group_show_all clutter_group_hide_all clutter_group_find_child_by_id @@ -317,13 +320,15 @@ CLUTTER_STAGE_HEIGHT ClutterStage ClutterStageClass clutter_stage_get_default -clutter_stage_get_xwindow -clutter_stage_set_xwindow_foreign clutter_stage_set_color clutter_stage_get_color +clutter_stage_fullscreen +clutter_stage_unfullscreen +clutter_stage_show_cursor +clutter_stage_hide_cursor clutter_stage_get_actor_at_pos clutter_stage_snapshot -clutter_stage_get_xvisual +clutter_stage_flush CLUTTER_STAGE CLUTTER_IS_STAGE @@ -436,6 +441,31 @@ ClutterBehaviourScalePrivate clutter_behaviour_scale_get_type +
+clutter-backend +ClutterBackend +ClutterBackend +clutter_backend_get_stage +clutter_backend_get_event +clutter_backend_peek_event +clutter_backend_put_event + +CLUTTER_BACKEND +CLUTTER_IS_BACKEND +CLUTTER_BACKEND_CLASS +CLUTTER_IS_BACKEND_CLASS +CLUTTER_BACKEND_GET_CLASS +CLUTTER_TYPE_BACKEND + +ClutterBackendClass +clutter_backend_get_type +clutter_backend_add_options +clutter_backend_init_stage +clutter_backend_init_events +clutter_backend_pre_parse +clutter_backend_post_parse +
+
clutter-util clutter_util_trap_x_errors @@ -475,6 +505,7 @@ CFX_MUL CLUTTER_FIXED_TO_FLOAT CLUTTER_FIXED_TO_DOUBLE CLUTTER_FLOAT_TO_FIXED +CLUTTER_FLOAT_TO_INT CLUTTER_INT_TO_FIXED CLUTTER_FIXED_INT CLUTTER_FIXED_FRACTION @@ -516,22 +547,34 @@ clutter_color_get_type
clutter-event +CLUTTER_CURRENT_TIME +CLUTTER_PRIORITY_EVENTS +ClutterFilterFunc +ClutterFilterResponse +ClutterScrollDirection +ClutterScrollEvent +ClutterStageState ClutterEventType -ClutterAnyEvent -ClutterKeyEvent -ClutterButtonEvent -ClutterMotionEvent -ClutterInputDevice ClutterEvent +ClutterAnyEvent +ClutterButtonEvent +ClutterKeyEvent +ClutterMotionEvent +ClutterScollEvent +ClutterStageStateEvent +ClutterInputDevice clutter_event_new clutter_event_copy clutter_event_free clutter_event_type -clutter_button_event_time -clutter_button_event_x -clutter_button_event_y -clutter_key_event_time -clutter_key_event_state +clutter_event_get_coords +clutter_event_get_state +clutter_event_get_time +clutter_event_get +clutter_event_peek +clutter_event_put +clutter_events_pending +clutter_button_event_button clutter_key_event_symbol clutter_key_event_code clutter_key_event_unicode @@ -549,20 +592,31 @@ ClutterInitError clutter_init clutter_init_with_args clutter_get_option_group +clutter_get_debug_enabled +clutter_get_show_fps +clutter_get_vblank_method clutter_main clutter_main_quit clutter_main_level clutter_redraw -clutter_xdisplay -clutter_xscreen -clutter_root_xwindow -clutter_want_debug clutter_threads_enter clutter_threads_leave clutter_init_error_quark
+
+clutter-glx +clutter_glx_get_default_display +clutter_glx_get_default_screen +clutter_glx_get_root_window +clutter_glx_get_stage_visual +clutter_glx_get_stage_window +clutter_glx_set_stage_foreign +clutter_glx_trap_x_errors +clutter_glx_untrap_x_errors +
+
clutter-version CLUTTER_MAJOR_VERSION @@ -572,4 +626,5 @@ CLUTTER_VERSION CLUTTER_VERSION_S CLUTTER_VERSION_HEX CLUTTER_CHECK_VERSION +CLUTTER_FLAVOUR
diff --git a/doc/reference/tmpl/clutter-alpha.sgml b/doc/reference/tmpl/clutter-alpha.sgml index 2c8c15e72..9c01bd988 100644 --- a/doc/reference/tmpl/clutter-alpha.sgml +++ b/doc/reference/tmpl/clutter-alpha.sgml @@ -191,3 +191,20 @@ Symbolic name for passing clutter_sine_func(). @Returns: + + + + + + + + + + + + +@alpha: +@dummy: +@Returns: + + diff --git a/doc/reference/tmpl/clutter-event.sgml b/doc/reference/tmpl/clutter-event.sgml index cfc64e47a..34b0bb5f8 100644 --- a/doc/reference/tmpl/clutter-event.sgml +++ b/doc/reference/tmpl/clutter-event.sgml @@ -17,6 +17,72 @@ Windowing events handled by Clutter. + + + + + + + + + + + + + + + + + + + +@event: +@data: +@Returns: + + + + + + + +@CLUTTER_FILTER_CONTINUE: +@CLUTTER_FILTER_REMOVE: + + + + + + +@CLUTTER_SCROLL_UP: +@CLUTTER_SCROLL_DOWN: +@CLUTTER_SCROLL_LEFT: +@CLUTTER_SCROLL_RIGHT: + + + + + + +@type: +@time: +@x: +@y: +@direction: +@modifier_state: +@axes: +@device: + + + + + + +@CLUTTER_STAGE_STATE_FULLSCREEN: +@CLUTTER_STAGE_STATE_MAXIMIZED: +@CLUTTER_STAGE_STATE_MINIMIZED: +@CLUTTER_STAGE_STATE_OFFSCREEN: + @@ -28,8 +94,17 @@ Windowing events handled by Clutter. @CLUTTER_MOTION: @CLUTTER_BUTTON_PRESS: @CLUTTER_2BUTTON_PRESS: +@CLUTTER_3BUTTON_PRESS: @CLUTTER_BUTTON_RELEASE: +@CLUTTER_SCROLL: @CLUTTER_STAGE_STATE: +@CLUTTER_DESTROY_NOTIFY: + + + + + + @@ -38,17 +113,6 @@ Windowing events handled by Clutter. @type: - - - - - -@type: -@time: -@modifier_state: -@keyval: -@hardware_keycode: - @@ -63,6 +127,17 @@ Windowing events handled by Clutter. @axes: @device: + + + + + +@type: +@time: +@modifier_state: +@keyval: +@hardware_keycode: + @@ -76,13 +151,16 @@ Windowing events handled by Clutter. @axes: @device: - + +@type: +@changed_mask: +@new_state: - + @@ -123,6 +201,75 @@ Windowing events handled by Clutter. @Returns: + + + + + +@event: +@x: +@y: + + + + + + + +@event: +@Returns: + + + + + + + +@event: +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@event: + + + + + + + +@Returns: + + + + + + + +@buttev: +@Returns: + + diff --git a/doc/reference/tmpl/clutter-fixed.sgml b/doc/reference/tmpl/clutter-fixed.sgml index 4c23a293f..9c42a6b1d 100644 --- a/doc/reference/tmpl/clutter-fixed.sgml +++ b/doc/reference/tmpl/clutter-fixed.sgml @@ -204,6 +204,14 @@ Macro for converting floating point numbers to #ClutterFixed. @x: double or float + + + + + +@x: + + Macro for converting integers to #ClutterFixed. diff --git a/doc/reference/tmpl/clutter-group.sgml b/doc/reference/tmpl/clutter-group.sgml index 7f5affcf1..a9dcaf9c9 100644 --- a/doc/reference/tmpl/clutter-group.sgml +++ b/doc/reference/tmpl/clutter-group.sgml @@ -129,6 +129,14 @@ The #ClutterActor @arg1 was removed from the group. @actor: + + + + + +@self: + + diff --git a/doc/reference/tmpl/clutter-main.sgml b/doc/reference/tmpl/clutter-main.sgml index f8047517f..1582b4e03 100644 --- a/doc/reference/tmpl/clutter-main.sgml +++ b/doc/reference/tmpl/clutter-main.sgml @@ -67,6 +67,30 @@ Error codes for the Clutter initialisation process. @Returns: + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + diff --git a/doc/reference/tmpl/clutter-stage.sgml b/doc/reference/tmpl/clutter-stage.sgml index 268eec0f0..a16e1c052 100644 --- a/doc/reference/tmpl/clutter-stage.sgml +++ b/doc/reference/tmpl/clutter-stage.sgml @@ -53,6 +53,13 @@ Macro evaluating to the height of the #ClutterStage @clutterstage: the object which received the signal. @arg1: + + + + + +@clutterstage: the object which received the signal. + @@ -85,6 +92,14 @@ Macro evaluating to the height of the #ClutterStage @clutterstage: the object which received the signal. @arg1: + + + + + +@clutterstage: the object which received the signal. +@arg1: + @@ -120,10 +135,12 @@ Macro evaluating to the height of the #ClutterStage @input_event: @button_press_event: @button_release_event: +@scroll_event: @key_press_event: @key_release_event: @motion_event: @stage_state_event: +@delete_event: @_clutter_stage1: @_clutter_stage2: @_clutter_stage3: @@ -157,6 +174,38 @@ Macro evaluating to the height of the #ClutterStage @color: + + + + + +@stage: + + + + + + + +@stage: + + + + + + + +@stage: + + + + + + + +@stage: + + @@ -181,3 +230,11 @@ Macro evaluating to the height of the #ClutterStage @Returns: + + + + + +@stage: + + diff --git a/doc/reference/tmpl/clutter-version.sgml b/doc/reference/tmpl/clutter-version.sgml index a6054e6ac..8288fab8b 100644 --- a/doc/reference/tmpl/clutter-version.sgml +++ b/doc/reference/tmpl/clutter-version.sgml @@ -71,3 +71,10 @@ than the passed-in version. @micro: micro version (e.g. 3, for 1.2.3) + + + + + + +