pidgin/pidgin

Increase timeout for initial XDP portal session to 2s
release-2.x.y
2020-04-05, David Woodhouse
87d96850a2d7
Increase timeout for initial XDP portal session to 2s

It should still fail immediately when the portal isn't available, but
in my test VM with systemd automatically activating the portal when it's
first accessed, it can take 800ms or so. Wait for it instead of falling
back after 200ms.
/**
* @file request.h Request 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_REQUEST_H_
#define _PURPLE_REQUEST_H_
#include <stdlib.h>
#include <glib-object.h>
#include <glib.h>
/** @copydoc _PurpleRequestField */
typedef struct _PurpleRequestField PurpleRequestField;
#include "account.h"
#define PURPLE_DEFAULT_ACTION_NONE -1
/**
* Request types.
*/
typedef enum
{
PURPLE_REQUEST_INPUT = 0, /**< Text input request. */
PURPLE_REQUEST_CHOICE, /**< Multiple-choice request. */
PURPLE_REQUEST_ACTION, /**< Action request. */
PURPLE_REQUEST_FIELDS, /**< Multiple fields request. */
PURPLE_REQUEST_FILE, /**< File open or save request. */
PURPLE_REQUEST_FOLDER, /**< Folder selection request. */
PURPLE_REQUEST_SCREENSHARE /**< Screenshare media request. */
} PurpleRequestType;
/**
* A type of field.
*/
typedef enum
{
PURPLE_REQUEST_FIELD_NONE,
PURPLE_REQUEST_FIELD_STRING,
PURPLE_REQUEST_FIELD_INTEGER,
PURPLE_REQUEST_FIELD_BOOLEAN,
PURPLE_REQUEST_FIELD_CHOICE,
PURPLE_REQUEST_FIELD_LIST,
PURPLE_REQUEST_FIELD_LABEL,
PURPLE_REQUEST_FIELD_IMAGE,
PURPLE_REQUEST_FIELD_ACCOUNT
} 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
{
/** @see purple_request_input(). */
void *(*request_input)(const char *title, const char *primary,
const char *secondary, const char *default_value,
gboolean multiline, gboolean masked, gchar *hint,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data);
/** @see purple_request_choice_varg(). */
void *(*request_choice)(const char *title, const char *primary,
const char *secondary, int default_value,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data,
va_list choices);
/** @see purple_request_action_varg(). */
void *(*request_action)(const char *title, const char *primary,
const char *secondary, int default_action,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data,
size_t action_count, va_list actions);
/** @see purple_request_fields(). */
void *(*request_fields)(const char *title, const char *primary,
const char *secondary, PurpleRequestFields *fields,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data);
/** @see purple_request_file(). */
void *(*request_file)(const char *title, const char *filename,
gboolean savedialog, GCallback ok_cb,
GCallback cancel_cb, PurpleAccount *account,
const char *who, PurpleConversation *conv,
void *user_data);
void (*close_request)(PurpleRequestType type, void *ui_handle);
/** @see purple_request_folder(). */
void *(*request_folder)(const char *title, const char *dirname,
GCallback ok_cb, GCallback cancel_cb,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data);
/** @see purple_request_action_with_icon_varg(). */
void *(*request_action_with_icon)(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, va_list actions);
void *(*request_screenshare_media)(const char *title, const char *primary,
const char *secondary, PurpleAccount *account,
GCallback cb, void *user_data);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
} PurpleRequestUiOps;
typedef void (*PurpleRequestInputCb)(void *, const char *);
/** The type of callbacks passed to purple_request_action(). The first
* argument is the @a user_data parameter; the second is the index in the list
* of actions of the one chosen.
*/
typedef void (*PurpleRequestActionCb)(void *, int);
typedef void (*PurpleRequestChoiceCb)(void *, int);
typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields);
typedef void (*PurpleRequestFileCb)(void *, const char *filename);
typedef void (*PurpleRequestScreenshareCb)(void *, GObject *info);
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Field List API */
/**************************************************************************/
/*@{*/
/**
* Creates a list of fields to pass to purple_request_fields().
*
* @return A PurpleRequestFields structure.
*/
PurpleRequestFields *purple_request_fields_new(void);
/**
* Destroys a list of fields.
*
* @param fields The list of fields to destroy.
*/
void purple_request_fields_destroy(PurpleRequestFields *fields);
/**
* Adds a group of fields to the list.
*
* @param fields The fields list.
* @param group The group to add.
*/
void purple_request_fields_add_group(PurpleRequestFields *fields,
PurpleRequestFieldGroup *group);
/**
* Returns a list of all groups in a field list.
*
* @param fields The fields list.
*
* @constreturn A list of groups.
*/
GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
/**
* Returns whether or not the field with the specified ID exists.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return TRUE if the field exists, or FALSE.
*/
gboolean purple_request_fields_exists(const PurpleRequestFields *fields,
const char *id);
/**
* Returns a list of all required fields.
*
* @param fields The fields list.
*
* @constreturn The list of required fields.
*/
GList *purple_request_fields_get_required(const PurpleRequestFields *fields);
/**
* Returns whether or not a field with the specified ID is required.
*
* @param fields The fields list.
* @param id The field ID.
*
* @return TRUE if the specified field is required, or FALSE.
*/
gboolean purple_request_fields_is_field_required(const PurpleRequestFields *fields,
const char *id);
/**
* Returns whether or not all required fields have values.
*
* @param fields The fields list.
*
* @return TRUE if all required fields have values, or FALSE.
*/
gboolean purple_request_fields_all_required_filled(
const PurpleRequestFields *fields);
/**
* Return the field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The field, if found.
*/
PurpleRequestField *purple_request_fields_get_field(
const PurpleRequestFields *fields, const char *id);
/**
* Returns the string value of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The string value, if found, or @c NULL otherwise.
*/
const char *purple_request_fields_get_string(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the integer value of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The integer value, if found, or 0 otherwise.
*/
int purple_request_fields_get_integer(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the boolean value of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The boolean value, if found, or @c FALSE otherwise.
*/
gboolean purple_request_fields_get_bool(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the choice index of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The choice index, if found, or -1 otherwise.
*/
int purple_request_fields_get_choice(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the account of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The account value, if found, or NULL otherwise.
*/
PurpleAccount *purple_request_fields_get_account(const PurpleRequestFields *fields,
const char *id);
/*@}*/
/**************************************************************************/
/** @name Fields Group API */
/**************************************************************************/
/*@{*/
/**
* Creates a fields group with an optional title.
*
* @param title The optional title to give the group.
*
* @return A new fields group
*/
PurpleRequestFieldGroup *purple_request_field_group_new(const char *title);
/**
* Destroys a fields group.
*
* @param group The group to destroy.
*/
void purple_request_field_group_destroy(PurpleRequestFieldGroup *group);
/**
* Adds a field to the group.
*
* @param group The group to add the field to.
* @param field The field to add to the group.
*/
void purple_request_field_group_add_field(PurpleRequestFieldGroup *group,
PurpleRequestField *field);
/**
* Returns the title of a fields group.
*
* @param group The group.
*
* @return The title, if set.
*/
const char *purple_request_field_group_get_title(
const PurpleRequestFieldGroup *group);
/**
* Returns a list of all fields in a group.
*
* @param group The group.
*
* @constreturn The list of fields in the group.
*/
GList *purple_request_field_group_get_fields(
const PurpleRequestFieldGroup *group);
/*@}*/
/**************************************************************************/
/** @name Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a field of the specified type.
*
* @param id The field ID.
* @param text The text label of the field.
* @param type The type of field.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_new(const char *id, const char *text,
PurpleRequestFieldType type);
/**
* Destroys a field.
*
* @param field The field to destroy.
*/
void purple_request_field_destroy(PurpleRequestField *field);
/**
* Sets the label text of a field.
*
* @param field The field.
* @param label The text label.
*/
void purple_request_field_set_label(PurpleRequestField *field, const char *label);
/**
* Sets whether or not a field is visible.
*
* @param field The field.
* @param visible TRUE if visible, or FALSE if not.
*/
void purple_request_field_set_visible(PurpleRequestField *field, gboolean visible);
/**
* Sets the type hint for the field.
*
* This is optionally used by the UIs to provide such features as
* auto-completion for type hints like "account" and "screenname".
*
* @param field The field.
* @param type_hint The type hint.
*/
void purple_request_field_set_type_hint(PurpleRequestField *field,
const char *type_hint);
/**
* Sets whether or not a field is required.
*
* @param field The field.
* @param required TRUE if required, or FALSE.
*/
void purple_request_field_set_required(PurpleRequestField *field,
gboolean required);
/**
* Returns the type of a field.
*
* @param field The field.
*
* @return The field's type.
*/
PurpleRequestFieldType purple_request_field_get_type(const PurpleRequestField *field);
/**
* 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.
*
* @param field The field.
*
* @return The ID
*/
const char *purple_request_field_get_id(const PurpleRequestField *field);
/**
* Returns the label text of a field.
*
* @param field The field.
*
* @return The label text.
*/
const char *purple_request_field_get_label(const PurpleRequestField *field);
/**
* Returns whether or not a field is visible.
*
* @param field The field.
*
* @return TRUE if the field is visible. FALSE otherwise.
*/
gboolean purple_request_field_is_visible(const PurpleRequestField *field);
/**
* Returns the field's type hint.
*
* @param field The field.
*
* @return The field's type hint.
*/
const char *purple_request_field_get_type_hint(const PurpleRequestField *field);
/**
* Returns whether or not a field is required.
*
* @param field The field.
*
* @return TRUE if the field is required, or FALSE.
*/
gboolean purple_request_field_is_required(const PurpleRequestField *field);
/**
* 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);
/*@}*/
/**************************************************************************/
/** @name String Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a string request field.
*
* @param id The field ID.
* @param text The text label of the field.
* @param default_value The optional default value.
* @param multiline Whether or not this should be a multiline string.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_string_new(const char *id,
const char *text,
const char *default_value,
gboolean multiline);
/**
* Sets the default value in a string field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_string_set_default_value(PurpleRequestField *field,
const char *default_value);
/**
* Sets the value in a string field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_string_set_value(PurpleRequestField *field,
const char *value);
/**
* Sets whether or not a string field is masked
* (commonly used for password fields).
*
* @param field The field.
* @param masked The masked value.
*/
void purple_request_field_string_set_masked(PurpleRequestField *field,
gboolean masked);
/**
* Sets whether or not a string field is editable.
*
* @param field The field.
* @param editable The editable value.
*/
void purple_request_field_string_set_editable(PurpleRequestField *field,
gboolean editable);
/**
* Returns the default value in a string field.
*
* @param field The field.
*
* @return The default value.
*/
const char *purple_request_field_string_get_default_value(
const PurpleRequestField *field);
/**
* Returns the user-entered value in a string field.
*
* @param field The field.
*
* @return The value.
*/
const char *purple_request_field_string_get_value(const PurpleRequestField *field);
/**
* Returns whether or not a string field is multi-line.
*
* @param field The field.
*
* @return @c TRUE if the field is mulit-line, or @c FALSE otherwise.
*/
gboolean purple_request_field_string_is_multiline(const PurpleRequestField *field);
/**
* Returns whether or not a string field is masked.
*
* @param field The field.
*
* @return @c TRUE if the field is masked, or @c FALSE otherwise.
*/
gboolean purple_request_field_string_is_masked(const PurpleRequestField *field);
/**
* Returns whether or not a string field is editable.
*
* @param field The field.
*
* @return @c TRUE if the field is editable, or @c FALSE otherwise.
*/
gboolean purple_request_field_string_is_editable(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Integer Field API */
/**************************************************************************/
/*@{*/
/**
* Creates an integer field.
*
* @param id The field ID.
* @param text The text label of the field.
* @param default_value The default value.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_int_new(const char *id,
const char *text,
int default_value);
/**
* Sets the default value in an integer field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_int_set_default_value(PurpleRequestField *field,
int default_value);
/**
* Sets the value in an integer field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_int_set_value(PurpleRequestField *field, int value);
/**
* Returns the default value in an integer field.
*
* @param field The field.
*
* @return The default value.
*/
int purple_request_field_int_get_default_value(const PurpleRequestField *field);
/**
* Returns the user-entered value in an integer field.
*
* @param field The field.
*
* @return The value.
*/
int purple_request_field_int_get_value(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Boolean Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a boolean field.
*
* This is often represented as a checkbox.
*
* @param id The field ID.
* @param text The text label of the field.
* @param default_value The default value.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_bool_new(const char *id,
const char *text,
gboolean default_value);
/**
* Sets the default value in an boolean field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_bool_set_default_value(PurpleRequestField *field,
gboolean default_value);
/**
* Sets the value in an boolean field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_bool_set_value(PurpleRequestField *field,
gboolean value);
/**
* Returns the default value in an boolean field.
*
* @param field The field.
*
* @return The default value.
*/
gboolean purple_request_field_bool_get_default_value(
const PurpleRequestField *field);
/**
* Returns the user-entered value in an boolean field.
*
* @param field The field.
*
* @return The value.
*/
gboolean purple_request_field_bool_get_value(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Choice Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a multiple choice field.
*
* This is often represented as a group of radio buttons.
*
* @param id The field ID.
* @param text The optional label of the field.
* @param default_value The default choice.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_choice_new(const char *id,
const char *text,
int default_value);
/**
* Adds a choice to a multiple choice field.
*
* @param field The choice field.
* @param label The choice label.
*/
void purple_request_field_choice_add(PurpleRequestField *field,
const char *label);
/**
* Sets the default value in an choice field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_choice_set_default_value(PurpleRequestField *field,
int default_value);
/**
* Sets the value in an choice field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_choice_set_value(PurpleRequestField *field, int value);
/**
* Returns the default value in an choice field.
*
* @param field The field.
*
* @return The default value.
*/
int purple_request_field_choice_get_default_value(const PurpleRequestField *field);
/**
* Returns the user-entered value in an choice field.
*
* @param field The field.
*
* @return The value.
*/
int purple_request_field_choice_get_value(const PurpleRequestField *field);
/**
* Returns a list of labels in a choice field.
*
* @param field The field.
*
* @constreturn The list of labels.
*/
GList *purple_request_field_choice_get_labels(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name List Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a multiple list item field.
*
* @param id The field ID.
* @param text The optional label of the field.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_list_new(const char *id, const char *text);
/**
* Sets whether or not a list field allows multiple selection.
*
* @param field The list field.
* @param multi_select TRUE if multiple selection is enabled,
* or FALSE otherwise.
*/
void purple_request_field_list_set_multi_select(PurpleRequestField *field,
gboolean multi_select);
/**
* Returns whether or not a list field allows multiple selection.
*
* @param field The list field.
*
* @return TRUE if multiple selection is enabled, or FALSE otherwise.
*/
gboolean purple_request_field_list_get_multi_select(
const PurpleRequestField *field);
/**
* Returns the data for a particular item.
*
* @param field The list field.
* @param text The item text.
*
* @return The data associated with the item.
*/
void *purple_request_field_list_get_data(const PurpleRequestField *field,
const char *text);
/**
* 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);
/**
* Adds a selected item to the list field.
*
* @param field The field.
* @param item The item to add.
*/
void purple_request_field_list_add_selected(PurpleRequestField *field,
const char *item);
/**
* Clears the list of selected items in a list field.
*
* @param field The field.
*/
void purple_request_field_list_clear_selected(PurpleRequestField *field);
/**
* Sets a list of selected items in a list field.
*
* @param field The field.
* @param items The list of selected items, which is not modified or freed.
*/
void purple_request_field_list_set_selected(PurpleRequestField *field,
GList *items);
/**
* Returns whether or not a particular item is selected in a list field.
*
* @param field The field.
* @param item The item.
*
* @return TRUE if the item is selected. FALSE otherwise.
*/
gboolean purple_request_field_list_is_selected(const PurpleRequestField *field,
const char *item);
/**
* Returns a list of selected items in a list field.
*
* To retrieve the data for each item, use
* purple_request_field_list_get_data().
*
* @param field The field.
*
* @constreturn The list of selected items.
*/
GList *purple_request_field_list_get_selected(
const PurpleRequestField *field);
/**
* Returns a list of items in a list field.
*
* @param field The field.
*
* @constreturn The list of items.
*/
GList *purple_request_field_list_get_items(const PurpleRequestField *field);
/**
* Returns a list of icons in a list field.
*
* The icons will correspond with the items, in order.
*
* @param field The field.
*
* @constreturn The list of icons or @c NULL (i.e. the empty GList) if no
* items have icons.
*/
GList *purple_request_field_list_get_icons(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Label Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a label field.
*
* @param id The field ID.
* @param text The label of the field.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_label_new(const char *id,
const char *text);
/*@}*/
/**************************************************************************/
/** @name Image Field API */
/**************************************************************************/
/*@{*/
/**
* Creates an image field.
*
* @param id The field ID.
* @param text The label of the field.
* @param buf The image data.
* @param size The size of the data in @a buffer.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_image_new(const char *id, const char *text,
const char *buf, gsize size);
/**
* Sets the scale factors of an image field.
*
* @param field The image field.
* @param x The x scale factor.
* @param y The y scale factor.
*/
void purple_request_field_image_set_scale(PurpleRequestField *field, unsigned int x, unsigned int y);
/**
* Returns pointer to the image.
*
* @param field The image field.
*
* @return Pointer to the image.
*/
const char *purple_request_field_image_get_buffer(PurpleRequestField *field);
/**
* Returns size (in bytes) of the image.
*
* @param field The image field.
*
* @return Size of the image.
*/
gsize purple_request_field_image_get_size(PurpleRequestField *field);
/**
* Returns X scale coefficient of the image.
*
* @param field The image field.
*
* @return X scale coefficient of the image.
*/
unsigned int purple_request_field_image_get_scale_x(PurpleRequestField *field);
/**
* Returns Y scale coefficient of the image.
*
* @param field The image field.
*
* @return Y scale coefficient of the image.
*/
unsigned int purple_request_field_image_get_scale_y(PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Account Field API */
/**************************************************************************/
/*@{*/
/**
* Creates an account field.
*
* By default, this field will not show offline accounts.
*
* @param id The field ID.
* @param text The text label of the field.
* @param account The optional default account.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_account_new(const char *id,
const char *text,
PurpleAccount *account);
/**
* Sets the default account on an account field.
*
* @param field The account field.
* @param default_value The default account.
*/
void purple_request_field_account_set_default_value(PurpleRequestField *field,
PurpleAccount *default_value);
/**
* Sets the account in an account field.
*
* @param field The account field.
* @param value The account.
*/
void purple_request_field_account_set_value(PurpleRequestField *field,
PurpleAccount *value);
/**
* Sets whether or not to show all accounts in an account field.
*
* If TRUE, all accounts, online or offline, will be shown. If FALSE,
* only online accounts will be shown.
*
* @param field The account field.
* @param show_all Whether or not to show all accounts.
*/
void purple_request_field_account_set_show_all(PurpleRequestField *field,
gboolean show_all);
/**
* Sets the account filter function in an account field.
*
* This function will determine which accounts get displayed and which
* don't.
*
* @param field The account field.
* @param filter_func The account filter function.
*/
void purple_request_field_account_set_filter(PurpleRequestField *field,
PurpleFilterAccountFunc filter_func);
/**
* Returns the default account in an account field.
*
* @param field The field.
*
* @return The default account.
*/
PurpleAccount *purple_request_field_account_get_default_value(
const PurpleRequestField *field);
/**
* Returns the user-entered account in an account field.
*
* @param field The field.
*
* @return The user-entered account.
*/
PurpleAccount *purple_request_field_account_get_value(
const PurpleRequestField *field);
/**
* Returns whether or not to show all accounts in an account field.
*
* If TRUE, all accounts, online or offline, will be shown. If FALSE,
* only online accounts will be shown.
*
* @param field The account field.
* @return Whether or not to show all accounts.
*/
gboolean purple_request_field_account_get_show_all(
const PurpleRequestField *field);
/**
* Returns the account filter function in an account field.
*
* This function will determine which accounts get displayed and which
* don't.
*
* @param field The account field.
*
* @return The account filter function.
*/
PurpleFilterAccountFunc purple_request_field_account_get_filter(
const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Request API */
/**************************************************************************/
/*@{*/
/**
* Prompts the user for text input.
*
* @param handle The plugin or connection handle. For some
* things this is <em>extremely</em> important. The
* handle is used to programmatically close the request
* dialog when it is no longer needed. For PRPLs this
* is often a pointer to the #PurpleConnection
* instance. For plugins this should be a similar,
* unique memory location. This value is important
* because it allows a request to be closed with
* purple_request_close_with_handle() when, for
* example, you sign offline. If the request is
* <em>not</em> closed it is <strong>very</strong>
* likely to cause a crash whenever the callback
* handler functions are triggered.
* @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 default_value The default value.
* @param multiline @c TRUE if the inputted text can span multiple lines.
* @param masked @c TRUE if the inputted text should be masked in some
* way (such as by displaying characters as stars). This
* might be because the input is some kind of password.
* @param hint Optionally suggest how the input box should appear.
* Use "html", for example, to allow the user to enter
* HTML.
* @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 account The #PurpleAccount associated with this request, or @c
* NULL if none is.
* @param who The username of the buddy associated with this request,
* or @c NULL if none is.
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is.
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
void *purple_request_input(void *handle, const char *title, const char *primary,
const char *secondary, const char *default_value, gboolean multiline,
gboolean masked, gchar *hint,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who, PurpleConversation *conv,
void *user_data);
/**
* Prompts the user for multiple-choice input.
*
* @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 default_value The default choice; this should be one of the values
* listed in the varargs.
* @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, or @c NULL to
* do nothing.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is.
* @param who The username of the buddy associated with this request,
* or @c NULL if none is.
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is.
* @param user_data The data to pass to the callback.
* @param ... The choices, which should be pairs of <tt>char *</tt>
* descriptions and <tt>int</tt> values, terminated with a
* @c NULL parameter.
*
* @return A UI-specific handle.
*/
void *purple_request_choice(void *handle, const char *title, const char *primary,
const char *secondary, int default_value,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who, PurpleConversation *conv,
void *user_data, ...) G_GNUC_NULL_TERMINATED;
/**
* <tt>va_list</tt> version of purple_request_choice(); see its documentation.
*/
void *purple_request_choice_varg(void *handle, const char *title,
const char *primary, const char *secondary, int default_value,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who, PurpleConversation *conv,
void *user_data, va_list choices);
/**
* Prompts the user for an action.
*
* 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 default_action The default action, zero-indexed; if the third action
* supplied should be the default, supply <tt>2</tt>.
* The should be the action that users are most likely
* to select.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is.
* @param who The username of the buddy associated with this request,
* or @c NULL if none is.
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is.
* @param user_data The data to pass to the callback.
* @param action_count The number of actions.
* @param ... A list of actions. These are pairs of
* arguments. The first of each pair is the
* <tt>char *</tt> label that appears on the button. It
* should have an underscore before the letter you want
* to use as the accelerator key for the button. The
* second of each pair is the #PurpleRequestActionCb
* function to use when the button is clicked.
*
* @return A UI-specific handle.
*/
void *purple_request_action(void *handle, const char *title, const char *primary,
const char *secondary, int default_action, PurpleAccount *account,
const char *who, PurpleConversation *conv, void *user_data,
size_t action_count, ...);
/**
* <tt>va_list</tt> version of purple_request_action(); see its documentation.
*/
void *purple_request_action_varg(void *handle, const char *title,
const char *primary, const char *secondary, int default_action,
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
* @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 *user_data, size_t action_count, va_list actions);
/**
* Displays groups of fields for the user to fill in.
*
* @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 fields The list of fields.
* @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 account The #PurpleAccount associated with this request, or @c
* NULL if none is
* @param who The username of the buddy associated with this request,
* or @c NULL if none is
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
void *purple_request_fields(void *handle, const char *title, const char *primary,
const char *secondary, PurpleRequestFields *fields,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleAccount *account, const char *who, PurpleConversation *conv,
void *user_data);
/**
* Closes a request.
*
* @param type The request type.
* @param uihandle The request UI handle.
*/
void purple_request_close(PurpleRequestType type, void *uihandle);
/**
* Closes all requests registered with the specified handle.
*
* @param handle The handle, as supplied as the @a handle parameter to one of the
* <tt>purple_request_*</tt> functions.
*
* @see purple_request_input().
*/
void purple_request_close_with_handle(void *handle);
/**
* A wrapper for purple_request_action() that uses @c Yes and @c No buttons.
*/
#define purple_request_yes_no(handle, title, primary, secondary, \
default_action, account, who, conv, \
user_data, yes_cb, no_cb) \
purple_request_action((handle), (title), (primary), (secondary), \
(default_action), account, who, conv, (user_data), 2, \
_("_Yes"), (yes_cb), _("_No"), (no_cb))
/**
* A wrapper for purple_request_action() that uses @c OK and @c Cancel buttons.
*/
#define purple_request_ok_cancel(handle, title, primary, secondary, \
default_action, account, who, conv, \
user_data, ok_cb, cancel_cb) \
purple_request_action((handle), (title), (primary), (secondary), \
(default_action), account, who, conv, (user_data), 2, \
_("_OK"), (ok_cb), _("_Cancel"), (cancel_cb))
/**
* A wrapper for purple_request_action() that uses Accept and Cancel buttons.
*/
#define purple_request_accept_cancel(handle, title, primary, secondary, \
default_action, account, who, conv, \
user_data, accept_cb, cancel_cb) \
purple_request_action((handle), (title), (primary), (secondary), \
(default_action), account, who, conv, (user_data), 2, \
_("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
/**
* A wrapper for purple_request_action_with_icon() that uses Accept and Cancel
* buttons.
*/
#define purple_request_accept_cancel_with_icon(handle, title, primary, secondary, \
default_action, account, who, conv, \
icon_data, icon_size, \
user_data, accept_cb, cancel_cb) \
purple_request_action_with_icon((handle), (title), (primary), (secondary), \
(default_action), account, who, conv, icon_data, icon_size, \
(user_data), 2, \
_("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
/**
* Displays a file selector request dialog. Returns the selected filename to
* the callback. Can be used for either opening a file or saving a file.
*
* @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 filename The default filename (may be @c NULL)
* @param savedialog True if this dialog is being used to save a file.
* False if it is being used to open a file.
* @param ok_cb The callback for the @c OK button.
* @param cancel_cb The callback for the @c Cancel button, which may be @c NULL.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is
* @param who The username of the buddy associated with this request,
* or @c NULL if none is
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
void *purple_request_file(void *handle, const char *title, const char *filename,
gboolean savedialog, GCallback ok_cb, GCallback cancel_cb,
PurpleAccount *account, const char *who, PurpleConversation *conv,
void *user_data);
/**
* Displays a folder select dialog. Returns the selected filename to
* the callback.
*
* @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 dirname The default directory name (may be @c NULL)
* @param ok_cb The callback for the @c OK button.
* @param cancel_cb The callback for the @c Cancel button, which may be @c NULL.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is
* @param who The username of the buddy associated with this request,
* or @c NULL if none is
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
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);
/**
* Displays a dialog allowing the user to select a window/monitor etc. for
* screen sharing. Returns a #PurpleMediaElementInfo to the callback or @c
* NULL if the request is cancelled.
*
* @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 cb The callback for the @c OK button.
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
void *purple_request_screenshare_media(void *handle, const char *title,
const char *primary, const char *secondary,
PurpleAccount *account, GCallback cb,
void *user_data);
/*@}*/
/**************************************************************************/
/** @name UI Registration Functions */
/**************************************************************************/
/*@{*/
/**
* Sets the UI operations structure to be used when displaying a
* request.
*
* @param ops The UI operations structure.
*/
void purple_request_set_ui_ops(PurpleRequestUiOps *ops);
/**
* Returns the UI operations structure to be used when displaying a
* request.
*
* @return The UI operations structure.
*/
PurpleRequestUiOps *purple_request_get_ui_ops(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_REQUEST_H_ */