pidgin: libpurple/request.h comparison

comparison libpurple/request.h @ 32819:2c6510167895 default tip

propagate from branch 'im.pidgin.pidgin.2.x.y' (head 3315c5dfbd0ad16511bdcf865e5b07c02d07df24) to branch 'im.pidgin.pidgin' (head cbd1eda6bcbf0565ae7766396bb8f6f419cb6a9a)

author	Elliott Sales de Andrade <qulogic@pidgin.im>
date	Sat, 02 Jun 2012 02:30:49 +0000
parents	ca8b2ec198d9
children

comparison

equal deleted inserted replaced

-:01ff09d4a463
+:2c6510167895
 #include <stdlib.h>
 #include <glib-object.h>
 #include <glib.h>
-/** @copydoc _PurpleRequestField */
+/**
+* A request field.
+*/
 typedef struct _PurpleRequestField PurpleRequestField;
+/**
+* Multiple fields request data.
+*/
+typedef struct _PurpleRequestFields PurpleRequestFields;
+/**
+* A group of fields with a title.
+*/
+typedef struct _PurpleRequestFieldGroup PurpleRequestFieldGroup;
 #include "account.h"
 #define PURPLE_DEFAULT_ACTION_NONE	-1
 	PURPLE_REQUEST_FIELD_BOOLEAN,
 	PURPLE_REQUEST_FIELD_CHOICE,
 	PURPLE_REQUEST_FIELD_LIST,
 	PURPLE_REQUEST_FIELD_LABEL,
 	PURPLE_REQUEST_FIELD_IMAGE,
-	PURPLE_REQUEST_FIELD_ACCOUNT
+	PURPLE_REQUEST_FIELD_ACCOUNT,
+	PURPLE_REQUEST_FIELD_CERTIFICATE
 } PurpleRequestFieldType;
-/**
-* Multiple fields request data.
-*/
-typedef struct
-{
-	GList *groups;
-	GHashTable *fields;
-	GList *required_fields;
-	void *ui_data;
-} PurpleRequestFields;
-/**
-* A group of fields with a title.
-*/
-typedef struct
-{
-	PurpleRequestFields *fields_list;
-	char *title;
-	GList *fields;
-} PurpleRequestFieldGroup;
-#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_REQUEST_C_)
-/**
-* A request field.
-*/
-struct _PurpleRequestField
-{
-	PurpleRequestFieldType type;
-	PurpleRequestFieldGroup *group;
-	char *id;
-	char *label;
-	char *type_hint;
-	gboolean visible;
-	gboolean required;
-	union
-	{
-		struct
-		{
-			gboolean multiline;
-			gboolean masked;
-			gboolean editable;
-			char *default_value;
-			char *value;
-		} string;
-		struct
-		{
-			int default_value;
-			int value;
-		} integer;
-		struct
-		{
-			gboolean default_value;
-			gboolean value;
-		} boolean;
-		struct
-		{
-			int default_value;
-			int value;
-			GList *labels;
-		} choice;
-		struct
-		{
-			GList *items;
-			GList *icons;
-			GHashTable *item_data;
-			GList *selected;
-			GHashTable *selected_table;
-			gboolean multiple_selection;
-		} list;
-		struct
-		{
-			PurpleAccount *default_account;
-			PurpleAccount *account;
-			gboolean show_all;
-			PurpleFilterAccountFunc filter_func;
-		} account;
-		struct
-		{
-			unsigned int scale_x;
-			unsigned int scale_y;
-			const char *buffer;
-			gsize size;
-		} image;
-	} u;
-	void *ui_data;
-};
-#endif
 /**
 * Request UI operations.
 */
 typedef struct
 typedef void (*PurpleRequestActionCb)(void *, int);
 typedef void (*PurpleRequestChoiceCb)(void *, int);
 typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields);
 typedef void (*PurpleRequestFileCb)(void *, const char *filename);
