aboutsummaryrefslogtreecommitdiff
path: root/lib/gtk-experiment-widgets/gtk-experiment-navigator.h
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2012-05-13 18:17:17 +0200
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2012-05-13 18:17:17 +0200
commitc647ca77debd65f1c4f1cf9fd5ef54e6ec7791a1 (patch)
tree62cb751fd1ee9d9e4f98b14541c99d0343c0b80b /lib/gtk-experiment-widgets/gtk-experiment-navigator.h
parent670156a060b9c2fdf1fcdf13f1b6c28ce9537f31 (diff)
downloadexperiment-player-c647ca77debd65f1c4f1cf9fd5ef54e6ec7791a1.tar.gz
gtk-experiment-navigator: added support for private attributes, and instance disposal/finalization
* in case Jens needs them * also updated documentation
Diffstat (limited to 'lib/gtk-experiment-widgets/gtk-experiment-navigator.h')
-rw-r--r--lib/gtk-experiment-widgets/gtk-experiment-navigator.h18
1 files changed, 16 insertions, 2 deletions
diff --git a/lib/gtk-experiment-widgets/gtk-experiment-navigator.h b/lib/gtk-experiment-widgets/gtk-experiment-navigator.h
index 2b50494..73cef7d 100644
--- a/lib/gtk-experiment-widgets/gtk-experiment-navigator.h
+++ b/lib/gtk-experiment-widgets/gtk-experiment-navigator.h
@@ -20,6 +20,7 @@ G_BEGIN_DECLS
* Cast instance pointer to \e GtkExperimentNavigator
*
* @param obj Object to cast to \e GtkExperimentNavigator
+ * @return \e obj casted to \e GtkExperimentNavigator
*/
#define GTK_EXPERIMENT_NAVIGATOR(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_EXPERIMENT_NAVIGATOR, GtkExperimentNavigator))
@@ -32,13 +33,22 @@ G_BEGIN_DECLS
#define GTK_EXPERIMENT_NAVIGATOR_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_EXPERIMENT_NAVIGATOR, GtkExperimentNavigatorClass))
+/** @private */
+typedef struct _GtkExperimentNavigatorPrivate GtkExperimentNavigatorPrivate;
+
/**
* \e GtkExperimentNavigator instance structure
*/
typedef struct _GtkExperimentNavigator {
- GtkTreeView parent_instance; /**< Parent instance structure */
+ GtkTreeView parent_instance; /**< Parent instance structure */
+
+ /**
+ * @todo
+ * Add necessary \b public instance attributes. They must be
+ * initialized in the instance initializer function.
+ */
- /** @todo Add necessary instance attributes */
+ GtkExperimentNavigatorPrivate *priv; /**< @private Pointer to \b private instance attributes */
} GtkExperimentNavigator;
/**
@@ -50,6 +60,10 @@ typedef struct _GtkExperimentNavigatorClass {
/**
* Callback function to invoke when emitting the "time-selected"
* signal. Do not set manually.
+ *
+ * @param self \e GtkExperimentNavigator the event was emitted on.
+ * @param selected_time Time selected by the navigator in milliseconds
+ * @param user_data Callback user data
*/
void (*time_selected)(GtkExperimentNavigator *self,
gint64 selected_time, gpointer user_data);