mutter/doc/reference/clutter-sections.txt
Emmanuele Bassi 10fbfb1659 2006-12-12 Emmanuele Bassi <ebassi@openedhand.com>
Rework part of the show/hide machinery.  Allow groups sub-classes
	and composite actors to override show_all/hide_all in order to
	decide which children they wish to show/hide.  This means that
	if an actor overrides the default show/hide virtual methods, it'll
	have to chain up to the parent class show/hide.  While we're at it,
	provide the fully recursive clutter_actor_show_all() and
	clutter_actor_hide_all() methods.

	* clutter/clutter-behaviour-path.c: Add apidoc for the ClutterKnot
	functions; add pathological equality case for clutter_knot_equal().

	* clutter/clutter-event.h:
	* clutter/clutter-feature.h:
	* clutter/clutter-behaviour.c:
	* clutter/clutter-behaviour-scale.c:Fix parameters name so that
	gtk-doc doesn't complain.

	* clutter/clutter-actor.c:
	* clutter/clutter-event.c: Add apidoc

	* clutter/clutter-actor.h:
	* clutter/clutter-actor.c: Add a clutter_actor_show_all() and a
	clutter_actor_hide_all() functions; provide a mechanism for
	groups and composited actors to programmatically select what to
	show/hide when clutter_actor_show_all() and clutter_actor_hide_all()
	are called.  If you are overriding the ClutterActor::show or
	the ClutterActor::hide virtual methods you should chain up with
	the parent class.

	* clutter/clutter-group.c: Override show_all and hide_all and
	recursively show/hide every child inside the group;
	clutter_group_show_all() and clutter_group_hide_all() remain as non
	recursive versions of clutter_actor_show_all() and
	clutter_actor_hide_all() (maybe we should rename them in order
	to avoid name clashes with the bindings).

	* clutter/clutter-stage.c:
	* clutter/clutter-texture.c: Chain up with parent class show
	and hide vfuncs.

	* clutter/clutter-clone-texture.h:
	* clutter/clutter-clone-texture.c: Provide API for changing the
	parent texture of a clone texture actor.

	* examples/behave.c:
	* examples/super-oh.c:
	* examples/test.c: Use clutter_actor_show_all() instead of
	clutter_group_show_all().
2006-12-12 20:20:04 +00:00

537 lines
12 KiB
Plaintext