-#ifdef __cplusplus
+G_BEGIN_DECLS
-extern "C" {
-#endif
 /**************************************************************************/
 /** @name Field List API                                                  */
 /**************************************************************************/
 /*@{*/
 * @return The account value, if found, or NULL otherwise.
 */
 PurpleAccount *purple_request_fields_get_account(const PurpleRequestFields *fields,
 											 const char *id);
+/**
+* Returns the UI data associated with this object.
+*
+* @param fields The fields list.
+*
+* @return The UI data associated with this object.  This is a
+*         convenience field provided to the UIs--it is not
+*         used by the libuprple core.
+*/
+gpointer purple_request_fields_get_ui_data(const PurpleRequestFields *fields);
+/**
+* Set the UI data associated with this object.
+*
+* @param fields The fields list.
+* @param ui_data A pointer to associate with this object.
+*/
+void purple_request_fields_set_ui_data(PurpleRequestFields *fields, gpointer ui_data);
 /*@}*/
 /**************************************************************************/
 /** @name Fields Group API                                                */
 /**************************************************************************/
 * @param group The group.
 *
 * @constreturn The list of fields in the group.
 */
 GList *purple_request_field_group_get_fields(
+		const PurpleRequestFieldGroup *group);
+/**
+* Returns a list of all fields in a group.
+*
+* @param group The group.
+*
+* @constreturn The list of fields in the group.
+*/
+PurpleRequestFields *purple_request_field_group_get_fields_list(
 		const PurpleRequestFieldGroup *group);
 /*@}*/
 /**************************************************************************/
 */
 void purple_request_field_set_type_hint(PurpleRequestField *field,
 									  const char *type_hint);
 /**
+* Sets the tooltip for the field.
+*
+* This is optionally used by the UIs to provide a tooltip for
+* the field.
+*
+* @param field     The field.
+* @param tooltip   The tooltip text.
+*/
+void purple_request_field_set_tooltip(PurpleRequestField *field,
+									const char *tooltip);
+/**
 * Sets whether or not a field is required.
 *
 * @param field    The field.
 * @param required TRUE if required, or FALSE.
 */
 * Returns the group for the field.
 *
 * @param field The field.
 *
 * @return The UI data.
-*
-* @since 2.6.0
 */
 PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field);
 /**
 * Returns the ID of a field.
 * @return The field's type hint.
 */
 const char *purple_request_field_get_type_hint(const PurpleRequestField *field);
 /**
+* Returns the field's tooltip.
+*
+* @param field The field.
+*
+* @return The field's tooltip.
+*/
+const char *purple_request_field_get_tooltip(const PurpleRequestField *field);
+/**
 * Returns whether or not a field is required.
 *
 * @param field The field.
 *
 * @return TRUE if the field is required, or FALSE.
 * Returns the ui_data for a field.
 *
 * @param field The field.
 *
 * @return The UI data.
-*
-* @since 2.6.0
 */
 gpointer purple_request_field_get_ui_data(const PurpleRequestField *field);
 /**
 * Sets the ui_data for a field.
 *
 * @param field The field.
 * @param ui_data The UI data.
 *
 * @return The UI data.
-*
-* @since 2.6.0
 */
 void purple_request_field_set_ui_data(PurpleRequestField *field,
 gpointer ui_data);
 /*@}*/
 /**
 * Adds an item to a list field.
 *
 * @param field The list field.
 * @param item  The list item.
-* @param data  The associated data.
-*
-* @deprecated Use purple_request_field_list_add_icon() instead.
-*/
-void purple_request_field_list_add(PurpleRequestField *field,
-								 const char *item, void *data);
-/**
-* Adds an item to a list field.
-*
-* @param field The list field.
-* @param item  The list item.
 * @param icon_path The path to icon file, or @c NULL for no icon.
 * @param data  The associated data.
 */
 void purple_request_field_list_add_icon(PurpleRequestField *field,
 								 const char *item, const char* icon_path, void* data);
 * @param field       The account field.
 *
 * @return The account filter function.
 */
 PurpleFilterAccountFunc purple_request_field_account_get_filter(
+		const PurpleRequestField *field);
+/*@}*/
+/**************************************************************************/
+/** @name Certificate Field API                                           */
+/**************************************************************************/
+/*@{*/
+/**
+* Creates a certificate field.
+*
+* @param id   The field ID.
+* @param text The label of the field.
+* @param cert The certificate of the field.
+*
+* @return The new field.
+*/
+PurpleRequestField *purple_request_field_certificate_new(const char *id,
+														 const char *text,
+														 PurpleCertificate *cert);
+/**
+* Returns the certificate in a certificate field.
+*
+* @param field The field.
+*
+* @return The certificate.
+*/
+PurpleCertificate *purple_request_field_certificate_get_value(
 		const PurpleRequestField *field);
 /*@}*/
 /**************************************************************************/
 	PurpleAccount *account, const char *who, PurpleConversation *conv,
 	void *user_data, size_t action_count, va_list actions);
 /**
 * Version of purple_request_action() supplying an image for the UI to
-* optionally display as an icon in the dialog; see its documentation
+* optionally display as an icon in the dialog; see its documentation.
-* @since 2.7.0
 */
 void *purple_request_action_with_icon(void *handle, const char *title,
 	const char *primary, const char *secondary, int default_action,
 	PurpleAccount *account, const char *who, PurpleConversation *conv,
 	gconstpointer icon_data, gsize icon_size, void *user_data,
 	size_t action_count, ...);
 /**
 * <tt>va_list</tt> version of purple_request_action_with_icon();
 * see its documentation.
-* @since 2.7.0
 */
 void *purple_request_action_with_icon_varg(void *handle, const char *title,
 	const char *primary, const char *secondary, int default_action,
 	PurpleAccount *account, const char *who, PurpleConversation *conv,
 	gconstpointer icon_data, gsize icon_size,
 void *purple_request_folder(void *handle, const char *title, const char *dirname,
 	GCallback ok_cb, GCallback cancel_cb,
 	PurpleAccount *account, const char *who, PurpleConversation *conv,
 	void *user_data);
+/**
+* Prompts the user for action over a certificate.
+*
+* This is often represented as a dialog with a button for each action.
+*
+* @param handle        The plugin or connection handle.  For some things this
+*                      is <em>extremely</em> important.  See the comments on
+*                      purple_request_input().
+* @param title         The title of the message, or @c NULL if it should have
+*                      no title.
+* @param primary       The main point of the message, or @c NULL if you're
+*                      feeling enigmatic.
+* @param secondary     Secondary information, or @c NULL if there is none.
+* @param cert          The #PurpleCertificate associated with this request.
+* @param ok_text       The text for the @c OK button, which may not be @c NULL.
+* @param ok_cb         The callback for the @c OK button, which may not be
+*                      @c NULL.
+* @param cancel_text   The text for the @c Cancel button, which may not be
+*                      @c NULL.
+* @param cancel_cb     The callback for the @c Cancel button, which may be
+*                      @c NULL.
+* @param user_data     The data to pass to the callback.
+*
+* @return A UI-specific handle.
+*/
+void *purple_request_certificate(void *handle, const char *title,
+	const char *primary, const char *secondary, PurpleCertificate *cert,
+	const char *ok_text, GCallback ok_cb,
+	const char *cancel_text, GCallback cancel_cb,
+	void *user_data);
 /*@}*/
 /**************************************************************************/
 /** @name UI Registration Functions                                       */
 /**************************************************************************/
 */
 PurpleRequestUiOps *purple_request_get_ui_ops(void);
 /*@}*/
-#ifdef __cplusplus
+G_END_DECLS
-}
-#endif
 #endif /* _PURPLE_REQUEST_H_ */

Mercurial > pidgin

comparison libpurple/request.h @ 32819:2c6510167895 default tip