Merge remote-tracking branch 'glassrose/add-All-service-selection-in-debug-window'

[empathy.git] / libempathy-gtk / empathy-contact-widget.h

diff --git a/libempathy-gtk/empathy-contact-widget.h b/libempathy-gtk/empathy-contact-widget.h
index d52847762ebf56b07ed12e8cd3a4ef0f9f412eac..2533248b5b676b81f7a05a4f39721a5a26b5c1e8 100644 (file)
--- a/libempathy-gtk/empathy-contact-widget.h
+++ b/libempathy-gtk/empathy-contact-widget.h
@@ -29,23 +29,51 @@
 
 G_BEGIN_DECLS
 
+/**
+ * EmpathyContactWidgetFlags:
+ * @EMPATHY_CONTACT_WIDGET_EDIT_NONE: Don't show any widgets to edit any details
+ *  of the contact. This should be the option for widgets that merely display
+ *  information about a contact.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_ALIAS: Show a #GtkEntry allowing changes to the
+ *  contact's alias.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_AVATAR: Show an #EmpathyAvatarChooser allowing
+ *  changes to the contact's avatar.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_ACCOUNT: Show an #EmpathyAccountChooser allowing
+ *  changes to the contact's account.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_ID: Show a #GtkEntry allowing changes to the
+ *  contact's identifier.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_GROUPS: Show a widget to change the groups the
+ *  contact is in.
+ * @EMPATHY_CONTACT_WIDGET_FOR_TOOLTIP: Make widgets more designed for a tooltip.
+ *  For example, make widgets not selectable.
+ *
+ * Flags used when creating an #EmpathyContactWidget to specify which features
+ * should be available.
+ */
 typedef enum
 {
-       EMPATHY_CONTACT_WIDGET_EDIT_NONE    = 0,
-       EMPATHY_CONTACT_WIDGET_EDIT_ALIAS   = 1 << 0,
-       EMPATHY_CONTACT_WIDGET_EDIT_AVATAR  = 1 << 1,
-       EMPATHY_CONTACT_WIDGET_EDIT_ACCOUNT = 1 << 2,
-       EMPATHY_CONTACT_WIDGET_EDIT_ID      = 1 << 3,
-       EMPATHY_CONTACT_WIDGET_EDIT_GROUPS  = 1 << 4,
+  EMPATHY_CONTACT_WIDGET_EDIT_NONE    = 0,
+  EMPATHY_CONTACT_WIDGET_EDIT_ALIAS   = 1 << 0,
+  EMPATHY_CONTACT_WIDGET_EDIT_AVATAR  = 1 << 1,
+  EMPATHY_CONTACT_WIDGET_EDIT_ACCOUNT = 1 << 2,
+  EMPATHY_CONTACT_WIDGET_EDIT_ID      = 1 << 3,
+  EMPATHY_CONTACT_WIDGET_EDIT_GROUPS  = 1 << 4,
+  EMPATHY_CONTACT_WIDGET_FOR_TOOLTIP  = 1 << 5,
+  EMPATHY_CONTACT_WIDGET_SHOW_LOCATION  = 1 << 6,
+  EMPATHY_CONTACT_WIDGET_NO_SET_ALIAS = 1 << 7,
+  EMPATHY_CONTACT_WIDGET_SHOW_DETAILS = 1 << 8,
+  EMPATHY_CONTACT_WIDGET_EDIT_DETAILS = 1 << 9,
+  EMPATHY_CONTACT_WIDGET_NO_STATUS    = 1 << 10,
 } EmpathyContactWidgetFlags;
 
 GtkWidget * empathy_contact_widget_new (EmpathyContact *contact,
     EmpathyContactWidgetFlags flags);
 EmpathyContact *empathy_contact_widget_get_contact (GtkWidget *widget);
 void empathy_contact_widget_set_contact (GtkWidget *widget,
-                                                          EmpathyContact *contact);
+    EmpathyContact *contact);
 void empathy_contact_widget_set_account_filter (GtkWidget *widget,
     EmpathyAccountChooserFilterFunc filter, gpointer user_data);
+const gchar *empathy_contact_widget_get_alias (GtkWidget *widget);
 
 G_END_DECLS