#include "account.h"
#include "glib.h"
Include dependency graph for roomlist.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
struct | _PurpleRoomlist |
Represents a list of rooms for a given connection on a given protocol. More... | |
struct | _PurpleRoomlistRoom |
Represents a room. More... | |
struct | _PurpleRoomlistField |
A field a room might have. More... | |
struct | _PurpleRoomlistUiOps |
The room list ops to be filled out by the UI. More... | |
Room List API | |
void | purple_roomlist_show_with_account (PurpleAccount *account) |
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. | |
PurpleRoomlist * | purple_roomlist_new (PurpleAccount *account) |
Returns a newly created room list object. | |
void | purple_roomlist_ref (PurpleRoomlist *list) |
Increases the reference count on the room list. | |
void | purple_roomlist_unref (PurpleRoomlist *list) |
Decreases the reference count on the room list. | |
void | purple_roomlist_set_fields (PurpleRoomlist *list, GList *fields) |
Set the different field types and their names for this protocol. | |
void | purple_roomlist_set_in_progress (PurpleRoomlist *list, gboolean in_progress) |
Set the "in progress" state of the room list. | |
gboolean | purple_roomlist_get_in_progress (PurpleRoomlist *list) |
Gets the "in progress" state of the room list. | |
void | purple_roomlist_room_add (PurpleRoomlist *list, PurpleRoomlistRoom *room) |
Adds a room to the list of them. | |
PurpleRoomlist * | purple_roomlist_get_list (PurpleConnection *gc) |
Returns a PurpleRoomlist structure from the prpl, and instructs the prpl to start fetching the list. | |
void | purple_roomlist_cancel_get_list (PurpleRoomlist *list) |
Tells the prpl to stop fetching the list. | |
void | purple_roomlist_expand_category (PurpleRoomlist *list, PurpleRoomlistRoom *category) |
Tells the prpl that a category was expanded. | |
GList * | purple_roomlist_get_fields (PurpleRoomlist *roomlist) |
Get the list of fields for a roomlist. | |
Room API | |
PurpleRoomlistRoom * | purple_roomlist_room_new (PurpleRoomlistRoomType type, const gchar *name, PurpleRoomlistRoom *parent) |
Creates a new room, to be added to the list. | |
void | purple_roomlist_room_add_field (PurpleRoomlist *list, PurpleRoomlistRoom *room, gconstpointer field) |
Adds a field to a room. | |
void | purple_roomlist_room_join (PurpleRoomlist *list, PurpleRoomlistRoom *room) |
Join a room, given a PurpleRoomlistRoom and it's associated PurpleRoomlist. | |
PurpleRoomlistRoomType | purple_roomlist_room_get_type (PurpleRoomlistRoom *room) |
Get the type of a room. | |
const char * | purple_roomlist_room_get_name (PurpleRoomlistRoom *room) |
Get the name of a room. | |
PurpleRoomlistRoom * | purple_roomlist_room_get_parent (PurpleRoomlistRoom *room) |
Get the parent of a room. | |
GList * | purple_roomlist_room_get_fields (PurpleRoomlistRoom *room) |
Get the list of fields for a room. | |
Room Field API | |
PurpleRoomlistField * | purple_roomlist_field_new (PurpleRoomlistFieldType type, const gchar *label, const gchar *name, gboolean hidden) |
Creates a new field. | |
PurpleRoomlistFieldType | purple_roomlist_field_get_type (PurpleRoomlistField *field) |
Get the type of a field. | |
const char * | purple_roomlist_field_get_label (PurpleRoomlistField *field) |
Get the label of a field. | |
gboolean | purple_roomlist_field_get_hidden (PurpleRoomlistField *field) |
Check whether a roomlist-field is hidden. | |
UI Registration Functions | |
void | purple_roomlist_set_ui_ops (PurpleRoomlistUiOps *ops) |
Sets the UI operations structure to be used in all purple room lists. | |
PurpleRoomlistUiOps * | purple_roomlist_get_ui_ops (void) |
Returns the purple window UI operations structure to be used in new windows. | |
Typedefs | |
typedef _PurpleRoomlist | PurpleRoomlist |
typedef _PurpleRoomlistRoom | PurpleRoomlistRoom |
typedef _PurpleRoomlistField | PurpleRoomlistField |
typedef _PurpleRoomlistUiOps | PurpleRoomlistUiOps |
Enumerations | |
enum | PurpleRoomlistRoomType { PURPLE_ROOMLIST_ROOMTYPE_CATEGORY = 0x01, PURPLE_ROOMLIST_ROOMTYPE_ROOM = 0x02 } |
The types of rooms. More... | |
enum | PurpleRoomlistFieldType { PURPLE_ROOMLIST_FIELD_BOOL, PURPLE_ROOMLIST_FIELD_INT, PURPLE_ROOMLIST_FIELD_STRING } |
The types of fields. More... |
Definition in file roomlist.h.
|
The types of fields.
Definition at line 50 of file roomlist.h. |
|
The types of rooms. These are ORable flags.
Definition at line 40 of file roomlist.h. |
|
Tells the prpl to stop fetching the list.
If this is possible and done, the prpl will call set_in_progress with
|
|
Tells the prpl that a category was expanded. On some protocols, the rooms in the category won't be fetched until this is called.
|
|
Check whether a roomlist-field is hidden.
|
|
Get the label of a field.
|
|
Get the type of a field.
|
|
Creates a new field.
|
|
Get the list of fields for a roomlist.
|
|
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.
|
|
Returns a PurpleRoomlist structure from the prpl, and instructs the prpl to start fetching the list.
|
|
Returns the purple window UI operations structure to be used in new windows.
|
|
Returns a newly created room list object. It has an initial reference count of 1.
|
|
Increases the reference count on the room list.
|
|
Adds a room to the list of them.
|
|
Adds a field to a room.
|
|
Get the list of fields for a room.
|
|
Get the name of a room.
|
|
Get the parent of a room.
|
|
Get the type of a room.
|
|
Join a room, given a PurpleRoomlistRoom and it's associated PurpleRoomlist.
|
|
Creates a new room, to be added to the list.
|
|
Set the different field types and their names for this protocol. This must be called before purple_roomlist_room_add().
|
|
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.
|
|
Sets the UI operations structure to be used in all purple room lists.
|
|
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.
|
|
Decreases the reference count on the room list. The room list will be destroyed when this reaches 0.
|