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
|
/*
* finch
*
* Finch 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(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
# error "only <finch.h> may be included directly"
#endif
#ifndef FINCH_BLIST_H
#define FINCH_BLIST_H
#include <purple.h>
#include <gnt.h>
#define FINCH_TYPE_BUDDY_LIST (finch_buddy_list_get_type())
#define FINCH_TYPE_BLIST_MANAGER (finch_blist_manager_get_type())
/**********************************************************************
* GNT BuddyList API
**********************************************************************/
typedef struct _FinchBlistManager FinchBlistManager;
/**
* FinchBlistManager:
* @id: An identifier for the manager.
* @name: Displayable name for the manager.
* @init: Called right before it's being used.
* @uninit: Called right after it's not being used any more.
* @can_add_node: Whether a node should be added to the view.
* @find_parent: Find the parent row for a node.
* @create_tooltip: Create tooltip for a selected row.
*
* Buddylist manager for finch. This decides the visility, ordering and hierarchy
* of the buddylist nodes. This also manages the creation of tooltips.
*/
struct _FinchBlistManager
{
const char *id;
const char *name;
gboolean (*init)(void);
gboolean (*uninit)(void);
gboolean (*can_add_node)(PurpleBlistNode *node);
gpointer (*find_parent)(PurpleBlistNode *node);
gboolean (*create_tooltip)(gpointer selected_row, GString **body, char **title);
/*< private >*/
gpointer reserved[4];
};
GType finch_blist_manager_get_type(void);
G_DECLARE_FINAL_TYPE(FinchBuddyList, finch_buddy_list, FINCH, BUDDY_LIST,
PurpleBuddyList)
/**
* finch_blist_init:
*
* Perform necessary initializations.
*/
void finch_blist_init(void);
/**
* finch_blist_uninit:
*
* Perform necessary uninitializations.
*/
void finch_blist_uninit(void);
/**
* finch_blist_show:
*
* Show the buddy list.
*/
void finch_blist_show(void);
/**
* finch_blist_get_position:
* @x: The x-coordinate is set here if not %NULL.
* @y: The y-coordinate is set here if not %NULL.
*
* Get the position of the buddy list.
*
* Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
gboolean finch_blist_get_position(int *x, int *y);
/**
* finch_blist_set_position:
* @x: The x-coordinate of the buddy list.
* @y: The y-coordinate of the buddy list.
*
* Set the position of the buddy list.
*/
void finch_blist_set_position(int x, int y);
/**
* finch_blist_get_size:
* @width: The width is set here if not %NULL.
* @height: The height is set here if not %NULL.
*
* Get the size of the buddy list.
*
* Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
gboolean finch_blist_get_size(int *width, int *height);
/**
* finch_blist_set_size:
* @width: The width of the buddy list.
* @height: The height of the buddy list.
*
* Set the size of the buddy list.
*/
void finch_blist_set_size(int width, int height);
/**
* finch_retrieve_user_info:
* @conn: The connection to get information from
* @name: The user to get information about.
*
* Get information about a user. Show immediate feedback.
*
* Returns: (transfer none): Returns the ui-handle for the userinfo
* notification.
*/
gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name);
/**
* finch_blist_get_tree:
*
* Get the tree list of the buddy list.
*
* Returns: (transfer none): The GntTree widget.
*/
GntTree * finch_blist_get_tree(void);
/**
* finch_blist_install_manager:
* @manager: The alternate buddylist manager.
*
* Add an alternate buddy list manager.
*/
void finch_blist_install_manager(const FinchBlistManager *manager);
/**
* finch_blist_uninstall_manager:
* @manager: The buddy list manager to remove.
*
* Remove an alternate buddy list manager.
*/
void finch_blist_uninstall_manager(const FinchBlistManager *manager);
/**
* finch_blist_manager_find:
* @id: The identifier for the desired buddy list manager.
*
* Find a buddy list manager.
*
* Returns: The manager with the requested identifier, if available. %NULL
* otherwise.
*/
FinchBlistManager * finch_blist_manager_find(const char *id);
/**
* finch_blist_manager_add_node:
* @node: The node to add
*
* Request the active buddy list manager to add a node.
*/
void finch_blist_manager_add_node(PurpleBlistNode *node);
#endif /* FINCH_BLIST_H */
|