<SECTION>
<FILE>clutter-media</FILE>
CLUTTER_MEDIA_GET_INTERFACE
ClutterMedia
ClutterMediaInterface
clutter_media_set_uri
clutter_media_get_uri
clutter_media_set_playing
clutter_media_get_playing
clutter_media_set_position
clutter_media_get_position
clutter_media_set_volume
clutter_media_get_volume
clutter_media_get_can_seek
clutter_media_get_buffer_percent
clutter_media_get_duration
clutter_media_set_filename
<SUBSECTION Standard>
CLUTTER_MEDIA
CLUTTER_IS_MEDIA
CLUTTER_TYPE_MEDIA
<SUBSECTION Private>
clutter_media_get_type
</SECTION>
<SECTION>
<FILE>clutter-label</FILE>
<TITLE>ClutterLabel</TITLE>
ClutterLabel
ClutterLabelClass
clutter_label_new
clutter_label_new_with_text
clutter_label_set_text
clutter_label_get_text
clutter_label_set_font_name
clutter_label_get_font_name
clutter_label_set_color
clutter_label_get_color
clutter_label_set_ellipsize
clutter_label_get_ellipsize
clutter_label_set_line_wrap
clutter_label_get_line_wrap
clutter_label_set_line_wrap_mode
clutter_label_get_line_wrap_mode
clutter_label_get_layout
clutter_label_set_attributes
clutter_label_get_attributes
clutter_label_set_use_markup
clutter_label_get_use_markup
clutter_label_set_alignment
clutter_label_get_alignment
<SUBSECTION Standard>
CLUTTER_LABEL
CLUTTER_IS_LABEL
CLUTTER_TYPE_LABEL
CLUTTER_LABEL_CLASS
CLUTTER_IS_LABEL_CLASS
CLUTTER_LABEL_GET_CLASS
<SUBSECTION Private>
ClutterLabelPrivate
clutter_label_get_type
</SECTION>
<SECTION>
<FILE>clutter-behaviour</FILE>
<TITLE>ClutterBehaviour</TITLE>
ClutterBehaviour
ClutterBehaviourClass
clutter_behaviour_apply
clutter_behaviour_remove
ClutterBehaviourForeachFunc
clutter_behaviour_actors_foreach
clutter_behaviour_get_actors
clutter_behaviour_get_alpha
clutter_behaviour_set_alpha
<SUBSECTION Standard>
CLUTTER_BEHAVIOUR
CLUTTER_IS_BEHAVIOUR
CLUTTER_TYPE_BEHAVIOUR
CLUTTER_BEHAVIOUR_CLASS
CLUTTER_IS_BEHAVIOUR_CLASS
CLUTTER_BEHAVIOUR_GET_CLASS
<SUBSECTION Private>
ClutterBehaviourPrivate
clutter_behaviour_get_type
</SECTION>
<SECTION>
<FILE>clutter-alpha</FILE>
<TITLE>ClutterAlpha</TITLE>
ClutterAlpha
ClutterAlphaClass
clutter_alpha_new
clutter_alpha_new_full
clutter_alpha_get_alpha
CLUTTER_ALPHA_MAX_ALPHA
ClutterAlphaFunc
clutter_alpha_set_func
clutter_alpha_set_timeline
clutter_alpha_get_timeline
CLUTTER_ALPHA_RAMP_INC
clutter_ramp_inc_func
CLUTTER_ALPHA_RAMP_DEC
clutter_ramp_dec_func
CLUTTER_ALPHA_RAMP
clutter_ramp_func
CLUTTER_ALPHA_SINE
clutter_sine_func
<SUBSECTION Standard>
CLUTTER_ALPHA
CLUTTER_IS_ALPHA
CLUTTER_TYPE_ALPHA
CLUTTER_ALPHA_CLASS
CLUTTER_IS_ALPHA_CLASS
CLUTTER_ALPHA_GET_CLASS
<SUBSECTION Private>
ClutterAlphaPrivate
clutter_alpha_get_type
</SECTION>
<SECTION>
<FILE>clutter-clone-texture</FILE>
<TITLE>ClutterCloneTexture</TITLE>
ClutterCloneTexture
ClutterCloneTextureClass
clutter_clone_texture_new
<SUBSECTION Standard>
CLUTTER_CLONE_TEXTURE
CLUTTER_IS_CLONE_TEXTURE
CLUTTER_TYPE_CLONE_TEXTURE
CLUTTER_CLONE_TEXTURE_CLASS
CLUTTER_IS_CLONE_TEXTURE_CLASS
CLUTTER_CLONE_TEXTURE_GET_CLASS
<SUBSECTION Private>
ClutterCloneTexturePrivate
clutter_clone_texture_get_type
</SECTION>
<SECTION>
<FILE>clutter-group</FILE>
<TITLE>ClutterGroup</TITLE>
ClutterGroup
ClutterGroupClass
clutter_group_new
clutter_group_get_children
clutter_group_foreach
clutter_group_add
clutter_group_add_many_valist
clutter_group_add_many
clutter_group_remove
clutter_group_show_all
clutter_group_hide_all
clutter_group_find_child_by_id
clutter_group_raise
clutter_group_lower
clutter_group_sort_depth_order
<SUBSECTION Standard>
CLUTTER_GROUP
CLUTTER_IS_GROUP
CLUTTER_TYPE_GROUP
CLUTTER_GROUP_CLASS
CLUTTER_IS_GROUP_CLASS
CLUTTER_GROUP_GET_CLASS
<SUBSECTION Private>
ClutterGroupPrivate
clutter_group_get_type
</SECTION>
<SECTION>
<FILE>clutter-rectangle</FILE>
<TITLE>ClutterRectangle</TITLE>
ClutterRectangle
ClutterRectangleClass
clutter_rectangle_new
clutter_rectangle_new_with_color
clutter_rectangle_get_color
clutter_rectangle_set_color
clutter_rectangle_get_border_color
clutter_rectangle_set_border_color
clutter_rectangle_get_border_width
clutter_rectangle_set_border_width
<SUBSECTION Standard>
CLUTTER_RECTANGLE
CLUTTER_IS_RECTANGLE
CLUTTER_TYPE_RECTANGLE
CLUTTER_RECTANGLE_CLASS
CLUTTER_IS_RECTANGLE_CLASS
CLUTTER_RECTANGLE_GET_CLASS
<SUBSECTION Private>
ClutterRectanglePrivate
clutter_rectangle_get_type
</SECTION>
<SECTION>
<FILE>clutter-actor</FILE>
CLUTTER_TYPE_GEOMETRY
CLUTTER_TYPE_ACTOR_BOX
CLUTTER_ACTOR_SET_FLAGS
CLUTTER_ACTOR_UNSET_FLAGS
CLUTTER_ACTOR_IS_MAPPED
CLUTTER_ACTOR_IS_REALIZED
CLUTTER_ACTOR_IS_VISIBLE
ClutterActorBox
ClutterActorFlags
ClutterGeometry
CLUTTER_CALLBACK
ClutterCallback
<TITLE>ClutterActor</TITLE>
ClutterActor
ClutterActorClass
clutter_actor_show
clutter_actor_hide
clutter_actor_realize
clutter_actor_unrealize
clutter_actor_paint
clutter_actor_queue_redraw
clutter_actor_destroy
clutter_actor_request_coords
clutter_actor_allocate_coords
clutter_actor_set_geometry
clutter_actor_get_geometry
clutter_actor_get_coords
clutter_actor_set_size
clutter_actor_get_size
clutter_actor_set_position
clutter_actor_get_abs_position
clutter_actor_get_width
clutter_actor_get_height
clutter_actor_get_x
clutter_actor_get_y
clutter_actor_move_by
clutter_actor_rotate_x
clutter_actor_rotate_y
clutter_actor_rotate_z
clutter_actor_set_opacity
clutter_actor_get_opacity
clutter_actor_set_name
clutter_actor_get_name
clutter_actor_get_id
clutter_actor_set_clip
clutter_actor_remove_clip
clutter_actor_has_clip
clutter_actor_set_parent
clutter_actor_get_parent
clutter_actor_reparent
clutter_actor_unparent
clutter_actor_raise
clutter_actor_lower
clutter_actor_raise_top
clutter_actor_lower_bottom
clutter_actor_set_depth
clutter_actor_get_depth
clutter_actor_set_scalex
clutter_actor_set_scale
clutter_actor_get_scalex
clutter_actor_get_scale
clutter_actor_get_abs_size
<SUBSECTION Standard>
CLUTTER_ACTOR
CLUTTER_IS_ACTOR
CLUTTER_TYPE_ACTOR
CLUTTER_ACTOR_CLASS
CLUTTER_IS_ACTOR_CLASS
CLUTTER_ACTOR_GET_CLASS
<SUBSECTION Private>
ClutterActorPrivate
clutter_actor_get_type
clutter_actor_box_get_type
clutter_geometry_get_type
</SECTION>
<SECTION>
<FILE>clutter-texture</FILE>
<TITLE>ClutterTexture</TITLE>
ClutterTexture
ClutterTextureClass
clutter_texture_new_from_pixbuf
clutter_texture_new
clutter_texture_set_from_data
clutter_texture_set_pixbuf
clutter_texture_get_pixbuf
clutter_texture_get_base_size
clutter_texture_bind_tile
clutter_texture_get_n_tiles
clutter_texture_get_x_tile_detail
clutter_texture_get_y_tile_detail
clutter_texture_has_generated_tiles
clutter_texture_is_tiled
<SUBSECTION Standard>
CLUTTER_TEXTURE
CLUTTER_IS_TEXTURE
CLUTTER_TYPE_TEXTURE
CLUTTER_TEXTURE_CLASS
CLUTTER_IS_TEXTURE_CLASS
CLUTTER_TEXTURE_GET_CLASS
<SUBSECTION Private>
ClutterTexturePrivate
clutter_texture_get_type
</SECTION>
<SECTION>
<FILE>clutter-stage</FILE>
CLUTTER_STAGE_WIDTH
CLUTTER_STAGE_HEIGHT
<TITLE>ClutterStage</TITLE>
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_get_actor_at_pos
clutter_stage_snapshot
clutter_stage_get_xvisual
<SUBSECTION Standard>
CLUTTER_STAGE
CLUTTER_IS_STAGE
CLUTTER_TYPE_STAGE
CLUTTER_STAGE_CLASS
CLUTTER_IS_STAGE_CLASS
CLUTTER_STAGE_GET_CLASS
<SUBSECTION Private>
ClutterStagePrivate
clutter_stage_get_type
</SECTION>
<SECTION>
<FILE>clutter-timeline</FILE>
<TITLE>ClutterTimeline</TITLE>
ClutterTimeline
ClutterTimelineClass
clutter_timeline_new
clutter_timeline_set_speed
clutter_timeline_get_speed
clutter_timeline_start
clutter_timeline_pause
clutter_timeline_stop
clutter_timeline_set_loop
clutter_timeline_get_loop
clutter_timeline_rewind
clutter_timeline_skip
clutter_timeline_advance
clutter_timeline_get_current_frame
clutter_timeline_set_n_frames
clutter_timeline_get_n_frames
clutter_timeline_is_playing
<SUBSECTION Standard>
CLUTTER_TIMELINE
CLUTTER_IS_TIMELINE
CLUTTER_TYPE_TIMELINE
CLUTTER_TIMELINE_CLASS
CLUTTER_IS_TIMELINE_CLASS
CLUTTER_TIMELINE_GET_CLASS
<SUBSECTION Private>
ClutterTimelinePrivate
clutter_timeline_get_type
</SECTION>
<SECTION>
<FILE>clutter-behaviour-path</FILE>
<TITLE>ClutterBehaviourPath</TITLE>
CLUTTER_TYPE_KNOT
ClutterKnot
clutter_knot_copy
clutter_knot_free
clutter_knot_equal
ClutterBehaviourPath
ClutterBehaviourPathClass
clutter_behaviour_path_new
clutter_behaviour_path_get_knots
clutter_behaviour_path_append_knot
clutter_behaviour_path_append_knots
clutter_behaviour_path_insert_knot
clutter_behaviour_path_remove_knot
clutter_behaviour_path_clear
<SUBSECTION Standard>
CLUTTER_BEHAVIOUR_PATH
CLUTTER_IS_BEHAVIOUR_PATH
CLUTTER_TYPE_BEHAVIOUR_PATH
CLUTTER_BEHAVIOUR_PATH_CLASS
CLUTTER_IS_BEHAVIOUR_PATH_CLASS
CLUTTER_BEHAVIOUR_PATH_GET_CLASS
<SUBSECTION Private>
ClutterBehaviourPathPrivate
clutter_knot_get_type
clutter_behaviour_path_get_type
</SECTION>
<SECTION>
<FILE>clutter-behaviour-opacity</FILE>
<TITLE>ClutterBehaviourOpacity</TITLE>
ClutterBehaviourOpacity
ClutterBehaviourOpacityClass
clutter_behaviour_opacity_new
<SUBSECTION Standard>
CLUTTER_BEHAVIOUR_OPACITY
CLUTTER_IS_BEHAVIOUR_OPACITY
CLUTTER_TYPE_BEHAVIOUR_OPACITY
CLUTTER_BEHAVIOUR_OPACITY_CLASS
CLUTTER_IS_BEHAVIOUR_OPACITY_CLASS
CLUTTER_BEHAVIOUR_OPACITY_GET_CLASS
<SUBSECTION Private>
ClutterBehaviourOpacityPrivate
clutter_behaviour_opacity_get_type
</SECTION>
<SECTION>
<FILE>clutter-behaviour-scale</FILE>
<TITLE>ClutterBehaviourScale</TITLE>
ClutterGravity
ClutterBehaviourScale
ClutterBehaviourScaleClass
clutter_behaviour_scale_new
clutter_behaviour_scale_newx
<SUBSECTION Standard>
CLUTTER_BEHAVIOUR_SCALE
CLUTTER_IS_BEHAVIOUR_SCALE
CLUTTER_TYPE_BEHAVIOUR_SCALE
CLUTTER_BEHAVIOUR_SCALE_CLASS
CLUTTER_IS_BEHAVIOUR_SCALE_CLASS
CLUTTER_BEHAVIOUR_SCALE_GET_CLASS
<SUBSECTION Private>
ClutterBehaviourScalePrivate
clutter_behaviour_scale_get_type
</SECTION>
<SECTION>
<FILE>clutter-util</FILE>
clutter_util_trap_x_errors
clutter_util_untrap_x_errors
clutter_util_next_p2
</SECTION>
<SECTION>
<FILE>clutter-feature</FILE>
ClutterFeatureFlags
clutter_feature_available
clutter_feature_get_all
clutter_feature_wait_for_vblank
</SECTION>
<SECTION>
<FILE>clutter-fixed</FILE>
ClutterFixed
CFX_Q
CFX_ONE
CFX_MAX
CFX_MIN
CLUTTER_FIXED_TO_FLOAT
CLUTTER_FIXED_TO_DOUBLE
CLUTTER_FLOAT_TO_FIXED
CLUTTER_INT_TO_FIXED
CLUTTER_FIXED_INT
CLUTTER_FIXED_FRACTION
CLUTTER_FIXED_FLOOR
CLUTTER_FIXED_CEIL
CLUTTER_FIXED_MUL
CLUTTER_FIXED_DIV
</SECTION>
<SECTION>
<FILE>clutter-color</FILE>
CLUTTER_TYPE_COLOR
ClutterColor
clutter_color_parse
clutter_color_add
clutter_color_subtract
clutter_color_lighten
clutter_color_darken
clutter_color_shade
clutter_color_to_hls
clutter_color_from_hls
clutter_color_to_pixel
clutter_color_from_pixel
<SUBSECTION Private>
clutter_color_get_type
</SECTION>
<SECTION>
<FILE>clutter-event</FILE>
ClutterEventType
CLUTTER_TYPE_EVENT
ClutterAnyEvent
ClutterKeyEvent
ClutterButtonEvent
ClutterMotionEvent
ClutterInputDevice
ClutterEvent
clutter_event_new
clutter_event_copy
clutter_event_free
clutter_key_event_type
clutter_key_event_time
clutter_key_event_state
clutter_button_event_x
clutter_button_event_y
clutter_key_event_symbol
clutter_key_event_code
clutter_key_event_unicode
clutter_keysym_to_unicode
<SUBSECTION Private>
clutter_event_get_type
</SECTION>
<SECTION>
<FILE>clutter-main</FILE>
CLUTTER_INIT_ERROR
ClutterInitError
clutter_init
clutter_init_with_args
clutter_get_option_group
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
<SUBSECTION Private>
clutter_init_error_quark
</SECTION>
<SECTION>
<FILE>clutter-version</FILE>
CLUTTER_MAJOR_VERSION
CLUTTER_MINOR_VERSION
CLUTTER_MICRO_VERSION
CLUTTER_VERSION
CLUTTER_VERSION_S
CLUTTER_VERSION_HEX
CLUTTER_CHECK_VERSION
</SECTION>