aboutsummaryrefslogtreecommitdiff
path: root/lib/gtk-vlc-player/gtk-vlc-player.h
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2012-05-13 18:16:12 +0200
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2012-05-13 18:16:12 +0200
commit670156a060b9c2fdf1fcdf13f1b6c28ce9537f31 (patch)
tree14cd86eb4d7fb1a42ce18a955f06aff0f1bfe12d /lib/gtk-vlc-player/gtk-vlc-player.h
parent1cf0a01006b1d117135bd22fcca7d6b4377d131c (diff)
downloadexperiment-player-670156a060b9c2fdf1fcdf13f1b6c28ce9537f31.tar.gz
updated gtk-vlc-player documentation and check object attributes
methods may be invoked after instance disposal, so object attributes may already be unreferenced
Diffstat (limited to 'lib/gtk-vlc-player/gtk-vlc-player.h')
-rw-r--r--lib/gtk-vlc-player/gtk-vlc-player.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/gtk-vlc-player/gtk-vlc-player.h b/lib/gtk-vlc-player/gtk-vlc-player.h
index 654a20c..b107484 100644
--- a/lib/gtk-vlc-player/gtk-vlc-player.h
+++ b/lib/gtk-vlc-player/gtk-vlc-player.h
@@ -18,6 +18,7 @@ G_BEGIN_DECLS
* Cast instance pointer to \e GtkVlcPlayer
*
* @param obj Object to cast to \e GtkVlcPlayer
+ * @return \e obj casted to \e GtkVlcPlayer
*/
#define GTK_VLC_PLAYER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_VLC_PLAYER, GtkVlcPlayer))
@@ -51,12 +52,20 @@ typedef struct _GtkVlcPlayerClass {
/**
* Callback function to invoke when emitting the "time-changed"
* signal. Do not set manually.
+ *
+ * @param self \e GtkVlcPlayer widget that emitted the signal
+ * @param new_time New (current) position of playback in milliseconds
+ * @param user_data Callback user data
*/
void (*time_changed) (GtkVlcPlayer *self, gint64 new_time, gpointer user_data);
/**
* Callback function to invoke when emitting the "length-changed"
* signal. Do not set manually.
+ *
+ * @param self \e GtkVlcPlayer widget that emitted the signal
+ * @param new_length New (current) length of media loaded into player (milliseconds)
+ * @param user_data Callback user data
*/
void (*length_changed) (GtkVlcPlayer *self, gint64 new_length, gpointer user_data);
} GtkVlcPlayerClass;