isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-02-09 01:54:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Align parameter names between header and source code

Browse Source
This commit is contained in:
Emmanuele Bassi 2010-05-24 14:20:23 +01:00
parent 07ffa015ab
commit 489c16c6a6
3 changed files with 93 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
clutter/clutter-state.c
View File

@ -430,10 +430,11 @@ clutter_state_new_frame (ClutterTimeline *timeline,
/** /**
* clutter_state_change: * clutter_state_change:
* @state_name: a #ClutterState * @state: a #ClutterState
* @target_state_name: the state to transition to
* @animate: whether we should animate the transition or not * @animate: whether we should animate the transition or not
* *
* Change the current state of #ClutterState to @state_name * Change the current state of #ClutterState to @target__name
* *
* If @animate is %FALSE, the state transition will happen immediately; * If @animate is %FALSE, the state transition will happen immediately;
* otherwise, the state transition will be animated over the duration * otherwise, the state transition will be animated over the duration
@ -444,20 +445,25 @@ clutter_state_new_frame (ClutterTimeline *timeline,
* Since: 1.4 * Since: 1.4
*/ */
ClutterTimeline * ClutterTimeline *
clutter_state_change (ClutterState *this, clutter_state_change (ClutterState *state,
const gchar *target_state_name, const gchar *target_state_name,
gboolean animate) gboolean animate)
{ {
ClutterStatePrivate *priv = this->priv; ClutterStatePrivate *priv;
State *state; ClutterAnimator *animator;
State *new_state;
GList *k;
g_return_val_if_fail (CLUTTER_IS_STATE (this), NULL); g_return_val_if_fail (CLUTTER_IS_STATE (state), NULL);
g_return_val_if_fail (target_state_name != NULL, NULL); g_return_val_if_fail (target_state_name != NULL, NULL);
priv = state->priv;
if (target_state_name == NULL) if (target_state_name == NULL)
target_state_name = g_intern_static_string ("default"); target_state_name = "default";
target_state_name = g_intern_string (target_state_name); target_state_name = g_intern_string (target_state_name);
if (priv->target_state_name == NULL) if (priv->target_state_name == NULL)
priv->target_state_name = g_intern_static_string ("default"); priv->target_state_name = g_intern_static_string ("default");
@ -467,7 +473,7 @@ clutter_state_change (ClutterState *this,
return priv->timeline; return priv->timeline;
} }
if (priv->current_animator) if (priv->current_animator != NULL)
{ {
clutter_animator_set_timeline (priv->current_animator, NULL); clutter_animator_set_timeline (priv->current_animator, NULL);
priv->current_animator = NULL; priv->current_animator = NULL;
@ -476,13 +482,13 @@ clutter_state_change (ClutterState *this,
priv->source_state_name = priv->target_state_name; priv->source_state_name = priv->target_state_name;
priv->target_state_name = target_state_name; priv->target_state_name = target_state_name;
g_object_notify (G_OBJECT (this), "target-state"); g_object_notify (G_OBJECT (state), "target-state");
if (animate) if (animate)
{ {
guint duration; guint duration;
duration = clutter_state_get_duration (this, duration = clutter_state_get_duration (state,
priv->source_state_name, priv->source_state_name,
priv->target_state_name); priv->target_state_name);
clutter_timeline_set_duration (priv->timeline, duration); clutter_timeline_set_duration (priv->timeline, duration);
@ -490,56 +496,49 @@ clutter_state_change (ClutterState *this,
else else
clutter_timeline_set_duration (priv->timeline, 1); clutter_timeline_set_duration (priv->timeline, 1);
state = g_hash_table_lookup (priv->states, target_state_name); new_state = g_hash_table_lookup (priv->states, target_state_name);
g_return_val_if_fail (state, NULL); if (new_state == NULL)
{
ClutterAnimator *animator;
animator = clutter_state_get_animator (this,
priv->source_state_name,
priv->target_state_name);
if (animator != NULL)
{
priv->current_animator = animator;
clutter_animator_set_timeline (animator, priv->timeline);
clutter_timeline_stop (priv->timeline);
clutter_timeline_rewind (priv->timeline);
clutter_timeline_start (priv->timeline);
return priv->timeline;
}
}
if (state)
{ {
GList *k; g_warning ("State '%s' not found", target_state_name);
for (k = state->keys; k; k = k->next) return NULL;
{
ClutterStateKey *key = k->data;
GValue initial = {0,};
g_value_init (&initial,
clutter_interval_get_value_type (key->interval));
g_object_get_property (key->object, key->property_name, &initial);
if (clutter_alpha_get_mode (key->alpha) != key->mode)
clutter_alpha_set_mode (key->alpha, key->mode);
clutter_interval_set_initial_value (key->interval, &initial);
clutter_interval_set_final_value (key->interval, &key->value);
g_value_unset (&initial);
}
priv->target_state = state;
clutter_timeline_rewind (priv->timeline);
clutter_timeline_start (priv->timeline);
} }
else
g_warning ("State '%s' not found", target_state_name); animator = clutter_state_get_animator (state,
priv->source_state_name,
priv->target_state_name);
if (animator != NULL)
{
priv->current_animator = animator;
clutter_animator_set_timeline (animator, priv->timeline);
clutter_timeline_stop (priv->timeline);
clutter_timeline_rewind (priv->timeline);
clutter_timeline_start (priv->timeline);
return priv->timeline;
}
for (k = new_state->keys; k != NULL; k = k->next)
{
ClutterStateKey *key = k->data;
GValue initial = { 0, };
g_value_init (&initial, clutter_interval_get_value_type (key->interval));
g_object_get_property (key->object, key->property_name, &initial);
if (clutter_alpha_get_mode (key->alpha) != key->mode)
clutter_alpha_set_mode (key->alpha, key->mode);
clutter_interval_set_initial_value (key->interval, &initial);
clutter_interval_set_final_value (key->interval, &key->value);
g_value_unset (&initial);
}
priv->target_state = new_state;
clutter_timeline_rewind (priv->timeline);
clutter_timeline_start (priv->timeline);
return priv->timeline; return priv->timeline;
} }
@ -699,7 +698,7 @@ clutter_state_set_key_internal (ClutterState *state,
/** /**
* clutter_state_set_key: * clutter_state_set_key:
* @this: a #ClutterState instance. * @state: a #ClutterState instance.
* @source_state_name: the source transition to specify transition for * @source_state_name: the source transition to specify transition for
* @target_state_name: the name of the transition to set a key value for. * @target_state_name: the name of the transition to set a key value for.
* @object: the #GObject to set a key for * @object: the #GObject to set a key for
@ -720,7 +719,7 @@ clutter_state_set_key_internal (ClutterState *state,
* Since: 1.4 * Since: 1.4
*/ */
ClutterState * ClutterState *
clutter_state_set_key (ClutterState *this, clutter_state_set_key (ClutterState *state,
const gchar *source_state_name, const gchar *source_state_name,
const gchar *target_state_name, const gchar *target_state_name,
GObject *object, GObject *object,
@ -730,16 +729,19 @@ clutter_state_set_key (ClutterState *this,
gdouble pre_delay, gdouble pre_delay,
gdouble post_delay) gdouble post_delay)
{ {
ClutterStatePrivate *priv;
GParamSpec *pspec; GParamSpec *pspec;
ClutterStateKey *state_key; ClutterStateKey *state_key;
State *source_state = NULL; State *source_state = NULL;
State *target_state; State *target_state;
g_return_val_if_fail (CLUTTER_IS_STATE (this), NULL); g_return_val_if_fail (CLUTTER_IS_STATE (state), NULL);
g_return_val_if_fail (G_IS_OBJECT (object), NULL); g_return_val_if_fail (G_IS_OBJECT (object), NULL);
g_return_val_if_fail (property_name, NULL); g_return_val_if_fail (property_name, NULL);
g_return_val_if_fail (value, NULL); g_return_val_if_fail (value, NULL);
priv = state->priv;
if (target_state_name == NULL) if (target_state_name == NULL)
target_state_name = "default"; target_state_name = "default";
@ -757,25 +759,26 @@ clutter_state_set_key (ClutterState *this,
target_state_name = g_intern_string (target_state_name); target_state_name = g_intern_string (target_state_name);
property_name = g_intern_string (property_name); property_name = g_intern_string (property_name);
target_state = g_hash_table_lookup (this->priv->states, target_state = g_hash_table_lookup (priv->states, target_state_name);
target_state_name);
if (!target_state) if (!target_state)
{ {
target_state = state_new (this, target_state_name); target_state = state_new (state, target_state_name);
g_hash_table_insert (this->priv->states, g_hash_table_insert (priv->states,
(gpointer)target_state_name, target_state); (gpointer) target_state_name,
target_state);
} }
if (source_state_name) if (source_state_name)
{ {
source_state = g_hash_table_lookup (this->priv->states, source_state = g_hash_table_lookup (priv->states, source_state_name);
source_state_name);
if (!source_state) if (!source_state)
{ {
source_state = state_new (this, source_state_name); source_state = state_new (state, source_state_name);
g_hash_table_insert (this->priv->states, g_hash_table_insert (priv->states,
(gpointer)source_state_name, source_state); (gpointer) source_state_name,
source_state);
} }
} }
@ -790,9 +793,9 @@ clutter_state_set_key (ClutterState *this,
g_value_init (&state_key->value, G_VALUE_TYPE (value)); g_value_init (&state_key->value, G_VALUE_TYPE (value));
g_value_copy (value, &state_key->value); g_value_copy (value, &state_key->value);
clutter_state_set_key_internal (this, state_key); clutter_state_set_key_internal (state, state_key);
return this; return state;
} }
/** /**

34
clutter/clutter-state.h
View File

@ -92,11 +92,11 @@ ClutterState *clutter_state_new (void);
ClutterTimeline * clutter_state_change (ClutterState *state, ClutterTimeline * clutter_state_change (ClutterState *state,
const gchar *target_transition_name, const gchar *target_state_name,
gboolean animate); gboolean animate);
ClutterState * clutter_state_set_key (ClutterState *state, ClutterState * clutter_state_set_key (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name, const gchar *target_state_name,
GObject *object, GObject *object,
const gchar *property_name, const gchar *property_name,
guint mode, guint mode,
@ -104,38 +104,38 @@ ClutterState * clutter_state_set_key (ClutterState *state,
gdouble pre_delay, gdouble pre_delay,
gdouble post_delay); gdouble post_delay);
void clutter_state_set_duration (ClutterState *state, void clutter_state_set_duration (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name, const gchar *target_state_name,
guint duration); guint duration);
guint clutter_state_get_duration (ClutterState *state, guint clutter_state_get_duration (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name); const gchar *target_state_name);
void clutter_state_set (ClutterState *state, void clutter_state_set (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name, const gchar *target_state_name,
gpointer first_object, gpointer first_object,
const gchar *first_property_name, const gchar *first_property_name,
gulong first_mode, gulong first_mode,
...); ...);
GList * clutter_state_get_states (ClutterState *state); GList * clutter_state_get_states (ClutterState *state);
GList * clutter_state_get_keys (ClutterState *state, GList * clutter_state_get_keys (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name, const gchar *target_state_name,
GObject *object, GObject *object,
const gchar *property_name); const gchar *property_name);
void clutter_state_remove_key (ClutterState *state, void clutter_state_remove_key (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name, const gchar *target_state_name,
GObject *object, GObject *object,
const gchar *property_name); const gchar *property_name);
ClutterTimeline * clutter_state_get_timeline (ClutterState *state); ClutterTimeline * clutter_state_get_timeline (ClutterState *state);
void clutter_state_set_animator (ClutterState *state, void clutter_state_set_animator (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name, const gchar *target_state_name,
ClutterAnimator *animator); ClutterAnimator *animator);
ClutterAnimator * clutter_state_get_animator (ClutterState *state, ClutterAnimator * clutter_state_get_animator (ClutterState *state,
const gchar *source_transition_name, const gchar *source_state_name,
const gchar *target_transition_name); const gchar *target_state_name);
G_CONST_RETURN gchar *clutter_state_get_target_state (ClutterState *state); G_CONST_RETURN gchar *clutter_state_get_target_state (ClutterState *state);
/* /*

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

@ -2236,6 +2236,7 @@ clutter_state_get_timeline
clutter_state_set_animator clutter_state_set_animator
clutter_state_get_animator clutter_state_get_animator
clutter_state_get_target_state clutter_state_get_target_state
clutter_state_change
<SUBSECTION> <SUBSECTION>
ClutterStateKey ClutterStateKey