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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef PURPLE_PERSON_H
#define PURPLE_PERSON_H
#include <glib.h>
#include <glib-object.h>
#include <gdk-pixbuf/gdk-pixbuf.h>
#include <libpurple/purpletags.h>
G_BEGIN_DECLS
#define PURPLE_TYPE_PERSON (purple_person_get_type())
G_DECLARE_FINAL_TYPE(PurplePerson, purple_person, PURPLE, PERSON, GObject)
#include <libpurple/purplecontactinfo.h>
/**
* PurplePerson:
*
* A collection of [class@Purple.ContactInfo] that contains a user selectable
* custom avatar and alias.
*
* Since: 3.0.0
*/
/**
* purple_person_new:
*
* Creates a new [class@Purple.Person].
*
* Returns: (transfer full): The new instance.
*
* Since: 3.0.0
*/
PurplePerson *purple_person_new(void);
/**
* purple_person_get_id:
* @person: The instance.
*
* Gets the id of @person. This is created internally and is read-only.
*
* Returns: The id of @person.
*
* Since: 3.0.0
*/
const gchar *purple_person_get_id(PurplePerson *person);
/**
* purple_person_get_alias:
* @person: The instance.
*
* Gets the alias of @person that was set by the libpurple user.
*
* This will be %NULL if no alias is set.
*
* Returns: (nullable): The alias of @person or %NULL.
*
* Since: 3.0.0
*/
const gchar *purple_person_get_alias(PurplePerson *person);
/**
* purple_person_set_alias:
* @person: The instance.
* @alias: (nullable): The new alias.
*
* Sets the alias of @person to @alias.
*
* This should only be called in direct response to a user interaction to set a
* custom alias. Protocol plugins should only be setting the alias of
* [class@Purple.Contact].
*
* If @alias is %NULL, then the previous alias is cleared.
*
* Since: 3.0.0
*/
void purple_person_set_alias(PurplePerson *person, const gchar *alias);
/**
* purple_person_get_avatar_for_display:
* @person: The instance.
*
* Gets the avatar that should be displayed for @person. If @person has an
* avatar set, it will be returned, otherwise this will fallback to the value
* of [property@Purple.ContactInfo:avatar] for
* [property@Purple.Person:priority-contact-info].
*
* Returns: (transfer none) (nullable): The avatar to display.
*
* Since: 3.0.0
*/
GdkPixbuf *purple_person_get_avatar_for_display(PurplePerson *person);
/**
* purple_person_get_avatar:
* @person: The instance.
*
* Gets the avatar of @person or %NULL if no avatar is set.
*
* Returns: (transfer none) (nullable): The avatar for @person.
*
* Since: 3.0.0
*/
GdkPixbuf *purple_person_get_avatar(PurplePerson *person);
/**
* purple_person_set_avatar:
* @person: The instance.
* @avatar: (nullable): The new avatar.
*
* Sets the avatar of @person to @avatar. If @avatar is %NULL then the previous
* avatar is cleared.
*
* This should only be called in direct response to a user interaction to set a
* custom avatar. Protocol plugins should only be setting the avatars of
* [class@Purple.Contact].
*
* Since: 3.0.0
*/
void purple_person_set_avatar(PurplePerson *person, GdkPixbuf *avatar);
/**
* purple_person_get_tags:
* @person: The instance.
*
* Gets the [class@Purple.Tags] instance for @person.
*
* Returns: (transfer none): The tags for @person.
*
* Since: 3.0.0
*/
PurpleTags *purple_person_get_tags(PurplePerson *person);
/**
* purple_person_get_name_for_display:
* @person: The instance.
*
* Gets the name that should be displayed for @person. See
* [property@Purple.Person:name-for-display] for more information.
*
* Returns: (transfer none): The name to display for @person.
*
* Since: 3.0.0
*/
const char *purple_person_get_name_for_display(PurplePerson *person);
/**
* purple_person_add_contact:
* @person: The instance.
* @info: The [class@Purple.ContactInfo] to add.
*
* Adds @info to @person.
*
* Duplicate contacts are currently allowed, but that may change at a later
* time.
*
* Since: 3.0.0
*/
void purple_person_add_contact_info(PurplePerson *person, PurpleContactInfo *info);
/**
* purple_person_remove_contact_info:
* @person: The instance.
* @info: The [class@Purple.ContactInfo] to remove.
*
* Removes @info from @person.
*
* Returns: %TRUE if @info was found and removed otherwise %FALSE.
*
* Since: 3.0.0
*/
gboolean purple_person_remove_contact_info(PurplePerson *person, PurpleContactInfo *info);
/**
* purple_person_get_priority_contact_info:
* @person: The instance.
*
* Gets the contact info for the most available contact info in @person.
*
* Returns: (transfer none) (nullable): The priority contact or %NULL if
* @person does not have any contacts.
*
* Since: 3.0.0
*/
PurpleContactInfo *purple_person_get_priority_contact_info(PurplePerson *person);
/*
* purple_person_has_contacts:
* @person: The instance.
*
* Gets whether or not @person has any contacts.
*
* Returns: %TRUE if @person has at least one contact, otherwise %FALSE.
*
* Since: 3.0.0
*/
gboolean purple_person_has_contacts(PurplePerson *person);
/**
* purple_person_matches:
* @person: The instance.
* @needle: (nullable): The string to match on.
*
* Checks if the alias matches @needle. This also checks @needle against
* [method@Purple.ContactInfo.matches] for each [class@Purple.ContactInfo] that
* @person is tracking.
*
* If @needle is %NULL or empty string, %TRUE will be returned.
*
* Returns: %TRUE if @person matches @needle in any way.
*
* Since: 3.0.0
*/
gboolean purple_person_matches(PurplePerson *person, const char *needle);
G_END_DECLS
#endif /* PURPLE_PERSON_H */
|
