diff options
Diffstat (limited to 'lib/gtk-experiment-widgets/gtk-experiment-navigator.h')
| -rw-r--r-- | lib/gtk-experiment-widgets/gtk-experiment-navigator.h | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/lib/gtk-experiment-widgets/gtk-experiment-navigator.h b/lib/gtk-experiment-widgets/gtk-experiment-navigator.h index a3ead44..d6b5d72 100644 --- a/lib/gtk-experiment-widgets/gtk-experiment-navigator.h +++ b/lib/gtk-experiment-widgets/gtk-experiment-navigator.h @@ -1,3 +1,9 @@ +/** + * @file + * Header file necessary to include when using the \e GtkExperimentNavigator + * widget. + */ + #ifndef __GTK_EXPERIMENT_NAVIGATOR_H #define __GTK_EXPERIMENT_NAVIGATOR_H @@ -10,6 +16,11 @@ G_BEGIN_DECLS #define GTK_TYPE_EXPERIMENT_NAVIGATOR \ (gtk_experiment_navigator_get_type()) +/** + * Cast instance pointer to \e GtkExperimentNavigator + * + * @param obj Object to cast to \e GtkExperimentNavigator + */ #define GTK_EXPERIMENT_NAVIGATOR(obj) \ (G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_EXPERIMENT_NAVIGATOR, GtkExperimentNavigator)) #define GTK_EXPERIMENT_NAVIGATOR_CLASS(klass) \ @@ -21,19 +32,30 @@ G_BEGIN_DECLS #define GTK_EXPERIMENT_NAVIGATOR_GET_CLASS(obj) \ (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_EXPERIMENT_NAVIGATOR, GtkExperimentNavigatorClass)) +/** + * \e GtkExperimentNavigator instance structure + */ typedef struct _GtkExperimentNavigator { - GtkTreeView parent_instance; + GtkTreeView parent_instance; /**< Parent instance structure */ - /* TODO */ + /** @todo Add necessary attributes */ } GtkExperimentNavigator; +/** + * \e GtkExperimentNavigator class structure + */ typedef struct _GtkExperimentNavigatorClass { - GtkTreeViewClass parent_class; + GtkTreeViewClass parent_class; /**< Parent class structure */ + /** + * Callback function to invoke when emitting the "time-selected" + * signal. Do not set manually. + */ void (*time_selected)(GtkExperimentNavigator *self, gint64 selected_time, gpointer user_data); } GtkExperimentNavigatorClass; +/** @private */ GType gtk_experiment_navigator_get_type(void); /* |