/usr/include/libpurple/roomlist.h is in libpurple-dev 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 | /**
* @file roomlist.h Room List API
* @ingroup core
*/
/* purple
*
* Purple 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
*/
#ifndef _PURPLE_ROOMLIST_H_
#define _PURPLE_ROOMLIST_H_
typedef struct _PurpleRoomlist PurpleRoomlist;
typedef struct _PurpleRoomlistRoom PurpleRoomlistRoom;
typedef struct _PurpleRoomlistField PurpleRoomlistField;
/** @copydoc _PurpleRoomlistUiOps */
typedef struct _PurpleRoomlistUiOps PurpleRoomlistUiOps;
/**
* The types of rooms.
*
* These are ORable flags.
*/
typedef enum
{
PURPLE_ROOMLIST_ROOMTYPE_CATEGORY = 0x01, /**< It's a category, but not a room you can join. */
PURPLE_ROOMLIST_ROOMTYPE_ROOM = 0x02 /**< It's a room, like the kind you can join. */
} PurpleRoomlistRoomType;
/**
* The types of fields.
*/
typedef enum
{
PURPLE_ROOMLIST_FIELD_BOOL,
PURPLE_ROOMLIST_FIELD_INT,
PURPLE_ROOMLIST_FIELD_STRING /**< We do a g_strdup on the passed value if it's this type. */
} PurpleRoomlistFieldType;
#include "account.h"
#include <glib.h>
/**************************************************************************/
/** Data Structures */
/**************************************************************************/
/**
* Represents a list of rooms for a given connection on a given protocol.
*/
struct _PurpleRoomlist {
PurpleAccount *account; /**< The account this list belongs to. */
GList *fields; /**< The fields. */
GList *rooms; /**< The list of rooms. */
gboolean in_progress; /**< The listing is in progress. */
gpointer ui_data; /**< UI private data. */
gpointer proto_data; /** Prpl private data. */
guint ref; /**< The reference count. */
};
/**
* Represents a room.
*/
struct _PurpleRoomlistRoom {
PurpleRoomlistRoomType type; /**< The type of room. */
gchar *name; /**< The name of the room. */
GList *fields; /**< Other fields. */
PurpleRoomlistRoom *parent; /**< The parent room, or NULL. */
gboolean expanded_once; /**< A flag the UI uses to avoid multiple expand prpl cbs. */
};
/**
* A field a room might have.
*/
struct _PurpleRoomlistField {
PurpleRoomlistFieldType type; /**< The type of field. */
gchar *label; /**< The i18n user displayed name of the field. */
gchar *name; /**< The internal name of the field. */
gboolean hidden; /**< Hidden? */
};
/**
* The room list ops to be filled out by the UI.
*/
struct _PurpleRoomlistUiOps {
void (*show_with_account)(PurpleAccount *account); /**< Force the ui to pop up a dialog and get the list */
void (*create)(PurpleRoomlist *list); /**< A new list was created. */
void (*set_fields)(PurpleRoomlist *list, GList *fields); /**< Sets the columns. */
void (*add_room)(PurpleRoomlist *list, PurpleRoomlistRoom *room); /**< Add a room to the list. */
void (*in_progress)(PurpleRoomlist *list, gboolean flag); /**< Are we fetching stuff still? */
void (*destroy)(PurpleRoomlist *list); /**< We're destroying list. */
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
};
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Room List API */
/**************************************************************************/
/*@{*/
/**
* This is used to get the room list on an account, asking the UI
* to pop up a dialog with the specified account already selected,
* and pretend the user clicked the get list button.
* While we're pretending, predend I didn't say anything about dialogs
* or buttons, since this is the core.
*
* @param account The account to get the list on.
*/
void purple_roomlist_show_with_account(PurpleAccount *account);
/**
* Returns a newly created room list object.
*
* It has an initial reference count of 1.
*
* @param account The account that's listing rooms.
* @return The new room list handle.
*/
PurpleRoomlist *purple_roomlist_new(PurpleAccount *account);
/**
* Increases the reference count on the room list.
*
* @param list The object to ref.
*/
void purple_roomlist_ref(PurpleRoomlist *list);
/**
* Decreases the reference count on the room list.
*
* The room list will be destroyed when this reaches 0.
*
* @param list The room list object to unref and possibly
* destroy.
*/
void purple_roomlist_unref(PurpleRoomlist *list);
/**
* Set the different field types and their names for this protocol.
*
* This must be called before purple_roomlist_room_add().
*
* @param list The room list.
* @param fields A GList of PurpleRoomlistField's. UI's are encouraged
* to default to displaying them in the order given.
*/
void purple_roomlist_set_fields(PurpleRoomlist *list, GList *fields);
/**
* Set the "in progress" state of the room list.
*
* The UI is encouraged to somehow hint to the user
* whether or not we're busy downloading a room list or not.
*
* @param list The room list.
* @param in_progress We're downloading it, or we're not.
*/
void purple_roomlist_set_in_progress(PurpleRoomlist *list, gboolean in_progress);
/**
* Gets the "in progress" state of the room list.
*
* The UI is encouraged to somehow hint to the user
* whether or not we're busy downloading a room list or not.
*
* @param list The room list.
* @return True if we're downloading it, or false if we're not.
*/
gboolean purple_roomlist_get_in_progress(PurpleRoomlist *list);
/**
* Adds a room to the list of them.
*
* @param list The room list.
* @param room The room to add to the list. The GList of fields must be in the same
order as was given in purple_roomlist_set_fields().
*/
void purple_roomlist_room_add(PurpleRoomlist *list, PurpleRoomlistRoom *room);
/**
* Returns a PurpleRoomlist structure from the prpl, and
* instructs the prpl to start fetching the list.
*
* @param gc The PurpleConnection to have get a list.
*
* @return A PurpleRoomlist* or @c NULL if the protocol
* doesn't support that.
*/
PurpleRoomlist *purple_roomlist_get_list(PurpleConnection *gc);
/**
* Tells the prpl to stop fetching the list.
* If this is possible and done, the prpl will
* call set_in_progress with @c FALSE and possibly
* unref the list if it took a reference.
*
* @param list The room list to cancel a get_list on.
*/
void purple_roomlist_cancel_get_list(PurpleRoomlist *list);
/**
* Tells the prpl that a category was expanded.
*
* On some protocols, the rooms in the category
* won't be fetched until this is called.
*
* @param list The room list.
* @param category The category that was expanded. The expression
* (category->type & PURPLE_ROOMLIST_ROOMTYPE_CATEGORY)
* must be true.
*/
void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category);
/**
* Get the list of fields for a roomlist.
*
* @param roomlist The roomlist, which must not be @c NULL.
* @constreturn A list of fields
* @since 2.4.0
*/
GList * purple_roomlist_get_fields(PurpleRoomlist *roomlist);
/*@}*/
/**************************************************************************/
/** @name Room API */
/**************************************************************************/
/*@{*/
/**
* Creates a new room, to be added to the list.
*
* @param type The type of room.
* @param name The name of the room.
* @param parent The room's parent, if any.
*
* @return A new room.
*/
PurpleRoomlistRoom *purple_roomlist_room_new(PurpleRoomlistRoomType type, const gchar *name,
PurpleRoomlistRoom *parent);
/**
* Adds a field to a room.
*
* @param list The room list the room belongs to.
* @param room The room.
* @param field The field to append. Strings get g_strdup'd internally.
*/
void purple_roomlist_room_add_field(PurpleRoomlist *list, PurpleRoomlistRoom *room, gconstpointer field);
/**
* Join a room, given a PurpleRoomlistRoom and it's associated PurpleRoomlist.
*
* @param list The room list the room belongs to.
* @param room The room to join.
*/
void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room);
/**
* Get the type of a room.
* @param room The room, which must not be @c NULL.
* @return The type of the room.
* @since 2.4.0
*/
PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room);
/**
* Get the name of a room.
* @param room The room, which must not be @c NULL.
* @return The name of the room.
* @since 2.4.0
*/
const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room);
/**
* Get the parent of a room.
* @param room The room, which must not be @c NULL.
* @return The parent of the room, which can be @c NULL.
* @since 2.4.0
*/
PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room);
/**
* Get the list of fields for a room.
*
* @param room The room, which must not be @c NULL.
* @constreturn A list of fields
* @since 2.4.0
*/
GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room);
/*@}*/
/**************************************************************************/
/** @name Room Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a new field.
*
* @param type The type of the field.
* @param label The i18n'ed, user displayable name.
* @param name The internal name of the field.
* @param hidden Hide the field.
*
* @return A new PurpleRoomlistField, ready to be added to a GList and passed to
* purple_roomlist_set_fields().
*/
PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type,
const gchar *label, const gchar *name,
gboolean hidden);
/**
* Get the type of a field.
*
* @param field A PurpleRoomlistField, which must not be @c NULL.
*
* @return The type of the field.
* @since 2.4.0
*/
PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field);
/**
* Get the label of a field.
*
* @param field A PurpleRoomlistField, which must not be @c NULL.
*
* @return The label of the field.
* @since 2.4.0
*/
const char * purple_roomlist_field_get_label(PurpleRoomlistField *field);
/**
* Check whether a roomlist-field is hidden.
* @param field A PurpleRoomlistField, which must not be @c NULL.
*
* @return @c TRUE if the field is hidden, @c FALSE otherwise.
* @since 2.4.0
*/
gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field);
/*@}*/
/**************************************************************************/
/** @name UI Registration Functions */
/**************************************************************************/
/*@{*/
/**
* Sets the UI operations structure to be used in all purple room lists.
*
* @param ops The UI operations structure.
*/
void purple_roomlist_set_ui_ops(PurpleRoomlistUiOps *ops);
/**
* Returns the purple window UI operations structure to be used in
* new windows.
*
* @return A filled-out PurpleRoomlistUiOps structure.
*/
PurpleRoomlistUiOps *purple_roomlist_get_ui_ops(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_ROOMLIST_H_ */
|