[docs] Update the API reference

Add all the unused API to the sections file; there are still
some undocumented bits, but clutter-unused.txt is empty for
the time being.

Also, add ClutterText to the main XML document and remove
ClutterLabel and ClutterEntry.
This commit is contained in:
Emmanuele Bassi 2008-12-11 15:01:28 +00:00
parent a50dfefbc3
commit c8dbbfaacf
4 changed files with 132 additions and 6 deletions

View File

@ -55,6 +55,7 @@ CFILE_GLOB=$(top_srcdir)/clutter/*.c
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=\ IGNORE_HFILES=\
clutter.h \ clutter.h \
clutter-bezier.h \
clutter-debug.h \ clutter-debug.h \
clutter-deprecated.h \ clutter-deprecated.h \
clutter-enum-types.h \ clutter-enum-types.h \

View File

@ -57,8 +57,7 @@
<xi:include href="xml/clutter-rectangle.xml"/> <xi:include href="xml/clutter-rectangle.xml"/>
<xi:include href="xml/clutter-texture.xml"/> <xi:include href="xml/clutter-texture.xml"/>
<xi:include href="xml/clutter-clone-texture.xml"/> <xi:include href="xml/clutter-clone-texture.xml"/>
<xi:include href="xml/clutter-label.xml"/> <xi:include href="xml/clutter-text.xml"/>
<xi:include href="xml/clutter-entry.xml"/>
</chapter> </chapter>
<chapter> <chapter>

View File

@ -170,6 +170,9 @@ clutter_smoothstep_inc_func
clutter_smoothstep_dec_func clutter_smoothstep_dec_func
clutter_exp_inc_func clutter_exp_inc_func
clutter_exp_dec_func clutter_exp_dec_func
clutter_exp_in_func
clutter_exp_out_func
clutter_exp_in_out_func
clutter_ease_in_func clutter_ease_in_func
clutter_ease_out_func clutter_ease_out_func
clutter_ease_in_out_func clutter_ease_in_out_func
@ -438,6 +441,8 @@ clutter_actor_get_reactive
clutter_actor_set_shader clutter_actor_set_shader
clutter_actor_get_shader clutter_actor_get_shader
clutter_actor_set_shader_param clutter_actor_set_shader_param
clutter_actor_set_shader_param_int
clutter_actor_set_shader_param_float
<SUBSECTION> <SUBSECTION>
clutter_actor_set_depthu clutter_actor_set_depthu
@ -471,6 +476,9 @@ clutter_actor_get_scalex
clutter_actor_set_rotationx clutter_actor_set_rotationx
clutter_actor_get_rotationx clutter_actor_get_rotationx
<SUBSECTION>
clutter_actor_grab_key_focus
<SUBSECTION Standard> <SUBSECTION Standard>
CLUTTER_TYPE_GEOMETRY CLUTTER_TYPE_GEOMETRY
CLUTTER_TYPE_ACTOR_BOX CLUTTER_TYPE_ACTOR_BOX
@ -693,6 +701,8 @@ ClutterPathCallback
ClutterPathNodeType ClutterPathNodeType
clutter_path_new clutter_path_new
clutter_path_new_with_description clutter_path_new_with_description
<SUBSECTION>
clutter_path_add_move_to clutter_path_add_move_to
clutter_path_add_rel_move_to clutter_path_add_rel_move_to
clutter_path_add_line_to clutter_path_add_line_to
@ -702,6 +712,8 @@ clutter_path_add_rel_curve_to
clutter_path_add_close clutter_path_add_close
clutter_path_add_string clutter_path_add_string
clutter_path_add_node clutter_path_add_node
<SUBSECTION>
clutter_path_get_n_nodes clutter_path_get_n_nodes
clutter_path_get_node clutter_path_get_node
clutter_path_get_nodes clutter_path_get_nodes
@ -720,6 +732,21 @@ ClutterPathNode
clutter_path_node_copy clutter_path_node_copy
clutter_path_node_free clutter_path_node_free
clutter_path_node_equal clutter_path_node_equal
<SUBSECTION Standard>
CLUTTER_TYPE_PATH
CLUTTER_TYPE_PATH_NODE
CLUTTER_PATH
CLUTTER_PATH_CLASS
CLUTTER_IS_PATH
CLUTTER_IS_PATH_CLASS
CLUTTER_PATH_GET_CLASS
CLUTTER_PATH_RELATIVE
<SUBSECTION Private>
ClutterPathPrivate
clutter_path_get_type
clutter_path_node_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1510,11 +1537,27 @@ clutter_shader_release
clutter_shader_is_compiled clutter_shader_is_compiled
clutter_shader_set_is_enabled clutter_shader_set_is_enabled
clutter_shader_get_is_enabled clutter_shader_get_is_enabled
clutter_shader_set_uniform_1f
<SUBSECTION>
clutter_shader_set_uniform clutter_shader_set_uniform
clutter_shader_get_cogl_program clutter_shader_get_cogl_program
clutter_shader_get_cogl_fragment_shader clutter_shader_get_cogl_fragment_shader
clutter_shader_get_cogl_vertex_shader clutter_shader_get_cogl_vertex_shader
clutter_shader_set_uniform_1f
<SUBSECTION>
ClutterShaderFloat
CLUTTER_VALUE_HOLDS_SHADER_FLOAT
clutter_value_set_shader_float
clutter_value_get_shader_float
ClutterShaderInt
CLUTTER_VALUE_HOLDS_SHADER_INT
clutter_value_set_shader_int
clutter_value_get_shader_int
ClutterShaderMatrix
CLUTTER_VALUE_HOLDS_SHADER_MATRIX
clutter_value_set_shader_matrix
clutter_value_get_shader_matrix
<SUBSECTION Standard> <SUBSECTION Standard>
CLUTTER_IS_SHADER CLUTTER_IS_SHADER
@ -1524,10 +1567,17 @@ CLUTTER_SHADER_CLASS
CLUTTER_SHADER_ERROR CLUTTER_SHADER_ERROR
CLUTTER_SHADER_GET_CLASS CLUTTER_SHADER_GET_CLASS
CLUTTER_TYPE_SHADER CLUTTER_TYPE_SHADER
CLUTTER_TYPE_SHADER_FLOAT
CLUTTER_TYPE_SHADER_INT
CLUTTER_TYPE_SHADER_MATRIX
<SUBSECTION Private> <SUBSECTION Private>
ClutterShaderPrivate ClutterShaderPrivate
clutter_shader_get_type clutter_shader_get_type
clutter_shader_error_quark clutter_shader_error_quark
clutter_shader_float_get_type
clutter_shader_int_get_type
clutter_shader_matrix_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1593,6 +1643,10 @@ clutter_interval_peek_final_value
clutter_interval_set_interval clutter_interval_set_interval
clutter_interval_get_interval clutter_interval_get_interval
<SUBSECTION>
clutter_interval_compute_value
clutter_interval_validate
<SUBSECTION Standard> <SUBSECTION Standard>
CLUTTER_TYPE_INTERVAL CLUTTER_TYPE_INTERVAL
CLUTTER_INTERVAL CLUTTER_INTERVAL
@ -1614,7 +1668,7 @@ ClutterBindingActionFunc
<SUBSECTION> <SUBSECTION>
clutter_binding_pool_new clutter_binding_pool_new
clutter_binding_pool_get_from_class clutter_binding_pool_get_for_class
clutter_binding_pool_find clutter_binding_pool_find
<SUBSECTION> <SUBSECTION>
@ -1629,3 +1683,76 @@ clutter_binding_pool_unblock_action
<SUBSECTION> <SUBSECTION>
clutter_binding_pool_activate clutter_binding_pool_activate
</SECTION> </SECTION>
<SECTION>
<TITLE>ClutterText</TITLE>
<FILE>clutter-text</FILE>
ClutterText
ClutterTextClass
clutter_text_new
clutter_text_new_full
clutter_text_new_with_text
<SUBSECTION>
clutter_text_set_text
clutter_text_get_text
clutter_text_set_activatable
clutter_text_get_activatable
clutter_text_set_alignment
clutter_text_get_alignment
clutter_text_set_attributes
clutter_text_get_attributes
clutter_text_set_color
clutter_text_get_color
clutter_text_set_ellipsize
clutter_text_get_ellipsize
clutter_text_set_font_name
clutter_text_get_font_name
clutter_text_set_invisible_char
clutter_text_get_invisible_char
clutter_text_set_justify
clutter_text_get_justify
clutter_text_get_layout
clutter_text_set_line_wrap
clutter_text_get_line_wrap
clutter_text_set_line_wrap_mode
clutter_text_get_line_wrap_mode
clutter_text_set_max_length
clutter_text_get_max_length
clutter_text_set_selectable
clutter_text_get_selectable
clutter_text_get_selection
clutter_text_set_selection_bound
clutter_text_get_selection_bound
clutter_text_set_text_visible
clutter_text_get_text_visible
clutter_text_set_use_markup
clutter_text_get_use_markup
<SUBSECTION>
clutter_text_set_editable
clutter_text_get_editable
clutter_text_insert_text
clutter_text_insert_unichar
clutter_text_delete_chars
clutter_text_delete_text
clutter_text_get_chars
clutter_text_set_cursor_color
clutter_text_get_cursor_color
clutter_text_set_cursor_position
clutter_text_get_cursor_position
clutter_text_set_cursor_visible
clutter_text_get_cursor_visible
<SUBSECTION Standard>
CLUTTER_IS_TEXT
CLUTTER_IS_TEXT_CLASS
CLUTTER_TEXT
CLUTTER_TEXT_CLASS
CLUTTER_TEXT_GET_CLASS
CLUTTER_TYPE_TEXT
<SUBSECTION Private>
ClutterTextPrivate
clutter_text_get_type
</SECTION>

View File

@ -6,7 +6,6 @@ clutter_stage_get_type
clutter_rectangle_get_type clutter_rectangle_get_type
clutter_texture_get_type clutter_texture_get_type
clutter_clone_texture_get_type clutter_clone_texture_get_type
clutter_label_get_type
clutter_timeline_get_type clutter_timeline_get_type
clutter_media_get_type clutter_media_get_type
clutter_behaviour_get_type clutter_behaviour_get_type
@ -19,7 +18,6 @@ clutter_path_get_type
clutter_behaviour_rotate_get_type clutter_behaviour_rotate_get_type
clutter_behaviour_scale_get_type clutter_behaviour_scale_get_type
clutter_backend_get_type clutter_backend_get_type
clutter_entry_get_type
clutter_script_get_type clutter_script_get_type
clutter_scriptable_get_type clutter_scriptable_get_type
clutter_model_get_type clutter_model_get_type
@ -28,3 +26,4 @@ clutter_list_model_get_type
clutter_score_get_type clutter_score_get_type
clutter_shader_get_type clutter_shader_get_type
clutter_child_meta_get_type clutter_child_meta_get_type
clutter_text_get_type