brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

state: Clean up the header's documentation

Browse Source
This commit is contained in:
Emmanuele Bassi 2010-05-20 17:46:52 +01:00
parent 3f36b4a841
commit 9fafc93c5d
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
clutter/clutter-state.h
View File

@ -39,13 +39,22 @@ G_BEGIN_DECLS
typedef struct _ClutterState ClutterState; typedef struct _ClutterState ClutterState;
typedef struct _ClutterStatePrivate ClutterStatePrivate; typedef struct _ClutterStatePrivate ClutterStatePrivate;
typedef struct _ClutterStateClass ClutterStateClass; typedef struct _ClutterStateClass ClutterStateClass;
/**
* ClutterStateKey:
*
* <structname>ClutterStateKey</structname> is an opaque structure whose
* members cannot be accessed directly
*
* Since: 1.4
*/
typedef struct _ClutterStateKey ClutterStateKey; typedef struct _ClutterStateKey ClutterStateKey;
/** /**
* ClutterState: * ClutterState:
* *
* The #ClutterState structure contains only private data and * The <structname>ClutterState</structname> structure contains only
* should be accessed using the provided API * private data and should be accessed using the provided API
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -58,8 +67,10 @@ struct _ClutterState
/** /**
* ClutterStateClass: * ClutterStateClass:
* @completed: class handler for the #ClutterState::completed signal
* *
* The #ClutterStateClass structure contains only private data * The <structname>ClutterStateClass</structname> structure contains
* only private data
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -69,10 +80,11 @@ struct _ClutterStateClass
GObjectClass parent_class; GObjectClass parent_class;
/*< public >*/ /*< public >*/
void (*completed) (ClutterState *state); void (* completed) (ClutterState *state);
/*< private >*/
/* padding for future expansion */ /* padding for future expansion */
gpointer _padding_dummy[16]; gpointer _padding_dummy[8];
}; };
GType clutter_state_get_type (void) G_GNUC_CONST; GType clutter_state_get_type (void) G_GNUC_CONST;
@ -82,7 +94,6 @@ 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_transition_name,
gboolean animate); gboolean animate);
const gchar * clutter_state_get_target_state (ClutterState *state);
ClutterState * clutter_state_set_key (ClutterState *state, ClutterState * clutter_state_set_key (ClutterState *state,
const gchar *source_transition_name, const gchar *source_transition_name,
const gchar *target_transition_name, const gchar *target_transition_name,
@ -125,6 +136,11 @@ void clutter_state_set_animator (ClutterState *state,
ClutterAnimator * clutter_state_get_animator (ClutterState *state, ClutterAnimator * clutter_state_get_animator (ClutterState *state,
const gchar *source_transition_name, const gchar *source_transition_name,
const gchar *target_transition_name); const gchar *target_transition_name);
G_CONST_RETURN gchar *clutter_state_get_target_state (ClutterState *state);
/*
* ClutterStateKey
*/
GType clutter_state_key_get_type (void) G_GNUC_CONST; GType clutter_state_key_get_type (void) G_GNUC_CONST;
gdouble clutter_state_key_get_pre_delay (const ClutterStateKey *state_key); gdouble clutter_state_key_get_pre_delay (const ClutterStateKey *state_key);