EmpathyContactListStore

EmpathyContactListStore

Synopsis




#define             EMPATHY_TYPE_CONTACT_LIST_STORE_SORT
enum                EmpathyContactListStoreSort;
                    EmpathyContactListStorePriv;
                    EmpathyContactListStore;
GList*              (*EmpathyContactGroupsFunc)         (EmpathyContact *contact,
                                                         gpointer user_data);
GType               empathy_contact_list_store_get_type (void);
EmpathyContactListStore* empathy_contact_list_store_new (EmpathyContactList *list_iface);
EmpathyContactList* empathy_contact_list_store_get_list_iface
                                                        (EmpathyContactListStore *store);
gboolean            empathy_contact_list_store_get_show_offline
                                                        (EmpathyContactListStore *store);
void                empathy_contact_list_store_set_show_offline
                                                        (EmpathyContactListStore *store,
                                                         gboolean show_offline);
gboolean            empathy_contact_list_store_get_show_avatars
                                                        (EmpathyContactListStore *store);
void                empathy_contact_list_store_set_show_avatars
                                                        (EmpathyContactListStore *store,
                                                         gboolean show_avatars);
gboolean            empathy_contact_list_store_get_is_compact
                                                        (EmpathyContactListStore *store);
void                empathy_contact_list_store_set_is_compact
                                                        (EmpathyContactListStore *store,
                                                         gboolean is_compact);
EmpathyContactListStoreSort empathy_contact_list_store_get_sort_criterium
                                                        (EmpathyContactListStore *store);
void                empathy_contact_list_store_set_sort_criterium
                                                        (EmpathyContactListStore *store,
                                                         EmpathyContactListStoreSort sort_criterium);
gboolean            empathy_contact_list_store_row_separator_func
                                                        (GtkTreeModel *model,
                                                         GtkTreeIter *iter,
                                                         gpointer data);
gchar*              empathy_contact_list_store_get_parent_group
                                                        (GtkTreeModel *model,
                                                         GtkTreePath *path,
                                                         gboolean *path_is_group);
gboolean            empathy_contact_list_store_search_equal_func
                                                        (GtkTreeModel *model,
                                                         gint column,
                                                         const gchar *key,
                                                         GtkTreeIter *iter,
                                                         gpointer search_data);
void                empathy_contact_list_store_set_contact_groups_func
                                                        (EmpathyContactListStore *store,
                                                         EmpathyContactGroupsFunc func,
                                                         gpointer user_data);
void                empathy_contact_list_store_update_contact_groups
                                                        (EmpathyContactListStore *store,
                                                         EmpathyContact *contact);

Object Hierarchy


  GObject
   +----GtkTreeStore
         +----EmpathyContactListStore

Implemented Interfaces

EmpathyContactListStore implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.

Properties


  "is-compact"               gboolean              : Read / Write
  "show-avatars"             gboolean              : Read / Write
  "show-offline"             gboolean              : Read / Write
  "sort-criterium"           EmpathyContactListStoreSort  : Read / Write

Description

Details

EMPATHY_TYPE_CONTACT_LIST_STORE_SORT

#define EMPATHY_TYPE_CONTACT_LIST_STORE_SORT    (empathy_contact_list_store_sort_get_type ())


enum EmpathyContactListStoreSort

typedef enum {
	EMPATHY_CONTACT_LIST_STORE_SORT_STATE,
	EMPATHY_CONTACT_LIST_STORE_SORT_NAME
} EmpathyContactListStoreSort;


EmpathyContactListStorePriv

typedef struct _EmpathyContactListStorePriv EmpathyContactListStorePriv;


EmpathyContactListStore

typedef struct _EmpathyContactListStore EmpathyContactListStore;


EmpathyContactGroupsFunc ()

GList*              (*EmpathyContactGroupsFunc)         (EmpathyContact *contact,
                                                         gpointer user_data);

contact :
user_data :
Returns :

empathy_contact_list_store_get_type ()

GType               empathy_contact_list_store_get_type (void);

