aboutsummaryrefslogtreecommitdiffstats
path: root/libempathy/empathy-contact-list.h
blob: cf523bf2ab5d527f53af8ead6163c7c3aa99c976 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2007-2008 Collabora Ltd.
 *
 * 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 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
 * Lesser General Public License for more details.
 *
 * 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>
 */

#ifndef __EMPATHY_CONTACT_LIST_H__
#define __EMPATHY_CONTACT_LIST_H__

#include <glib-object.h>

#include "empathy-types.h"
#include "empathy-contact.h"

G_BEGIN_DECLS

#define EMPATHY_TYPE_CONTACT_LIST         (empathy_contact_list_get_type ())
#define EMPATHY_CONTACT_LIST(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CONTACT_LIST, EmpathyContactList))
#define EMPATHY_IS_CONTACT_LIST(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CONTACT_LIST))
#define EMPATHY_CONTACT_LIST_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), EMPATHY_TYPE_CONTACT_LIST, EmpathyContactListIface))

typedef enum {
    EMPATHY_CONTACT_LIST_CAN_ADD        = 1 << 0,
    EMPATHY_CONTACT_LIST_CAN_REMOVE     = 1 << 1,
    EMPATHY_CONTACT_LIST_CAN_ALIAS      = 1 << 2,
    EMPATHY_CONTACT_LIST_CAN_GROUP      = 1 << 3,
    EMPATHY_CONTACT_LIST_CAN_BLOCK      = 1 << 4,
    EMPATHY_CONTACT_LIST_CAN_REPORT_ABUSIVE = 1 << 5,
} EmpathyContactListFlags;

typedef struct _EmpathyContactListIface EmpathyContactListIface;

struct _EmpathyContactListIface {
    GTypeInterface   base_iface;

    /* VTabled */
    void             (*add)               (EmpathyContactList *list,
                           EmpathyContact     *contact,
                           const gchar        *message);
    void             (*remove)            (EmpathyContactList *list,
                           EmpathyContact     *contact,
                           const gchar        *message);
    GList *          (*get_members)       (EmpathyContactList *list);
    GList *          (*get_pendings)      (EmpathyContactList *list);
    GList *          (*get_all_groups)    (EmpathyContactList *list);
    GList *          (*get_groups)        (EmpathyContactList *list,
                           EmpathyContact     *contact);
    void             (*add_to_group)      (EmpathyContactList *list,
                           EmpathyContact     *contact,
                           const gchar        *group);
    void             (*remove_from_group) (EmpathyContactList *list,
                           EmpathyContact     *contact,
                           const gchar        *group);
    void             (*rename_group)      (EmpathyContactList *list,
                           const gchar        *old_group,
                           const gchar        *new_group);
    void         (*remove_group)      (EmpathyContactList *list,
                           const gchar    *group);
    EmpathyContactListFlags
             (*get_flags)         (EmpathyContactList *list);
    gboolean         (*is_favourite)      (EmpathyContactList *list,
                           EmpathyContact     *contact);
    void             (*add_favourite)     (EmpathyContactList *list,
                           EmpathyContact     *contact);
    void             (*remove_favourite)  (EmpathyContactList *list,
                           EmpathyContact     *contact);
    void             (*set_blocked)       (EmpathyContactList *list,
                                   EmpathyContact     *contact,
                           gboolean            blocked,
                           gboolean            abusive);
    gboolean         (*get_blocked)       (EmpathyContactList *list,
                                   EmpathyContact     *contact);
};

GType    empathy_contact_list_get_type          (void) G_GNUC_CONST;
void     empathy_contact_list_add               (EmpathyContactList *list,
                         EmpathyContact     *contact,
                         const gchar        *message);
void     empathy_contact_list_remove            (EmpathyContactList *list,
                         EmpathyContact     *contact,
                         const gchar        *message);
GList *  empathy_contact_list_get_members       (EmpathyContactList *list);
GList *  empathy_contact_list_get_pendings      (EmpathyContactList *list);
GList *  empathy_contact_list_get_all_groups    (EmpathyContactList *list);
GList *  empathy_contact_list_get_groups        (EmpathyContactList *list,
                         EmpathyContact     *contact);
void     empathy_contact_list_add_to_group      (EmpathyContactList *list,
                         EmpathyContact     *contact,
                         const gchar        *group);
void     empathy_contact_list_remove_from_group (EmpathyContactList *list,
                         EmpathyContact     *contact,
                         const gchar        *group);
void     empathy_contact_list_rename_group      (EmpathyContactList *list,
                         const gchar        *old_group,
                         const gchar        *new_group);
void     empathy_contact_list_remove_group  (EmpathyContactList *list,
                         const gchar        *group);

EmpathyContactListFlags
         empathy_contact_list_get_flags     (EmpathyContactList *list);

gboolean empathy_contact_list_is_favourite      (EmpathyContactList *list,
                         EmpathyContact     *contact);

void     empathy_contact_list_add_to_favourites (EmpathyContactList *list,
                         EmpathyContact     *contact);

void     empathy_contact_list_remove_from_favourites
                                                (EmpathyContactList *list,
                         EmpathyContact     *contact);

void     empathy_contact_list_set_blocked       (EmpathyContactList *list,
                                         EmpathyContact     *contact,
                         gboolean            blocked,
                         gboolean            abusive);
gboolean empathy_contact_list_get_blocked       (EmpathyContactList *list,
                         EmpathyContact     *contact);


G_END_DECLS

#endif /* __EMPATHY_CONTACT_LIST_H__ */