libempathy-gtk/empathy-individual-widget.h

   1 /*
   2  * Copyright (C) 2010 Collabora Ltd.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  *
  18  * Authors: Philip Withnall <philip.withnall@collabora.co.uk>
  19  */
  20
  21 #ifndef __EMPATHY_INDIVIDUAL_WIDGET_H__
  22 #define __EMPATHY_INDIVIDUAL_WIDGET_H__
  23
  24 #include <gtk/gtk.h>
  25 #include <folks/folks.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /**
  30  * EmpathyIndividualWidgetFlags:
  31  * @EMPATHY_INDIVIDUAL_WIDGET_NONE: Don't show any widgets to edit any
  32  * details of the individual, or to display any extended details of the
  33  * individual. This should be the option for widgets that merely display basic
  34  * information about an individual.
  35  * @EMPATHY_INDIVIDUAL_WIDGET_EDIT_ALIAS: Show a #GtkEntry allowing changes to
  36  * the individual's alias.
  37  * @EMPATHY_INDIVIDUAL_WIDGET_EDIT_FAVOURITE: Show a checkbutton
  38  * allowing changes to the individual's favourite status.
  39  * @EMPATHY_INDIVIDUAL_WIDGET_EDIT_GROUPS: Show a widget to change the groups
  40  * the individual is in.
  41  * @EMPATHY_INDIVIDUAL_WIDGET_FOR_TOOLTIP: Make widgets more designed for a
  42  * tooltip. For example, make labels not selectable.
  43  * @EMPATHY_INDIVIDUAL_WIDGET_SHOW_LOCATION: Display the individual's current
  44  * location textually or using a map (if compiled with libchamplain support).
  45  * @EMPATHY_INDIVIDUAL_WIDGET_SHOW_DETAILS: Fetch and display extended vCard
  46  * details of the individual, if the individual has them.
  47  * @EMPATHY_INDIVIDUAL_WIDGET_SHOW_PERSONAS: List the #FolksPersona<!-- -->s
  48  * contained in the individual.
  49  *
  50  * Flags used when creating an #EmpathyIndividualWidget to specify which
  51  * features should be available.
  52  */
  53 typedef enum
  54 {
  55   EMPATHY_INDIVIDUAL_WIDGET_NONE = 0,
  56   EMPATHY_INDIVIDUAL_WIDGET_EDIT_ALIAS   = 1 << 0,
  57   EMPATHY_INDIVIDUAL_WIDGET_EDIT_FAVOURITE = 1 << 1,
  58   EMPATHY_INDIVIDUAL_WIDGET_EDIT_GROUPS  = 1 << 2,
  59   EMPATHY_INDIVIDUAL_WIDGET_FOR_TOOLTIP  = 1 << 3,
  60   EMPATHY_INDIVIDUAL_WIDGET_SHOW_LOCATION  = 1 << 4,
  61   EMPATHY_INDIVIDUAL_WIDGET_SHOW_DETAILS = 1 << 5,
  62   EMPATHY_INDIVIDUAL_WIDGET_SHOW_PERSONAS = 1 << 6,
  63   EMPATHY_INDIVIDUAL_WIDGET_SHOW_CLIENT_TYPES = 1 << 7,
  64 } EmpathyIndividualWidgetFlags;
  65
  66 #define EMPATHY_TYPE_INDIVIDUAL_WIDGET (empathy_individual_widget_get_type ())
  67 #define EMPATHY_INDIVIDUAL_WIDGET(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), \
  68     EMPATHY_TYPE_INDIVIDUAL_WIDGET, EmpathyIndividualWidget))
  69 #define EMPATHY_INDIVIDUAL_WIDGET_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), \
  70     EMPATHY_TYPE_INDIVIDUAL_WIDGET, EmpathyIndividualWidgetClass))
  71 #define EMPATHY_IS_INDIVIDUAL_WIDGET(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), \
  72     EMPATHY_TYPE_INDIVIDUAL_WIDGET))
  73 #define EMPATHY_IS_INDIVIDUAL_WIDGET_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), \
  74     EMPATHY_TYPE_INDIVIDUAL_WIDGET))
  75 #define EMPATHY_INDIVIDUAL_WIDGET_GET_CLASS(o) ( \
  76     G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_INDIVIDUAL_WIDGET, \
  77         EmpathyIndividualWidgetClass))
  78
  79 typedef struct {
  80         GtkBox parent;
  81
  82         /*<private>*/
  83         gpointer priv;
  84 } EmpathyIndividualWidget;
  85
  86 typedef struct {
  87         GtkBoxClass parent_class;
  88 } EmpathyIndividualWidgetClass;
  89
  90 GType empathy_individual_widget_get_type (void) G_GNUC_CONST;
  91
  92 GtkWidget * empathy_individual_widget_new (FolksIndividual *individual,
  93     EmpathyIndividualWidgetFlags flags);
  94
  95 FolksIndividual * empathy_individual_widget_get_individual (
  96     EmpathyIndividualWidget *self);
  97 void empathy_individual_widget_set_individual (EmpathyIndividualWidget *self,
  98     FolksIndividual *individual);
  99
 100 G_END_DECLS
 101
 102 #endif /*  __EMPATHY_INDIVIDUAL_WIDGET_H__ */