2006-12-13 Emmanuele Bassi <ebassi@openedhand.com>

* clutter/clutter-actor.c:
	* clutter/clutter-clone-texture.c:
	* clutter/clutter-event.h:
	* clutter/clutter-stage.c:
	* clutter/clutter-texture.c:
	* clutter/clutter-timeline.c: Update the inline apidoc.
This commit is contained in:
Emmanuele Bassi 2006-12-13 18:12:09 +00:00
parent 2231c939d0
commit 4d168e81fa
7 changed files with 98 additions and 13 deletions

View File

@ -1,3 +1,12 @@
2006-12-13 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/clutter-actor.c:
* clutter/clutter-clone-texture.c:
* clutter/clutter-event.h:
* clutter/clutter-stage.c:
* clutter/clutter-texture.c:
* clutter/clutter-timeline.c: Update the inline apidoc.
2006-12-13 Matthew Allum <mallum@openedhand.com>
* clutter/clutter-actor.c: (clutter_actor_class_init):

View File

@ -1051,7 +1051,7 @@ clutter_actor_set_size (ClutterActor *self,
clutter_actor_request_coords (self, &box);
}
/*
/**
* clutter_actor_get_size:
* @self: A #ClutterActor
* @width: Location to store width if non NULL.
@ -1292,6 +1292,10 @@ clutter_actor_set_scalex (ClutterActor *self,
* @self: A #ClutterActor
* @scale_x: double
* @scale_y: double
*
* FIXME
*
* Since: 0.2
*/
void
clutter_actor_set_scale (ClutterActor *self,

View File

@ -387,7 +387,7 @@ clutter_clone_texture_get_parent_texture (ClutterCloneTexture *clone)
/**
* clutter_clone_texture_set_parent_texture:
* @clone: a #ClutterCloneTexture
* @texture a #ClutterTexture or %NULL
* @texture: a #ClutterTexture or %NULL
*
* Sets the parent texture cloned by the #ClutterCloneTexture.
*

View File

@ -116,7 +116,7 @@ GType clutter_event_get_type (void) G_GNUC_CONST;
ClutterEvent *clutter_event_new (ClutterEventType type);
ClutterEvent *clutter_event_copy (ClutterEvent *event);
void clutter_event_free (ClutterEvent *event);
ClutterEventType clutter_event_type (ClutterEvent *keyev);
ClutterEventType clutter_event_type (ClutterEvent *event);
guint32 clutter_key_event_time (ClutterKeyEvent *keyev);
guint clutter_key_event_state (ClutterKeyEvent *keyev);

View File

@ -729,6 +729,15 @@ clutter_stage_class_init (ClutterStageClass *klass)
CLUTTER_TYPE_COLOR,
CLUTTER_PARAM_READWRITE));
/**
* ClutterStage::input-event:
* @stage: the actor which received the event
* @event: the event received
*
* The ::input-event is a signal emitted when any input event is
* received. Valid input events are mouse button press and release
* events, and key press and release events.
*/
stage_signals[INPUT_EVENT] =
g_signal_new ("input-event",
G_TYPE_FROM_CLASS (gobject_class),
@ -738,7 +747,14 @@ clutter_stage_class_init (ClutterStageClass *klass)
clutter_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
CLUTTER_TYPE_EVENT);
/**
* ClutterStage::button-press-event:
* @stage: the actor which received the event
* @event: a #ClutterButtonEvent
*
* The ::button-press-event is emitted each time a mouse button
* is pressed on @stage.
*/
stage_signals[BUTTON_PRESS_EVENT] =
g_signal_new ("button-press-event",
G_TYPE_FROM_CLASS (gobject_class),
@ -748,6 +764,14 @@ clutter_stage_class_init (ClutterStageClass *klass)
clutter_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
CLUTTER_TYPE_EVENT);
/**
* ClutterStage::button-release-event:
* @stage: the actor which received the event
* @event: a #ClutterButtonEvent
*
* The ::button-release-event is emitted each time a mouse button
* is released on @stage.
*/
stage_signals[BUTTON_RELEASE_EVENT] =
g_signal_new ("button-release-event",
G_TYPE_FROM_CLASS (gobject_class),
@ -757,7 +781,15 @@ clutter_stage_class_init (ClutterStageClass *klass)
clutter_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
CLUTTER_TYPE_EVENT);
stage_signals[BUTTON_PRESS_EVENT] =
/**
* ClutterStage::key-press-event:
* @stage: the actor which received the event
* @event: a #ClutterKeyEvent
*
* The ::key-press-event is emitted each time a keyboard button
* is pressed on @stage.
*/
stage_signals[KEY_PRESS_EVENT] =
g_signal_new ("key-press-event",
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST,
@ -766,7 +798,15 @@ clutter_stage_class_init (ClutterStageClass *klass)
clutter_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
CLUTTER_TYPE_EVENT);
stage_signals[BUTTON_RELEASE_EVENT] =
/**
* ClutterStage::key-release-event:
* @stage: the actor which received the event
* @event: a #ClutterKeyEvent
*
* The ::key-release-event is emitted each time a keyboard button
* is released on @stage.
*/
stage_signals[KEY_RELEASE_EVENT] =
g_signal_new ("key-release-event",
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST,
@ -775,6 +815,14 @@ clutter_stage_class_init (ClutterStageClass *klass)
clutter_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
CLUTTER_TYPE_EVENT);
/**
* ClutterStage::motion-event:
* @stage: the actor which received the event
* @event: a #ClutterMotionEvent
*
* The ::motion-event is emitted each time the mouse pointer is
* moved on @stage.
*/
stage_signals[MOTION_EVENT] =
g_signal_new ("motion-event",
G_TYPE_FROM_CLASS (gobject_class),

View File

@ -100,8 +100,8 @@ enum
enum
{
SIGNAL_SIZE_CHANGE,
SIGNAL_PIXBUF_CHANGE,
SIZE_CHANGE,
PIXBUF_CHANGE,
LAST_SIGNAL
};
@ -953,7 +953,17 @@ clutter_texture_class_init (ClutterTextureClass *klass)
GL_RGBA,
G_PARAM_CONSTRUCT_ONLY | CLUTTER_PARAM_READWRITE));
texture_signals[SIGNAL_SIZE_CHANGE] =
/**
* ClutterTexture::size-change:
* @texture: the texture which received the signal
* @width: the width of the new texture
* @height: the height of the new texture
*
* The ::size-change signal is emitted each time the size of the
* pixbuf used by @texture changes. The new size is given as
* argument to the callback.
*/
texture_signals[SIZE_CHANGE] =
g_signal_new ("size-change",
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST,
@ -962,8 +972,14 @@ clutter_texture_class_init (ClutterTextureClass *klass)
clutter_marshal_VOID__INT_INT,
G_TYPE_NONE,
2, G_TYPE_INT, G_TYPE_INT);
texture_signals[SIGNAL_PIXBUF_CHANGE] =
/**
* ClutterTexture::pixbuf-change:
* @texture: the texture which received the signal
*
* The ::pixbuf-change signal is emitted each time the pixbuf
* used by @texture changes.
*/
texture_signals[PIXBUF_CHANGE] =
g_signal_new ("pixbuf-change",
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST,
@ -1204,7 +1220,7 @@ clutter_texture_set_from_data (ClutterTexture *texture,
if (texture_dirty)
{
g_signal_emit (texture, texture_signals[SIGNAL_SIZE_CHANGE],
g_signal_emit (texture, texture_signals[SIZE_CHANGE],
0, priv->width, priv->height);
if (priv->sync_actor_size)
@ -1214,7 +1230,7 @@ clutter_texture_set_from_data (ClutterTexture *texture,
}
/* rename signal */
g_signal_emit (texture, texture_signals[SIGNAL_PIXBUF_CHANGE], 0);
g_signal_emit (texture, texture_signals[PIXBUF_CHANGE], 0);
/* If resized actor may need resizing but paint() will do this */
if (CLUTTER_ACTOR_IS_MAPPED (CLUTTER_ACTOR(texture)))

View File

@ -209,6 +209,14 @@ clutter_timeline_class_init (ClutterTimelineClass *klass)
FALSE,
G_PARAM_CONSTRUCT | CLUTTER_PARAM_READWRITE));
/**
* ClutterTimeline::new-frame:
* @timeline: the timeline which received the signal
* @frame_num: the number of the new frame
*
* The ::new-frame signal is emitted each time a new frame in the
* timeline is reached.
*/
timeline_signals[NEW_FRAME] =
g_signal_new ("new-frame",
G_TYPE_FROM_CLASS (object_class),