-
Notifications
You must be signed in to change notification settings - Fork 2
/
contact.h
160 lines (137 loc) · 4.83 KB
/
contact.h
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* 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 program 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.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_META_CONTACT_H
#define PURPLE_META_CONTACT_H
#define PURPLE_TYPE_META_CONTACT (purple_meta_contact_get_type())
#define PURPLE_META_CONTACT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_META_CONTACT, PurpleMetaContact))
#define PURPLE_META_CONTACT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_META_CONTACT, PurpleMetaContactClass))
#define PURPLE_IS_META_CONTACT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_META_CONTACT))
#define PURPLE_IS_META_CONTACT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_META_CONTACT))
#define PURPLE_META_CONTACT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_META_CONTACT, PurpleMetaContactClass))
typedef struct _PurpleMetaContact PurpleMetaContact;
typedef struct _PurpleMetaContactClass PurpleMetaContactClass;
#include "countingnode.h"
#include "group.h"
/**
* PurpleMetaContact:
*
* A contact on the buddy list.
*
* A contact is a counting node, which means it keeps track of the counts of
* the buddies under this contact.
*/
struct _PurpleMetaContact {
PurpleCountingNode counting;
};
struct _PurpleMetaContactClass {
PurpleCountingNodeClass counting_class;
/*< private >*/
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
};
G_BEGIN_DECLS
/**************************************************************************/
/* Contact API */
/**************************************************************************/
/**
* purple_meta_contact_get_type:
*
* Returns: The #GType for the #PurpleMetaContact object.
*/
GType purple_meta_contact_get_type(void);
/**
* purple_meta_contact_new:
*
* Creates a new contact
*
* Returns: A new contact struct
*/
PurpleMetaContact *purple_meta_contact_new(void);
/**
* purple_meta_contact_get_group:
* @contact: The contact
*
* Gets the PurpleGroup from a PurpleMetaContact
*
* Returns: (transfer none): The group.
*/
PurpleGroup *purple_meta_contact_get_group(const PurpleMetaContact *contact);
/**
* purple_meta_contact_get_priority_buddy:
* @contact: The contact
*
* Returns the highest priority buddy for a given contact.
*
* Returns: (transfer none): The highest priority buddy.
*/
PurpleBuddy *purple_meta_contact_get_priority_buddy(PurpleMetaContact *contact);
/**
* purple_meta_contact_set_alias:
* @contact: The contact
* @alias: The alias
*
* Sets the alias for a contact.
*/
void purple_meta_contact_set_alias(PurpleMetaContact *contact, const char *alias);
/**
* purple_meta_contact_get_alias:
* @contact: The contact
*
* Gets the alias for a contact.
*
* Returns: The alias, or NULL if it is not set.
*/
const char *purple_meta_contact_get_alias(PurpleMetaContact *contact);
/**
* purple_meta_contact_on_account:
* @contact: The contact to search through.
* @account: The account.
*
* Determines whether an account owns any buddies in a given contact
*
* Returns: TRUE if there are any buddies from account in the contact, or FALSE otherwise.
*/
gboolean purple_meta_contact_on_account(PurpleMetaContact *contact, PurpleAccount *account);
/**
* purple_meta_contact_invalidate_priority_buddy:
* @contact: The contact
*
* Invalidates the priority buddy so that the next call to
* purple_meta_contact_get_priority_buddy recomputes it.
*/
void purple_meta_contact_invalidate_priority_buddy(PurpleMetaContact *contact);
/**
* purple_meta_contact_merge:
* @source: The contact to merge
* @node: The place to merge to (a buddy or contact)
*
* Merges two contacts
*
* All of the buddies from source will be moved to target
*/
void purple_meta_contact_merge(PurpleMetaContact *source, PurpleBlistNode *node);
G_END_DECLS
#endif /* PURPLE_META_CONTACT_H */