aboutsummaryrefslogtreecommitdiffstats
path: root/libempathy-gtk
diff options
context:
space:
mode:
authorJonny Lamb <jonny.lamb@collabora.co.uk>2009-04-23 07:27:42 +0800
committerJonny Lamb <jonny.lamb@collabora.co.uk>2009-04-23 07:45:31 +0800
commit56fa37ef682ea7e8f676f4c974b76c06242466d2 (patch)
treec9dcf34cfabcacb760eee02cfaf2d1f2e15045ce /libempathy-gtk
parent796cc2509860254f98c24d56c1f8bb9f1887e9c8 (diff)
downloadgsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.tar
gsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.tar.gz
gsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.tar.bz2
gsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.tar.lz
gsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.tar.xz
gsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.tar.zst
gsoc2013-empathy-56fa37ef682ea7e8f676f4c974b76c06242466d2.zip
Add documentation for EmpathyPresenceChooser.
Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
Diffstat (limited to 'libempathy-gtk')
-rw-r--r--libempathy-gtk/empathy-presence-chooser.c31
-rw-r--r--libempathy-gtk/empathy-presence-chooser.h2
2 files changed, 33 insertions, 0 deletions
diff --git a/libempathy-gtk/empathy-presence-chooser.c b/libempathy-gtk/empathy-presence-chooser.c
index 8e9574bc5..36e837692 100644
--- a/libempathy-gtk/empathy-presence-chooser.c
+++ b/libempathy-gtk/empathy-presence-chooser.c
@@ -47,6 +47,23 @@
#include "empathy-images.h"
#include "empathy-presence-chooser.h"
+/**
+ * SECTION:empathy-presence-chooser
+ * @title:EmpathyPresenceChooser
+ * @short_description: A widget used to change presence
+ * @include: libempathy-gtk/empathy-presence-chooser.h
+ *
+ * #EmpathyPresenceChooser is a widget which extends #GtkComboBoxEntry
+ * to change presence.
+ */
+
+/**
+ * EmpathyAccountChooser:
+ * @parent: parent object
+ *
+ * Widget which extends #GtkComboBoxEntry to change presence.
+ */
+
/* Flashing delay for icons (milliseconds). */
#define FLASH_TIMEOUT 500
@@ -789,6 +806,13 @@ presence_chooser_finalize (GObject *object)
G_OBJECT_CLASS (empathy_presence_chooser_parent_class)->finalize (object);
}
+/**
+ * empathy_presence_chooser_new:
+ *
+ * Creates a new #EmpathyPresenceChooser widget.
+ *
+ * Return value: A new #EmpathyPresenceChooser widget
+ */
GtkWidget *
empathy_presence_chooser_new (void)
{
@@ -946,6 +970,13 @@ presence_chooser_flash_stop (EmpathyPresenceChooser *chooser,
empathy_icon_name_for_presence (state));
}
+/**
+ * empathy_presence_chooser_create_menu:
+ *
+ * Creates a new #GtkMenu allowing users to change their presence from a menu.
+ *
+ * Return value: a new #GtkMenu for changing presence in a menu.
+ */
GtkWidget *
empathy_presence_chooser_create_menu (void)
{
diff --git a/libempathy-gtk/empathy-presence-chooser.h b/libempathy-gtk/empathy-presence-chooser.h
index 138e1dc7f..dab95f553 100644
--- a/libempathy-gtk/empathy-presence-chooser.h
+++ b/libempathy-gtk/empathy-presence-chooser.h
@@ -43,6 +43,8 @@ typedef struct _EmpathyPresenceChooserClass EmpathyPresenceChooserClass;
struct _EmpathyPresenceChooser {
GtkComboBoxEntry parent;
+
+ /*<private>*/
gpointer priv;
};