Misc. gtk-doc updates, including being more explicit about refs.

[empathy.git] / libempathy-gtk / empathy-profile-chooser.c

diff --git a/libempathy-gtk/empathy-profile-chooser.c b/libempathy-gtk/empathy-profile-chooser.c
index ae32aff7f3247bb477dfd23b731ce95cd64843c7..10eb3791ab552a6e08169c0332511822c2f856f9 100644 (file)
--- a/libempathy-gtk/empathy-profile-chooser.c
+++ b/libempathy-gtk/empathy-profile-chooser.c
@@ -1,21 +1,20 @@
 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
 /*
- * Copyright (C) 2007 Collabora Ltd.
+ * Copyright (C) 2007-2008 Collabora Ltd.
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or (at your option) any later version.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public
- * License along with this program; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  *
  * Authors: Xavier Claessens <xclaesse@gmail.com>
  */
@@ -31,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,
@@ -38,8 +47,17 @@ enum {
        COL_COUNT
 };
 
+/**
+ * empathy_profile_chooser_dup_selected:
+ * @widget: an #EmpathyProfileChooser
+ *
+ * Returns a new reference to the selected #McProfile in @widget. The returned
+ * #McProfile should be unrefed with g_object_unref() when finished with.
+ *
+ * Return value: a new reference to the selected #McProfile
+ */
 McProfile*
-empathy_profile_chooser_get_selected (GtkWidget *widget)
+empathy_profile_chooser_dup_selected (GtkWidget *widget)
 {
        GtkTreeModel *model;
        GtkTreeIter   iter;
@@ -55,6 +73,24 @@ empathy_profile_chooser_get_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)
+{
+       GtkTreeModel *model;
+
+       model = gtk_combo_box_get_model (GTK_COMBO_BOX (widget));
+
+       return gtk_tree_model_iter_n_children (model, NULL);
+}
+
 static gint
 profile_chooser_sort_profile_value (McProfile *profile)
 {
@@ -106,15 +142,23 @@ 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)
 {
-       GList           *profiles, *l;
+       GList           *profiles, *l, *seen;
        GtkListStore    *store;
        GtkCellRenderer *renderer;
        GtkWidget       *combo_box;
        GtkTreeIter      iter;
        gboolean         iter_set = FALSE;
+       McManager       *btf_cm;
 
        /* set up combo box with new store */
        store = gtk_list_store_new (COL_COUNT,
@@ -137,10 +181,13 @@ empathy_profile_chooser_new (void)
                                        "text", COL_LABEL,
                                        NULL);
 
+       btf_cm = mc_manager_lookup ("butterfly");
        profiles = mc_profiles_list ();
+       seen = NULL;
        for (l = profiles; l; l = l->next) {
-               McProfile  *profile;
-               McProtocol *protocol;
+               McProfile   *profile;
+               McProtocol  *protocol;
+               const gchar *unique_name;
 
                profile = l->data;
 
@@ -152,6 +199,17 @@ empathy_profile_chooser_new (void)
                }
                g_object_unref (protocol);
 
+               /* Skip MSN-Haze if we have butterfly */
+               unique_name = mc_profile_get_unique_name (profile);
+               if (btf_cm && strcmp (unique_name, "msn-haze") == 0) {
+                       continue;
+               }
+
+               if (g_list_find_custom (seen, unique_name, (GCompareFunc) strcmp)) {
+                       continue;
+               }
+               seen = g_list_append (seen, (char*) unique_name);
+
                gtk_list_store_insert_with_values (store, &iter, 0,
                                                   COL_ICON, mc_profile_get_icon_name (profile),
                                                   COL_LABEL, mc_profile_get_display_name (profile),
@@ -160,6 +218,12 @@ empathy_profile_chooser_new (void)
                 iter_set = TRUE;
        }
 
+       g_list_free (seen);
+
+       if (btf_cm) {
+               g_object_unref (btf_cm);
+       }
+
        /* Set the profile sort function */
        gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (store),
                                         COL_PROFILE,