Returns :

empathy_contact_list_store_new ()

EmpathyContactListStore* empathy_contact_list_store_new (EmpathyContactList *list_iface);

list_iface :
Returns :

empathy_contact_list_store_get_list_iface ()

EmpathyContactList* empathy_contact_list_store_get_list_iface
                                                        (EmpathyContactListStore *store);

store :
Returns :

empathy_contact_list_store_get_show_offline ()

gboolean            empathy_contact_list_store_get_show_offline
                                                        (EmpathyContactListStore *store);

store :
Returns :

empathy_contact_list_store_set_show_offline ()

void                empathy_contact_list_store_set_show_offline
                                                        (EmpathyContactListStore *store,
                                                         gboolean show_offline);

store :
show_offline :

empathy_contact_list_store_get_show_avatars ()

gboolean            empathy_contact_list_store_get_show_avatars
                                                        (EmpathyContactListStore *store);

store :
Returns :

empathy_contact_list_store_set_show_avatars ()

void                empathy_contact_list_store_set_show_avatars
                                                        (EmpathyContactListStore *store,
                                                         gboolean show_avatars);

store :
show_avatars :

empathy_contact_list_store_get_is_compact ()

gboolean            empathy_contact_list_store_get_is_compact
                                                        (EmpathyContactListStore *store);

store :
Returns :

empathy_contact_list_store_set_is_compact ()

void                empathy_contact_list_store_set_is_compact
                                                        (EmpathyContactListStore *store,
                                                         gboolean is_compact);

store :
is_compact :

empathy_contact_list_store_get_sort_criterium ()

EmpathyContactListStoreSort empathy_contact_list_store_get_sort_criterium
                                                        (EmpathyContactListStore *store);

store :
Returns :

empathy_contact_list_store_set_sort_criterium ()

void                empathy_contact_list_store_set_sort_criterium
                                                        (EmpathyContactListStore *store,
                                                         EmpathyContactListStoreSort sort_criterium);

store :
sort_criterium :

empathy_contact_list_store_row_separator_func ()

gboolean            empathy_contact_list_store_row_separator_func
                                                        (GtkTreeModel *model,
                                                         GtkTreeIter *iter,
                                                         gpointer data);

model :
iter :
data :
Returns :

empathy_contact_list_store_get_parent_group ()

gchar*              empathy_contact_list_store_get_parent_group
                                                        (GtkTreeModel *model,
                                                         GtkTreePath *path,
                                                         gboolean *path_is_group);

model :
path :
path_is_group :
Returns :

empathy_contact_list_store_search_equal_func ()

gboolean            empathy_contact_list_store_search_equal_func
                                                        (GtkTreeModel *model,
                                                         gint column,
                                                         const gchar *key,
                                                         GtkTreeIter *iter,
                                                         gpointer search_data);

model :
column :
key :
iter :
search_data :
Returns :

empathy_contact_list_store_set_contact_groups_func ()

void                empathy_contact_list_store_set_contact_groups_func
                                                        (EmpathyContactListStore *store,
                                                         EmpathyContactGroupsFunc func,
                                                         gpointer user_data);

store :
func :
user_data :

empathy_contact_list_store_update_contact_groups ()

void                empathy_contact_list_store_update_contact_groups
                                                        (EmpathyContactListStore *store,
                                                         EmpathyContact *contact);

store :
contact :

Property Details

The "is-compact" property

  "is-compact"               gboolean              : Read / Write

Whether the contact list is in compact mode or not.

Default value: FALSE


The "show-avatars" property

  "show-avatars"             gboolean              : Read / Write

Whether contact list should display avatars for contacts.

Default value: TRUE


The "show-offline" property

  "show-offline"             gboolean              : Read / Write

Whether contact list should display offline contacts.

Default value: FALSE


The "sort-criterium" property

  "sort-criterium"           EmpathyContactListStoreSort  : Read / Write

The sort criterium to use for sorting the contact list.

Default value: EMPATHY_CONTACT_LIST_STORE_SORT_NAME