isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-23 03:22:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document ClutterStage properties

Browse Source 
Add missing documentation for the ClutterStage properties and enable the
properties and signals in the gtk-doc API reference.
This commit is contained in:
Emmanuele Bassi 2007-08-21 15:47:51 +00:00
parent b1c040ce19
commit 886f47c94c
2 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
clutter/clutter-stage.c
View File

@ -219,7 +219,7 @@ clutter_stage_class_init (ClutterStageClass *klass)
actor_class->paint = clutter_stage_paint; actor_class->paint = clutter_stage_paint;
/** /**
* ClutterStage:fullscreen * ClutterStage:fullscreen:
* *
* Whether the stage should be fullscreen or not. * Whether the stage should be fullscreen or not.
*/ */
@ -230,7 +230,11 @@ clutter_stage_class_init (ClutterStageClass *klass)
"Whether the main stage is fullscreen", "Whether the main stage is fullscreen",
FALSE, FALSE,
G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE)); G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE));
/**
* ClutterStage:offscreen:
*
* Whether the stage should be rendered in an offscreen buffer.
*/
g_object_class_install_property g_object_class_install_property
(gobject_class, PROP_OFFSCREEN, (gobject_class, PROP_OFFSCREEN,
g_param_spec_boolean ("offscreen", g_param_spec_boolean ("offscreen",
@ -238,8 +242,11 @@ clutter_stage_class_init (ClutterStageClass *klass)
"Whether the main stage is renderer offscreen", "Whether the main stage is renderer offscreen",
FALSE, FALSE,
G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE)); G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE));
/**
* ClutterStage:cursor-visible:
*
* Whether the mouse pointer should be visible
*/
g_object_class_install_property g_object_class_install_property
(gobject_class, PROP_CURSOR_VISIBLE, (gobject_class, PROP_CURSOR_VISIBLE,
g_param_spec_boolean ("cursor-visible", g_param_spec_boolean ("cursor-visible",
@ -247,7 +254,13 @@ clutter_stage_class_init (ClutterStageClass *klass)
"Whether the mouse pointer is visible on the main stage ", "Whether the mouse pointer is visible on the main stage ",
TRUE, TRUE,
G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE)); G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE));
/**
* ClutterStage:user-resizable:
*
* Whether the stage is able to be resized via user interaction.
*
* Since: 0.4
*/
g_object_class_install_property g_object_class_install_property
(gobject_class, PROP_USER_RESIZE, (gobject_class, PROP_USER_RESIZE,
g_param_spec_boolean ("user-resizable", g_param_spec_boolean ("user-resizable",
@ -256,7 +269,11 @@ clutter_stage_class_init (ClutterStageClass *klass)
"user interaction", "user interaction",
FALSE, FALSE,
G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE)); G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE));
/**
* ClutterStage:color:
*
* The color of the main stage.
*/
g_object_class_install_property g_object_class_install_property
(gobject_class, PROP_COLOR, (gobject_class, PROP_COLOR,
g_param_spec_boxed ("color", g_param_spec_boxed ("color",
@ -264,7 +281,6 @@ clutter_stage_class_init (ClutterStageClass *klass)
"The color of the main stage", "The color of the main stage",
CLUTTER_TYPE_COLOR, CLUTTER_TYPE_COLOR,
CLUTTER_PARAM_READWRITE)); CLUTTER_PARAM_READWRITE));
/** /**
* ClutterStage:title: * ClutterStage:title:
* *

10
doc/reference/clutter-sections.txt
View File

@ -413,10 +413,9 @@ clutter_texture_get_type
<SECTION> <SECTION>
<FILE>clutter-stage</FILE> <FILE>clutter-stage</FILE>
<TITLE>ClutterStage</TITLE> <TITLE>ClutterStage</TITLE>
ClutterPerspective
clutter_perspective_copy
clutter_perspective_free
<SUBSECTION> <SUBSECTION>
ClutterStage
ClutterStageClass
CLUTTER_STAGE_WIDTH CLUTTER_STAGE_WIDTH
CLUTTER_STAGE_HEIGHT CLUTTER_STAGE_HEIGHT
clutter_stage_get_default clutter_stage_get_default
@ -429,6 +428,9 @@ clutter_stage_hide_cursor
clutter_stage_get_actor_at_pos clutter_stage_get_actor_at_pos
clutter_stage_snapshot clutter_stage_snapshot
clutter_stage_event clutter_stage_event
ClutterPerspective
clutter_perspective_copy
clutter_perspective_free
clutter_stage_set_perspective clutter_stage_set_perspective
clutter_stage_set_perspectivex clutter_stage_set_perspectivex
clutter_stage_get_perspective clutter_stage_get_perspective
@ -438,8 +440,6 @@ clutter_stage_get_title
clutter_stage_set_user_resizable clutter_stage_set_user_resizable
clutter_stage_get_user_resizable clutter_stage_get_user_resizable
<SUBSECTION Standard> <SUBSECTION Standard>
ClutterStage
ClutterStageClass
CLUTTER_STAGE CLUTTER_STAGE
CLUTTER_IS_STAGE CLUTTER_IS_STAGE
CLUTTER_TYPE_STAGE CLUTTER_TYPE_STAGE