aboutsummaryrefslogtreecommitdiffstats
path: root/libempathy-gtk/empathy-profile-chooser.c
diff options
context:
space:
mode:
authorJonny Lamb <jonny.lamb@collabora.co.uk>2009-04-23 08:02:46 +0800
committerJonny Lamb <jonny.lamb@collabora.co.uk>2009-04-23 08:02:46 +0800
commitefc083f8db0c2116e05be9d894a0dbac39a5d433 (patch)
tree48b3038a4f1247b60443219349d1754c6931902e /libempathy-gtk/empathy-profile-chooser.c
parent0913854d6a7d78e60a0d08897d6ba45140fd5237 (diff)
downloadgsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.tar
gsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.tar.gz
gsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.tar.bz2
gsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.tar.lz
gsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.tar.xz
gsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.tar.zst
gsoc2013-empathy-efc083f8db0c2116e05be9d894a0dbac39a5d433.zip
Add documentation for EmpathyProfileChooser.
Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
Diffstat (limited to 'libempathy-gtk/empathy-profile-chooser.c')
-rw-r--r--libempathy-gtk/empathy-profile-chooser.c33
1 files changed, 33 insertions, 0 deletions
diff --git a/libempathy-gtk/empathy-profile-chooser.c b/libempathy-gtk/empathy-profile-chooser.c
index 897e38344..495956169 100644
--- a/libempathy-gtk/empathy-profile-chooser.c
+++ b/libempathy-gtk/empathy-profile-chooser.c
@@ -30,6 +30,16 @@
#include "empathy-profile-chooser.h"
#include "empathy-ui-utils.h"
+/**
+ * SECTION:empathy-profile-chooser
+ * @title: EmpathyProfileChooser
+ * @short_description: A widget used to choose from a list of profiles
+ * @include: libempathy-gtk/empathy-account-chooser.h
+ *
+ * #EmpathyProfileChooser is a widget which provides a chooser of available
+ * profiles.
+ */
+
enum {
COL_ICON,
COL_LABEL,
@@ -37,6 +47,14 @@ enum {
COL_COUNT
};
+/**
+ * empathy_profile_chooser_dup_selected:
+ * @widget: an #EmpathyProfileChooser
+ *
+ * Returns a new reference to the selected #McProfile in @widget.
+ *
+ * Return value: a new reference to the selected #McProfile
+ */
McProfile*
empathy_profile_chooser_dup_selected (GtkWidget *widget)
{
@@ -54,6 +72,14 @@ empathy_profile_chooser_dup_selected (GtkWidget *widget)
return profile;
}
+/**
+ * empathy_profile_chooser_n_profiles:
+ * @widget: an #EmpathyProfileChooser
+ *
+ * Returns the number of profiles in @widget.
+ *
+ * Return value: the number of profiles in @widget
+ */
gint
empathy_profile_chooser_n_profiles (GtkWidget *widget)
{
@@ -115,6 +141,13 @@ profile_chooser_sort_func (GtkTreeModel *model,
return cmp;
}
+/**
+ * empathy_profile_chooser_new:
+ *
+ * Creates a new #EmpathyProfileChooser widget.
+ *
+ * Return value: a new #EmpathyProfileChooser widget
+ */
GtkWidget *
empathy_profile_chooser_new (void)
{