pidgin/pidgin
Clone
Summary
Browse
Changes
Graph
Merge the release-2.x.y branch into default.
2014-02-01, Mark Doliner
3c9c77b80a6c
Merge the release-2.x.y branch into default.
A few manual merges... nothing too bad.
/**
* @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_
#define PURPLE_TYPE_ROOMLIST (purple_roomlist_get_type())
#define PURPLE_ROOMLIST(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_ROOMLIST, PurpleRoomlist))
#define PURPLE_ROOMLIST_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_ROOMLIST, PurpleRoomlistClass))
#define PURPLE_IS_ROOMLIST(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_ROOMLIST))
#define PURPLE_IS_ROOMLIST_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_ROOMLIST))
#define PURPLE_ROOMLIST_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_ROOMLIST, PurpleRoomlistClass))
/** @copydoc _PurpleRoomlist */
typedef
struct
_PurpleRoomlist
PurpleRoomlist
;
/** @copydoc _PurpleRoomlistClass */
typedef
struct
_PurpleRoomlistClass
PurpleRoomlistClass
;
#define PURPLE_TYPE_ROOMLIST_ROOM (purple_roomlist_room_get_type())
typedef
struct
_PurpleRoomlistRoom
PurpleRoomlistRoom
;
#define PURPLE_TYPE_ROOMLIST_FIELD (purple_roomlist_field_get_type())
typedef
struct
_PurpleRoomlistField
PurpleRoomlistField
;
/** @copydoc _PurpleRoomlistUiOps */
typedef
struct
_PurpleRoomlistUiOps
PurpleRoomlistUiOps
;
/**
* The types of rooms.
*
* These are ORable flags.
*/
typedef
enum
/*< flags >*/
{
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 */
/**************************************************************************/
/**
* 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. */
/*< private >*/
void
(
*
_purple_reserved1
)(
void
);
void
(
*
_purple_reserved2
)(
void
);
void
(
*
_purple_reserved3
)(
void
);
void
(
*
_purple_reserved4
)(
void
);
};
/**
* Represents a list of rooms for a given connection on a given protocol.
*/
struct
_PurpleRoomlist
{
GObject
gparent
;
/** The UI data associated with this room list. This is a convenience
* field provided to the UIs -- it is not used by the libpurple core.
*/
gpointer
ui_data
;
};
/** Base class for all #PurpleRoomlist's */
struct
_PurpleRoomlistClass
{
GObjectClass
parent_class
;
/*< private >*/
void
(
*
_purple_reserved1
)(
void
);
void
(
*
_purple_reserved2
)(
void
);
void
(
*
_purple_reserved3
)(
void
);
void
(
*
_purple_reserved4
)(
void
);
};
G_BEGIN_DECLS
/**************************************************************************/
/** @name Room List API */
/**************************************************************************/
/*@{*/
/**
* Returns the GType for the Room List object.
*/
GType
purple_roomlist_get_type
(
void
);
/**
* 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.
*
* @param account The account that's listing rooms.
* @return The new room list handle.
*/
PurpleRoomlist
*
purple_roomlist_new
(
PurpleAccount
*
account
);
/**
* Retrieve the PurpleAccount that was given when the room list was
* created.
*
* @return The PurpleAccount tied to this room list.
*/
PurpleAccount
*
purple_roomlist_get_account
(
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
*/
GList
*
purple_roomlist_get_fields
(
PurpleRoomlist
*
roomlist
);
/**
* Get the protocol data associated with this room list.
*
* @param list The roomlist, which must not be @c NULL.
*
* @return The protocol data associated with this room list. This is a
* convenience field provided to the protocol plugin--it is not
* used the libpurple core.
*/
gpointer
purple_roomlist_get_protocol_data
(
PurpleRoomlist
*
list
);
/**
* Set the protocol data associated with this room list.
*
* @param list The roomlist, which must not be @c NULL.
* @param proto_data A pointer to associate with this room list.
*/
void
purple_roomlist_set_protocol_data
(
PurpleRoomlist
*
list
,
gpointer
proto_data
);
/**
* Get the UI data associated with this room list.
*
* @param list The roomlist, which must not be @c NULL.
*
* @return The UI data associated with this room list. This is a
* convenience field provided to the UIs--it is not
* used by the libpurple core.
*/
gpointer
purple_roomlist_get_ui_data
(
PurpleRoomlist
*
list
);
/**
* Set the UI data associated with this room list.
*
* @param list The roomlist, which must not be @c NULL.
* @param ui_data A pointer to associate with this room list.
*/
void
purple_roomlist_set_ui_data
(
PurpleRoomlist
*
list
,
gpointer
ui_data
);
/*@}*/
/**************************************************************************/
/** @name Room API */
/**************************************************************************/
/*@{*/
/**
* Returns the GType for the PurpleRoomlistRoom boxed structure.
*/
GType
purple_roomlist_room_get_type
(
void
);
/**
* 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.
*/
PurpleRoomlistRoomType
purple_roomlist_room_get_room_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.
*/
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.
*/
PurpleRoomlistRoom
*
purple_roomlist_room_get_parent
(
PurpleRoomlistRoom
*
room
);
/**
* Get the value of the expanded_once flag.
*
* @param room The room, which must not be @c NULL.
*
* @return The value of the expanded_once flag.
*/
gboolean
purple_roomlist_room_get_expanded_once
(
PurpleRoomlistRoom
*
room
);
/**
* Set the expanded_once flag.
*
* @param room The room, which must not be @c NULL.
* @param expanded_once The new value of the expanded_once flag.
*/
void
purple_roomlist_room_set_expanded_once
(
PurpleRoomlistRoom
*
room
,
gboolean
expanded_once
);
/**
* Get the list of fields for a room.
*
* @param room The room, which must not be @c NULL.
* @constreturn A list of fields
*/
GList
*
purple_roomlist_room_get_fields
(
PurpleRoomlistRoom
*
room
);
/*@}*/
/**************************************************************************/
/** @name Room Field API */
/**************************************************************************/
/*@{*/
/**
* Returns the GType for the PurpleRoomlistField boxed structure.
*/
GType
purple_roomlist_field_get_type
(
void
);
/**
* 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.
*/
PurpleRoomlistFieldType
purple_roomlist_field_get_field_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.
*/
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.
*/
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
);
/*@}*/
G_END_DECLS
#endif
/* _PURPLE_ROOMLIST_H_ */