Mercurial > pidgin
annotate libpurple/roomlist.h @ 32035:bbe75a67c755
sametime: fix build (add_buddies added param)
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Sun, 04 Sep 2011 18:42:42 +0000 |
parents | ff051a32e1e8 |
children | 5aa171c8776b |
rev | line source |
---|---|
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
2 * @file roomlist.h Room List API |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
3 * @ingroup core |
20074
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19681
diff
changeset
|
4 */ |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19681
diff
changeset
|
5 |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19681
diff
changeset
|
6 /* purple |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
7 * |
15822 | 8 * Purple is the legal property of its developers, whose names are too numerous |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
9 * to list here. Please refer to the COPYRIGHT file distributed with this |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
10 * source distribution. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
11 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
12 * This program is free software; you can redistribute it and/or modify |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
13 * it under the terms of the GNU General Public License as published by |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
14 * the Free Software Foundation; either version 2 of the License, or |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
15 * (at your option) any later version. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
16 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
17 * This program is distributed in the hope that it will be useful, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
20 * GNU General Public License for more details. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
21 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
22 * You should have received a copy of the GNU General Public License |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
19681
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16664
diff
changeset
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
25 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
26 |
15822 | 27 #ifndef _PURPLE_ROOMLIST_H_ |
28 #define _PURPLE_ROOMLIST_H_ | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
29 |
15822 | 30 typedef struct _PurpleRoomlist PurpleRoomlist; |
31 typedef struct _PurpleRoomlistRoom PurpleRoomlistRoom; | |
32 typedef struct _PurpleRoomlistField PurpleRoomlistField; | |
23372
0efa36fe7d7c
Sprinkle @copydoc around to squash "ref could not be resolved" Doxygen warnings,
Will Thompson <will.thompson@collabora.co.uk>
parents:
22004
diff
changeset
|
33 /** @copydoc _PurpleRoomlistUiOps */ |
15822 | 34 typedef struct _PurpleRoomlistUiOps PurpleRoomlistUiOps; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
35 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
36 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
37 * The types of rooms. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
38 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
39 * These are ORable flags. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
40 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
41 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
42 { |
15822 | 43 PURPLE_ROOMLIST_ROOMTYPE_CATEGORY = 0x01, /**< It's a category, but not a room you can join. */ |
44 PURPLE_ROOMLIST_ROOMTYPE_ROOM = 0x02 /**< It's a room, like the kind you can join. */ | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
45 |
15822 | 46 } PurpleRoomlistRoomType; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
47 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
48 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
49 * The types of fields. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
50 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
51 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
52 { |
15822 | 53 PURPLE_ROOMLIST_FIELD_BOOL, |
54 PURPLE_ROOMLIST_FIELD_INT, | |
55 PURPLE_ROOMLIST_FIELD_STRING /**< We do a g_strdup on the passed value if it's this type. */ | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
56 |
15822 | 57 } PurpleRoomlistFieldType; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
58 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
59 #include "account.h" |
30121
bf088afdc813
roomlist: "glib.h" -> <glib.h>; seems correct-er to me
Paul Aurich <paul@darkrain42.org>
parents:
23372
diff
changeset
|
60 #include <glib.h> |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
61 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
62 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
63 /** Data Structures */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
64 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
65 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
66 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
67 * The room list ops to be filled out by the UI. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
68 */ |
15822 | 69 struct _PurpleRoomlistUiOps { |
70 void (*show_with_account)(PurpleAccount *account); /**< Force the ui to pop up a dialog and get the list */ | |
71 void (*create)(PurpleRoomlist *list); /**< A new list was created. */ | |
72 void (*set_fields)(PurpleRoomlist *list, GList *fields); /**< Sets the columns. */ | |
73 void (*add_room)(PurpleRoomlist *list, PurpleRoomlistRoom *room); /**< Add a room to the list. */ | |
74 void (*in_progress)(PurpleRoomlist *list, gboolean flag); /**< Are we fetching stuff still? */ | |
75 void (*destroy)(PurpleRoomlist *list); /**< We're destroying list. */ | |
16664
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
76 |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
77 void (*_purple_reserved1)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
78 void (*_purple_reserved2)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
79 void (*_purple_reserved3)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
80 void (*_purple_reserved4)(void); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
81 }; |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
82 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
83 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
84 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
85 extern "C" { |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
86 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
87 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
88 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
89 /** @name Room List API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
90 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
91 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
92 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
93 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
94 * This is used to get the room list on an account, asking the UI |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
95 * to pop up a dialog with the specified account already selected, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
96 * and pretend the user clicked the get list button. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
97 * While we're pretending, predend I didn't say anything about dialogs |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
98 * or buttons, since this is the core. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
99 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
100 * @param account The account to get the list on. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
101 */ |
15822 | 102 void purple_roomlist_show_with_account(PurpleAccount *account); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
103 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
104 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
105 * Returns a newly created room list object. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
106 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
107 * It has an initial reference count of 1. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
108 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
109 * @param account The account that's listing rooms. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
110 * @return The new room list handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
111 */ |
15822 | 112 PurpleRoomlist *purple_roomlist_new(PurpleAccount *account); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
113 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
114 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
115 * Increases the reference count on the room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
116 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
117 * @param list The object to ref. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
118 */ |
15822 | 119 void purple_roomlist_ref(PurpleRoomlist *list); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
120 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
121 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
122 * Decreases the reference count on the room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
123 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
124 * The room list will be destroyed when this reaches 0. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
125 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
126 * @param list The room list object to unref and possibly |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
127 * destroy. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
128 */ |
15822 | 129 void purple_roomlist_unref(PurpleRoomlist *list); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
130 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
131 /** |
31934
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
132 * Retrieve the PurpleAccount that was given when the room list was |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
133 * created. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
134 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
135 * @return The PurpleAccount tied to this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
136 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
137 PurpleAccount *purple_roomlist_get_account(PurpleRoomlist *list); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
138 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
139 /** |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
140 * Set the different field types and their names for this protocol. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
141 * |
15822 | 142 * This must be called before purple_roomlist_room_add(). |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
143 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
144 * @param list The room list. |
15822 | 145 * @param fields A GList of PurpleRoomlistField's. UI's are encouraged |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
146 * to default to displaying them in the order given. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
147 */ |
15822 | 148 void purple_roomlist_set_fields(PurpleRoomlist *list, GList *fields); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
149 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
150 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
151 * Set the "in progress" state of the room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
152 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
153 * The UI is encouraged to somehow hint to the user |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
154 * whether or not we're busy downloading a room list or not. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
155 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
156 * @param list The room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
157 * @param in_progress We're downloading it, or we're not. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
158 */ |
15822 | 159 void purple_roomlist_set_in_progress(PurpleRoomlist *list, gboolean in_progress); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
160 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
161 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
162 * Gets the "in progress" state of the room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
163 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
164 * The UI is encouraged to somehow hint to the user |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
165 * whether or not we're busy downloading a room list or not. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
166 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
167 * @param list The room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
168 * @return True if we're downloading it, or false if we're not. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
169 */ |
15822 | 170 gboolean purple_roomlist_get_in_progress(PurpleRoomlist *list); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
171 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
172 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
173 * Adds a room to the list of them. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
174 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
175 * @param list The room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
176 * @param room The room to add to the list. The GList of fields must be in the same |
15822 | 177 order as was given in purple_roomlist_set_fields(). |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
178 */ |
15822 | 179 void purple_roomlist_room_add(PurpleRoomlist *list, PurpleRoomlistRoom *room); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
180 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
181 /** |
15822 | 182 * Returns a PurpleRoomlist structure from the prpl, and |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
183 * instructs the prpl to start fetching the list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
184 * |
15822 | 185 * @param gc The PurpleConnection to have get a list. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
186 * |
15822 | 187 * @return A PurpleRoomlist* or @c NULL if the protocol |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
188 * doesn't support that. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
189 */ |
15822 | 190 PurpleRoomlist *purple_roomlist_get_list(PurpleConnection *gc); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
191 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
192 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
193 * Tells the prpl to stop fetching the list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
194 * If this is possible and done, the prpl will |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
195 * call set_in_progress with @c FALSE and possibly |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
196 * unref the list if it took a reference. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
197 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
198 * @param list The room list to cancel a get_list on. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
199 */ |
15822 | 200 void purple_roomlist_cancel_get_list(PurpleRoomlist *list); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
201 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
202 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
203 * Tells the prpl that a category was expanded. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
204 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
205 * On some protocols, the rooms in the category |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
206 * won't be fetched until this is called. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
207 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
208 * @param list The room list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
209 * @param category The category that was expanded. The expression |
15822 | 210 * (category->type & PURPLE_ROOMLIST_ROOMTYPE_CATEGORY) |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
211 * must be true. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
212 */ |
15822 | 213 void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
214 |
22004
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
215 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
216 * Get the list of fields for a roomlist. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
217 * |
31934
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
218 * @param roomlist The roomlist, which must not be @c NULL. |
22004
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
219 * @constreturn A list of fields |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
220 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
221 */ |
31934
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
222 GList *purple_roomlist_get_fields(PurpleRoomlist *roomlist); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
223 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
224 /** |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
225 * Get the protocol data associated with this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
226 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
227 * @param roomlist The roomlist, which must not be @c NULL. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
228 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
229 * @return The protocol data associated with this room list. This is a |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
230 * convenience field provided to the protocol plugin--it is not |
31968
ff051a32e1e8
Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
andrew.victor@mxit.com
parents:
31934
diff
changeset
|
231 * used the libpurple core. |
31934
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
232 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
233 gpointer purple_roomlist_get_proto_data(PurpleRoomlist *list); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
234 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
235 /** |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
236 * Set the protocol data associated with this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
237 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
238 * @param list The roomlist, which must not be @c NULL. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
239 * @param proto_data A pointer to associate with this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
240 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
241 void purple_roomlist_set_proto_data(PurpleRoomlist *list, gpointer proto_data); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
242 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
243 /** |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
244 * Get the UI data associated with this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
245 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
246 * @param roomlist The roomlist, which must not be @c NULL. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
247 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
248 * @return The UI data associated with this room list. This is a |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
249 * convenience field provided to the UIs--it is not |
31968
ff051a32e1e8
Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
andrew.victor@mxit.com
parents:
31934
diff
changeset
|
250 * used by the libpurple core. |
31934
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
251 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
252 gpointer purple_roomlist_get_ui_data(PurpleRoomlist *list); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
253 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
254 /** |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
255 * Set the UI data associated with this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
256 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
257 * @param list The roomlist, which must not be @c NULL. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
258 * @param UI_data A pointer to associate with this room list. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
259 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
260 void purple_roomlist_set_ui_data(PurpleRoomlist *list, gpointer ui_data); |
22004
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
261 |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
262 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
263 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
264 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
265 /** @name Room API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
266 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
267 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
268 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
269 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
270 * Creates a new room, to be added to the list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
271 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
272 * @param type The type of room. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
273 * @param name The name of the room. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
274 * @param parent The room's parent, if any. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
275 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
276 * @return A new room. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
277 */ |
15822 | 278 PurpleRoomlistRoom *purple_roomlist_room_new(PurpleRoomlistRoomType type, const gchar *name, |
279 PurpleRoomlistRoom *parent); | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
280 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
281 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
282 * Adds a field to a room. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
283 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
284 * @param list The room list the room belongs to. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
285 * @param room The room. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
286 * @param field The field to append. Strings get g_strdup'd internally. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
287 */ |
15822 | 288 void purple_roomlist_room_add_field(PurpleRoomlist *list, PurpleRoomlistRoom *room, gconstpointer field); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
289 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
290 /** |
15822 | 291 * Join a room, given a PurpleRoomlistRoom and it's associated PurpleRoomlist. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
292 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
293 * @param list The room list the room belongs to. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
294 * @param room The room to join. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
295 */ |
15822 | 296 void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
297 |
22004
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
298 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
299 * Get the type of a room. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
300 * @param room The room, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
301 * @return The type of the room. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
302 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
303 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
304 PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
305 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
306 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
307 * Get the name of a room. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
308 * @param room The room, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
309 * @return The name of the room. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
310 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
311 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
312 const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
313 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
314 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
315 * Get the parent of a room. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
316 * @param room The room, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
317 * @return The parent of the room, which can be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
318 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
319 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
320 PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
321 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
322 /** |
31934
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
323 * Get the value of the expanded_once flag. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
324 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
325 * @param room The room, which must not be @c NULL. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
326 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
327 * @return The value of the expanded_once flag. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
328 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
329 gboolean purple_roomlist_room_get_expanded_once(PurpleRoomlistRoom *room); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
330 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
331 /** |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
332 * Set the expanded_once flag. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
333 * |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
334 * @param room The room, which must not be @c NULL. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
335 * @param expanded_once The new value of the expanded_once flag. |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
336 */ |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
337 void purple_roomlist_room_set_expanded_once(PurpleRoomlistRoom *room, gboolean expanded_once); |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
338 |
5dafa68c8eb0
Some struct hiding. What a pain.
Mark Doliner <mark@kingant.net>
parents:
30121
diff
changeset
|
339 /** |
22004
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
340 * Get the list of fields for a room. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
341 * |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
342 * @param room The room, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
343 * @constreturn A list of fields |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
344 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
345 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
346 GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
347 |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
348 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
349 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
350 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
351 /** @name Room Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
352 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
353 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
354 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
355 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
356 * Creates a new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
357 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
358 * @param type The type of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
359 * @param label The i18n'ed, user displayable name. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
360 * @param name The internal name of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
361 * @param hidden Hide the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
362 * |
15822 | 363 * @return A new PurpleRoomlistField, ready to be added to a GList and passed to |
364 * purple_roomlist_set_fields(). | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
365 */ |
15822 | 366 PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type, |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
367 const gchar *label, const gchar *name, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
368 gboolean hidden); |
22004
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
369 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
370 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
371 * Get the type of a field. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
372 * |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
373 * @param field A PurpleRoomlistField, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
374 * |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
375 * @return The type of the field. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
376 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
377 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
378 PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
379 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
380 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
381 * Get the label of a field. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
382 * |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
383 * @param field A PurpleRoomlistField, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
384 * |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
385 * @return The label of the field. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
386 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
387 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
388 const char * purple_roomlist_field_get_label(PurpleRoomlistField *field); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
389 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
390 /** |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
391 * Check whether a roomlist-field is hidden. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
392 * @param field A PurpleRoomlistField, which must not be @c NULL. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
393 * |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
394 * @return @c TRUE if the field is hidden, @c FALSE otherwise. |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
395 * @since 2.4.0 |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
396 */ |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
397 gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field); |
f9dcdc0e89a5
A list of accessor functions to the roomlist API.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20074
diff
changeset
|
398 |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
399 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
400 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
401 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
402 /** @name UI Registration Functions */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
403 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
404 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
405 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
406 /** |
15822 | 407 * Sets the UI operations structure to be used in all purple room lists. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
408 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
409 * @param ops The UI operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
410 */ |
15822 | 411 void purple_roomlist_set_ui_ops(PurpleRoomlistUiOps *ops); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
412 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
413 /** |
15822 | 414 * Returns the purple window UI operations structure to be used in |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
415 * new windows. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
416 * |
15822 | 417 * @return A filled-out PurpleRoomlistUiOps structure. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
418 */ |
15822 | 419 PurpleRoomlistUiOps *purple_roomlist_get_ui_ops(void); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
420 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
421 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
422 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
423 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
424 } |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
425 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
426 |
15822 | 427 #endif /* _PURPLE_ROOMLIST_H_ */ |