summaryrefslogtreecommitdiff
path: root/pidgin/pidginavatar.h
blob: a1561cbac4f0da93ac6ff8fe2edb53519ed0169e (plain)
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
/*
 * Pidgin - Internet Messenger
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Pidgin 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, see <https://www.gnu.org/licenses/>.
 */

#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif

#ifndef PIDGIN_AVATAR_H
#define PIDGIN_AVATAR_H

#include <glib.h>

#include <gtk/gtk.h>

#include <purple.h>

G_BEGIN_DECLS

/**
 * PidginAvatar:
 *
 * #PidginAvatar is a widget that displays avatars for contacts or
 * conversations.
 *
 * Since: 3.0.0
 */

#define PIDGIN_TYPE_AVATAR (pidgin_avatar_get_type())
G_DECLARE_FINAL_TYPE(PidginAvatar, pidgin_avatar, PIDGIN, AVATAR, GtkBox)

/**
 * pidgin_avatar_new:
 *
 * Creates a new #PidginAvatar instance.
 *
 * Returns: (transfer full): The new #PidginAvatar instance.
 *
 * Since: 3.0.0
 */
GtkWidget *pidgin_avatar_new(void);

/**
 * pidgin_avatar_set_animate:
 * @avatar: The #PidginAvatar instance.
 * @animate: Whether or not to animate the avatar.
 *
 * Starts or stops animation of @avatar.  If avatar is displaying a
 * non-animated image, changing this will do nothing unless a new animated
 * image is set.
 *
 * Since: 3.0.0
 */
void pidgin_avatar_set_animate(PidginAvatar *avatar, gboolean animate);

/**
 * pidgin_avatar_get_animate:
 * @avatar: The #PidginAvatar instance.
 *
 * Gets whether or not @avatar should be animated.
 *
 * Returns: Whether or not @avatar should be animated.
 *
 * Since: 3.0.0
 */
gboolean pidgin_avatar_get_animate(PidginAvatar *avatar);

/**
 * pidgin_avatar_set_buddy:
 * @avatar: The #PidginAvatar instance.
 * @buddy: (nullable): The #PurpleBuddy to set or %NULL to unset.
 *
 * Sets or unsets the #PurpleBuddy that @avatar should use for display.
 *
 * Since: 3.0.0
 */
void pidgin_avatar_set_buddy(PidginAvatar *avatar, PurpleBuddy *buddy);

/**
 * pidgin_avatar_get_buddy:
 * @avatar: The #PidginAvatar instance.
 *
 * Gets the #PurpleBuddy that @avatar is using for display.
 *
 * Returns: (transfer none): The #PurpleBuddy that @avatar is using for display.
 *
 * Since: 3.0.0
 */
PurpleBuddy *pidgin_avatar_get_buddy(PidginAvatar *avatar);

/**
 * pidgin_avatar_set_conversation:
 * @avatar: The #PidginAvatar instance.
 * @conversation: (nullable): The #PurpleConversation to set or %NULL to unset.
 *
 * Sets or unsets the #PurpleConversation that @avatar uses to find the
 * #PurpleBuddy whose icon to display.
 *
 * Since: 3.0.0
 */
void pidgin_avatar_set_conversation(PidginAvatar *avatar, PurpleConversation *conversation);

/**
 * pidgin_avatar_get_conversation:
 * @avatar: The #PidginAvatar instance.
 *
 * Gets the #PurpleConversation that @avatar is using for display.
 *
 * Returns: (transfer none): The #PurpleConversation that @avatar is using to
 *          find the #PurpleBuddy whose icon to display.
 *
 * Since: 3.0.0
 */
PurpleConversation *pidgin_avatar_get_conversation(PidginAvatar *avatar);

G_END_DECLS

#endif /* PIDGIN_AVATAR_H */