Mercurial > pidgin
annotate finch/gntblist.h @ 18557:212c2bec5c97
Allow using custom search functions.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Thu, 19 Jul 2007 08:25:26 +0000 |
parents | 464840043c66 |
children | 44b4e8bd759b |
rev | line source |
---|---|
15817 | 1 /** |
2 * @file gntblist.h GNT BuddyList API | |
16194
0f0832c13fcb
Rename the Doxygen group from gntui to finch and define the finch group
Richard Laager <rlaager@wiktel.com>
parents:
15870
diff
changeset
|
3 * @ingroup finch |
15817 | 4 * |
15870
66dff3dfdea6
Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@wiktel.com>
parents:
15822
diff
changeset
|
5 * finch |
15817 | 6 * |
15870
66dff3dfdea6
Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@wiktel.com>
parents:
15822
diff
changeset
|
7 * Finch is the legal property of its developers, whose names are too numerous |
15817 | 8 * to list here. Please refer to the COPYRIGHT file distributed with this |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GNT_BLIST_H | |
26 #define _GNT_BLIST_H | |
27 | |
28 #include "blist.h" | |
29 | |
30 /********************************************************************** | |
31 * @name GNT BuddyList API | |
32 **********************************************************************/ | |
33 /*@{*/ | |
34 | |
35 /** | |
36 * Get the ui-functions. | |
37 * | |
15822 | 38 * @return The PurpleBlistUiOps structure populated with the appropriate functions. |
15817 | 39 */ |
15822 | 40 PurpleBlistUiOps * finch_blist_get_ui_ops(void); |
15817 | 41 |
42 /** | |
43 * Perform necessary initializations. | |
44 */ | |
45 void finch_blist_init(void); | |
46 | |
47 /** | |
48 * Perform necessary uninitializations. | |
49 */ | |
50 void finch_blist_uninit(void); | |
51 | |
52 /** | |
53 * Show the buddy list. | |
54 */ | |
55 void finch_blist_show(void); | |
56 | |
57 /** | |
58 * Get the position of the buddy list. | |
59 * | |
60 * @param x The x-coordinate is set here if not @ NULL. | |
61 * @param y The y-coordinate is set here if not @c NULL. | |
62 * | |
63 * @return Returns @c TRUE if the values were set, @c FALSE otherwise. | |
64 */ | |
65 gboolean finch_blist_get_position(int *x, int *y); | |
66 | |
67 /** | |
68 * Set the position of the buddy list. | |
69 * | |
70 * @param x The x-coordinate of the buddy list. | |
71 * @param y The y-coordinate of the buddy list. | |
72 */ | |
73 void finch_blist_set_position(int x, int y); | |
74 | |
75 /** | |
76 * Get the size of the buddy list. | |
77 * | |
78 * @param width The width is set here if not @ NULL. | |
79 * @param height The height is set here if not @c NULL. | |
80 * | |
81 * @return Returns @c TRUE if the values were set, @c FALSE otherwise. | |
82 */ | |
83 gboolean finch_blist_get_size(int *width, int *height); | |
84 | |
85 /** | |
86 * Set the size of the buddy list. | |
87 * | |
88 * @param width The width of the buddy list. | |
89 * @param height The height of the buddy list. | |
90 */ | |
91 void finch_blist_set_size(int width, int height); | |
92 | |
17750
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
93 /** |
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
94 * Get information about a user. Show immediate feedback. |
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
95 * |
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
96 * @param conn The connection to get information fro |
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
97 * @param name The user to get information about. |
17804
464840043c66
Show information about the user requesting authorization.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17750
diff
changeset
|
98 * |
464840043c66
Show information about the user requesting authorization.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17750
diff
changeset
|
99 * @return Returns the ui-handle for the userinfo notification. |
17750
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
100 */ |
17804
464840043c66
Show information about the user requesting authorization.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17750
diff
changeset
|
101 gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name); |
17750
319bcb73eb4e
Use utility functions to get user info. Closes #964.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
102 |
15817 | 103 /*@}*/ |
104 | |
105 #endif |