* @file request.h Request API * 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 * 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 "request-datasheet.h" typedef struct _PurpleRequestField PurpleRequestField; * Multiple fields request data. typedef struct _PurpleRequestFields PurpleRequestFields; * A group of fields with a title. typedef struct _PurpleRequestFieldGroup PurpleRequestFieldGroup; * Common parameters for UI operations. typedef struct _PurpleRequestCommonParameters PurpleRequestCommonParameters; #define PURPLE_DEFAULT_ACTION_NONE -1 PURPLE_REQUEST_INPUT = 0, /**< Text input request. */ PURPLE_REQUEST_CHOICE, /**< Multiple-choice request. */ PURPLE_REQUEST_ACTION, /**< Action request. */ PURPLE_REQUEST_WAIT, /**< Please wait dialog. */ PURPLE_REQUEST_FIELDS, /**< Multiple fields request. */ PURPLE_REQUEST_FILE, /**< File open or save request. */ PURPLE_REQUEST_FOLDER /**< Folder selection request. */ 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, PURPLE_REQUEST_FIELD_CERTIFICATE, PURPLE_REQUEST_FIELD_DATASHEET } PurpleRequestFieldType; PURPLE_REQUEST_FEATURE_HTML = 0x00000001 PURPLE_REQUEST_ICON_DEFAULT = 0, PURPLE_REQUEST_ICON_REQUEST, PURPLE_REQUEST_ICON_DIALOG, PURPLE_REQUEST_ICON_WAIT, PURPLE_REQUEST_ICON_INFO, PURPLE_REQUEST_ICON_WARNING, PURPLE_REQUEST_ICON_ERROR typedef void (*PurpleRequestCancelCb)(gpointer); PurpleRequestFeature features; /** @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, PurpleRequestCommonParameters *cpar, void *user_data); /** @see purple_request_choice_varg(). */ void *(*request_choice)(const char *title, const char *primary, const char *secondary, gpointer default_value, const char *ok_text, GCallback ok_cb, const char *cancel_text, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, 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, PurpleRequestCommonParameters *cpar, void *user_data, size_t action_count, va_list actions); /** @see purple_request_wait(). */ void *(*request_wait)(const char *title, const char *primary, const char *secondary, gboolean with_progress, PurpleRequestCancelCb cancel_cb, PurpleRequestCommonParameters *cpar, void *user_data); * @see purple_request_wait_pulse(). * @see purple_request_wait_progress(). void (*request_wait_update)(void *ui_handle, gboolean pulse, /** @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, PurpleRequestCommonParameters *cpar, void *user_data); /** @see purple_request_file(). */ void *(*request_file)(const char *title, const char *filename, gboolean savedialog, GCallback ok_cb, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, void *user_data); /** @see purple_request_folder(). */ void *(*request_folder)(const char *title, const char *dirname, GCallback ok_cb, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, void *user_data); void (*close_request)(PurpleRequestType type, void *ui_handle); void (*_purple_reserved1)(void); void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); typedef void (*PurpleRequestInputCb)(void *, const char *); typedef gboolean (*PurpleRequestFieldValidator)(PurpleRequestField *field, gchar **errmsg, gpointer user_data); typedef gboolean (*PurpleRequestFieldSensitivityCb)(PurpleRequestField *field); /** 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 *, gpointer); typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields); typedef void (*PurpleRequestFileCb)(void *, const char *filename); typedef void (*PurpleRequestHelpCb)(gpointer); /**************************************************************************/ /** @name Common parameters API */ /**************************************************************************/ * Creates new parameters set for the request, which may or may not be used by * the UI to display the request. * @return The new parameters set. PurpleRequestCommonParameters * purple_request_cpar_new(void); * Creates new parameters set initially bound with the #PurpleConnection. * @return The new parameters set. PurpleRequestCommonParameters * purple_request_cpar_from_connection(PurpleConnection *gc); * Creates new parameters set initially bound with the #PurpleAccount. * @return The new parameters set. PurpleRequestCommonParameters * purple_request_cpar_from_account(PurpleAccount *account); * Creates new parameters set initially bound with the #PurpleConversation. * @return The new parameters set. PurpleRequestCommonParameters * purple_request_cpar_from_conversation(PurpleConversation *conv); * Increases the reference count on the parameters set. * @param cpar The object to ref. purple_request_cpar_ref(PurpleRequestCommonParameters *cpar); * Decreases the reference count on the parameters set. * The object will be destroyed when this reaches 0. * @param cpar The parameters set object to unref and possibly destroy. * @return The NULL, if object was destroyed, cpar otherwise. PurpleRequestCommonParameters * purple_request_cpar_unref(PurpleRequestCommonParameters *cpar); * Sets the #PurpleAccount associated with the request, or @c NULL, if none is. * @param cpar The parameters set. * @param account The #PurpleAccount to associate. purple_request_cpar_set_account(PurpleRequestCommonParameters *cpar, * Gets the #PurpleAccount associated with the request. * @param cpar The parameters set (may be @c NULL). * @return The associated #PurpleAccount, or NULL if none is. purple_request_cpar_get_account(PurpleRequestCommonParameters *cpar); * Sets the #PurpleConversation associated with the request, or @c NULL, if * @param cpar The parameters set. * @param conv The #PurpleConversation to associate. purple_request_cpar_set_conversation(PurpleRequestCommonParameters *cpar, PurpleConversation *conv); * Gets the #PurpleConversation associated with the request. * @param cpar The parameters set (may be @c NULL). * @return The associated #PurpleConversation, or NULL if none is. purple_request_cpar_get_conversation(PurpleRequestCommonParameters *cpar); * Sets the icon associated with the request. * @param cpar The parameters set. * @param icon_type The icon type. purple_request_cpar_set_icon(PurpleRequestCommonParameters *cpar, PurpleRequestIconType icon_type); * Gets the icon associated with the request. * @param cpar The parameters set. * @returns icon_type The icon type. purple_request_cpar_get_icon(PurpleRequestCommonParameters *cpar); * Sets the custom icon associated with the request. * @param cpar The parameters set. * @param icon_data The icon image contents (@c NULL to reset). * @param icon_size The icon image size. purple_request_cpar_set_custom_icon(PurpleRequestCommonParameters *cpar, gconstpointer icon_data, gsize icon_size); * Gets the custom icon associated with the request. * @param cpar The parameters set (may be @c NULL). * @param icon_size The pointer to variable, where icon size should be stored * @return The icon image contents. purple_request_cpar_get_custom_icon(PurpleRequestCommonParameters *cpar, * Switches the request text to be HTML or not. * @param cpar The parameters set. * @param enabled 1, if the text passed with the request contains HTML, * 0 otherwise. Don't use any other values, as they may be * redefined in the future. purple_request_cpar_set_html(PurpleRequestCommonParameters *cpar, * Checks, if the text passed to the request is HTML. * @param cpar The parameters set (may be @c NULL). * @return @c TRUE, if the text is HTML, @c FALSE otherwise. purple_request_cpar_is_html(PurpleRequestCommonParameters *cpar); * Sets dialog display mode to compact or default. * @param cpar The parameters set. * @param compact TRUE for compact, FALSE otherwise. purple_request_cpar_set_compact(PurpleRequestCommonParameters *cpar, * Gets dialog display mode. * @param cpar The parameters set (may be @c NULL). * @return TRUE for compact, FALSE for default. purple_request_cpar_is_compact(PurpleRequestCommonParameters *cpar); * Sets the callback for the Help button. * @param cpar The parameters set. * @param cb The callback. * @param user_data The data to be passed to the callback. purple_request_cpar_set_help_cb(PurpleRequestCommonParameters *cpar, PurpleRequestHelpCb cb, gpointer user_data); * Gets the callback for the Help button. * @param cpar The parameters set (may be @c NULL). * @param user_data The pointer to the variable, where user data (to be passed * to callback function) should be stored. purple_request_cpar_get_help_cb(PurpleRequestCommonParameters *cpar, * Sets extra actions for the PurpleRequestFields dialog. * @param cpar The parameters set. * @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 #PurpleRequestFieldsCb function to use when the * button is clicked. Should be terminated with the NULL label. purple_request_cpar_set_extra_actions(PurpleRequestCommonParameters *cpar, ...); * Gets extra actions for the PurpleRequestFields dialog. * @param cpar The parameters set (may be @c NULL). * @return A list of actions (pairs of arguments, as in setter). purple_request_cpar_get_extra_actions(PurpleRequestCommonParameters *cpar); * Sets the same parent window for this dialog, as the parent of specified * Notify API or Request API dialog UI handle. * @param cpar The parameters set. * @param ui_handle The UI handle. purple_request_cpar_set_parent_from(PurpleRequestCommonParameters *cpar, * Gets the parent "donor" for this dialog. * @param cpar The parameters set (may be @c NULL). * @return The donors UI handle. purple_request_cpar_get_parent_from(PurpleRequestCommonParameters *cpar); /**************************************************************************/ /** @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); * Set tab names for a field list. * @param fields The fields list. * @param tab_names NULL-terminated array of localized tab labels, void purple_request_fields_set_tab_names(PurpleRequestFields *fields, const gchar **tab_names); * Returns tab names of a field list. * @param fields The fields list. * @return NULL-terminated array of localized tab labels, or NULL if tabs purple_request_fields_get_tab_names(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, * Returns a list of all required fields. * @param fields The fields list. * @constreturn The list of required fields. const GList *purple_request_fields_get_required( const PurpleRequestFields *fields); * Returns a list of all validated fields. * @param fields The fields list. * @constreturn The list of validated fields. const GList *purple_request_fields_get_validatable( const PurpleRequestFields *fields); * Returns a list of all fields with sensitivity callback added. * @param fields The fields list. * @constreturn The list of fields with automatic sensitivity callback. purple_request_fields_get_autosensitive(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, * 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); * Returns whether or not all fields are valid. * @param fields The fields list. * @return TRUE if all fields are valid, or FALSE. gboolean purple_request_fields_all_valid(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, * 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, * 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, * 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 value, if found, or NULL otherwise. purple_request_fields_get_choice(const PurpleRequestFields *fields, * 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, * 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 */ /**************************************************************************/ * 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); * Sets tab number for a group. * @param group The group. * @param tab_no The tab number. * @see purple_request_fields_set_tab_names void purple_request_field_group_set_tab(PurpleRequestFieldGroup *group, * Returns tab number of a group. * @param group The group. * @see purple_request_fields_get_tab_names guint purple_request_field_group_get_tab(const PurpleRequestFieldGroup *group); * 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); * 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); /**************************************************************************/ /**************************************************************************/ * 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. PurpleRequestField *purple_request_field_new(const char *id, const char *text, PurpleRequestFieldType type); * @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, * Sets the tooltip for the field. * This is optionally used by the UIs to provide a tooltip for * @param field The field. * @param tooltip The tooltip text. void purple_request_field_set_tooltip(PurpleRequestField *field, * 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, * 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. PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field); * Returns the ID of a field. * @param field The field. 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 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. gboolean purple_request_field_is_required(const PurpleRequestField *field); * Checks, if specified field has value. * @param field The field. * @return TRUE if the field has value, or FALSE. gboolean purple_request_field_is_filled(const PurpleRequestField *field); * Sets validator for a single field. * @param field The field. * @param validator The validator callback, NULL to disable validation. * @param user_data The data to pass to the callback. void purple_request_field_set_validator(PurpleRequestField *field, PurpleRequestFieldValidator validator, void *user_data); * Returns whether or not field has validator set. * @param field The field. * @return TRUE if the field has validator, or FALSE. gboolean purple_request_field_is_validatable(PurpleRequestField *field); * Checks, if specified field is valid. * If detailed message about failure reason is needed, there is an option to * return (via errmsg argument) pointer to newly allocated error message. * It must be freed with g_free after use. * Note: empty, not required fields are valid. * @param field The field. * @param errmsg If non-NULL, the memory area, where the pointer to validation * failure message will be set. * @return TRUE, if the field is valid, FALSE otherwise. gboolean purple_request_field_is_valid(PurpleRequestField *field, gchar **errmsg); * @param field The field. * @param sensitive TRUE if the field should be sensitive for user input. void purple_request_field_set_sensitive(PurpleRequestField *field, * Checks, if field is editable. * @param field The field. * @return TRUE, if the field is sensitive for user input. gboolean purple_request_field_is_sensitive(PurpleRequestField *field); * Sets the callback, used to determine if the field should be editable. * @param field The field. * @param cb The callback. void purple_request_field_set_sensitivity_cb(PurpleRequestField *field, PurpleRequestFieldSensitivityCb cb); * Returns the ui_data for a field. * @param field The field. 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. void purple_request_field_set_ui_data(PurpleRequestField *field, /**************************************************************************/ /** @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. PurpleRequestField *purple_request_field_string_new(const char *id, const char *default_value, * 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, * 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, * 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. 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); /**************************************************************************/ /** @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. * @param lower_bound The lower bound. * @param upper_bound The upper bound. PurpleRequestField *purple_request_field_int_new(const char *id, const char *text, int default_value, int lower_bound, int upper_bound); * 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, * Sets the lower bound in an integer field. * @param field The field. * @param lower_bound The lower bound. void purple_request_field_int_set_lower_bound(PurpleRequestField *field, int lower_bound); * Sets the upper bound in an integer field. * @param field The field. * @param upper_bound The upper bound. void purple_request_field_int_set_upper_bound(PurpleRequestField *field, int lower_bound); * 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 lower bound in an integer field. * @param field The field. * @return The lower bound. int purple_request_field_int_get_lower_bound(const PurpleRequestField *field); * Returns the upper bound in an integer field. * @param field The field. * @return The upper bound. int purple_request_field_int_get_upper_bound(const PurpleRequestField *field); * Returns the user-entered value in an integer field. * @param field The field. 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. PurpleRequestField *purple_request_field_bool_new(const char *id, * 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, * Sets the value in an boolean field. * @param field The field. * @param value The value. void purple_request_field_bool_set_value(PurpleRequestField *field, * 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. 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. purple_request_field_choice_new(const char *id, const char *text, * Adds a choice to a multiple choice field. * @param field The choice field. * @param label The choice label. * @param data The choice value. 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. purple_request_field_choice_set_default_value(PurpleRequestField *field, * Sets the value in an choice field. * @param field The field. * @param value The value. purple_request_field_choice_set_value(PurpleRequestField *field, * Returns the default value in an choice field. * @param field The field. * @return The default value. purple_request_field_choice_get_default_value(const PurpleRequestField *field); * Returns the user-entered value in an choice field. * @param field The field. purple_request_field_choice_get_value(const PurpleRequestField *field); * Returns a list of elements in a choice field. * @param field The field. * @constreturn The list of pairs <label, value>. purple_request_field_choice_get_elements(const PurpleRequestField *field); * Sets the destructor for field values. * @param field The field. * @param destroy The destroy function. purple_request_field_choice_set_data_destructor(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. 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, void purple_request_field_list_set_multi_select(PurpleRequestField *field, * 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, * 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, * 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, * Returns whether or not a particular item is selected in a list field. * @param field The field. * @return TRUE if the item is selected. FALSE otherwise. gboolean purple_request_field_list_is_selected(const PurpleRequestField *field, * 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 GList *purple_request_field_list_get_icons(const PurpleRequestField *field); /**************************************************************************/ /** @name Label Field API */ /**************************************************************************/ * @param id The field ID. * @param text The label of the field. PurpleRequestField *purple_request_field_label_new(const char *id, /**************************************************************************/ /** @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. 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. PurpleRequestField *purple_request_field_account_new(const char *id, * 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, * 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, * Sets the account filter function in an account field. * This function will determine which accounts get displayed and which * @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 * @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. PurpleRequestField *purple_request_field_certificate_new(const char *id, 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); /**************************************************************************/ /** @name Datasheet Field API */ /**************************************************************************/ * Creates a datasheet item field. * @param id The field ID. * @param text The label of the field, may be @c NULL. * @param sheet The datasheet. PurpleRequestField *purple_request_field_datasheet_new(const char *id, const gchar *text, PurpleRequestDatasheet *sheet); * Returns a datasheet for a field. * @param field The field. * @constreturn The datasheet object. PurpleRequestDatasheet *purple_request_field_datasheet_get_sheet( PurpleRequestField *field); /**************************************************************************/ /** @name Validators for request fields. */ /**************************************************************************/ * Validates a field which should contain an email address. * @see purple_request_field_set_validator * @param field The field. * @param errmsg (Optional) destination for error message. * @param user_data Ignored. * @return TRUE, if field contains valid email address. gboolean purple_request_field_email_validator(PurpleRequestField *field, gchar **errmsg, void *user_data); * Validates a field which should contain alphanumeric content. * @see purple_request_field_set_validator * @param field The field. * @param errmsg (Optional) destination for error message. * @param user_data (Optional) allowed character list (NULL-terminated string). * @return TRUE, if field contains only alphanumeric characters. gboolean purple_request_field_alphanumeric_validator(PurpleRequestField *field, gchar **errmsg, void *allowed_characters); /**************************************************************************/ /**************************************************************************/ * 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 * @param primary The main point of the message, or @c NULL if you're * @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 * @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 * @param cancel_text The text for the @c Cancel button, which may not be @c * @param cancel_cb The callback for the @c Cancel button, which may be * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @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, PurpleRequestCommonParameters *cpar, * 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 * @param primary The main point of the message, or @c NULL if you're * @param secondary Secondary information, or @c NULL if there is none. * @param default_value The default choice; this should be one of the values * @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 * @param cancel_text The text for the @c Cancel button, which may not be @c * @param cancel_cb The callback for the @c Cancel button, or @c NULL to * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @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 * @return A UI-specific handle. void *purple_request_choice(void *handle, const char *title, const char *primary, const char *secondary, gpointer default_value, const char *ok_text, GCallback ok_cb, const char *cancel_text, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, 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, gpointer default_value, const char *ok_text, GCallback ok_cb, const char *cancel_text, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, 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 * @param primary The main point of the message, or @c NULL if you're * @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 * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @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. purple_request_action(void *handle, const char *title, const char *primary, const char *secondary, int default_action, PurpleRequestCommonParameters *cpar, void *user_data, size_t action_count, ...); * <tt>va_list</tt> version of purple_request_action(); see its documentation. purple_request_action_varg(void *handle, const char *title, const char *primary, const char *secondary, int default_action, PurpleRequestCommonParameters *cpar, void *user_data, size_t action_count, va_list actions); * Displays a "please wait" dialog. * @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 * @param primary The main point of the message, or @c NULL if you're * @param secondary Secondary information, or @c NULL if there is none. * @param with_progress @c TRUE, if we want to display progress bar, @c FALSE * @param cancel_cb The callback for the @c Cancel button, which may be * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @param user_data The data to pass to the callback. * @return A UI-specific handle. purple_request_wait(void *handle, const char *title, const char *primary, const char *secondary, gboolean with_progress, PurpleRequestCancelCb cancel_cb, PurpleRequestCommonParameters *cpar, * Notifies the "please wait" dialog that some progress has been made, but you * @param ui_handle The request UI handle. purple_request_wait_pulse(void *ui_handle); * Notifies the "please wait" dialog about progress has been made. * @param ui_handle The request UI handle. * @param fraction The part of task that is done (between 0.0 and 1.0, purple_request_wait_progress(void *ui_handle, gfloat fraction); * 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 * @param primary The main point of the message, or @c NULL if you're * @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 * @param cancel_text The text for the @c Cancel button, which may not be @c * @param cancel_cb The callback for the @c Cancel button, which may be * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @param user_data The data to pass to the callback. * @return A UI-specific handle. 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, PurpleRequestCommonParameters *cpar, * Checks, if passed UI handle is valid. * @param ui_handle The UI handle. * @param type The pointer to variable, where request type may be stored * @return TRUE, if handle is valid, FALSE otherwise. purple_request_is_valid_ui_handle(void *ui_handle, PurpleRequestType *type); * Adds a function called when notification dialog is closed. * @param ui_handle The UI handle. * @param notify The function to be called. * @param notify_data The data to be passed to the callback function. purple_request_add_close_notify(void *ui_handle, GDestroyNotify notify, * @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, cpar, user_data, yes_cb, no_cb) \ purple_request_action((handle), (title), (primary), (secondary), \ (default_action), (cpar), (user_data), 2, _("_Yes"), (yes_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, cpar, user_data, ok_cb, cancel_cb) \ purple_request_action((handle), (title), (primary), (secondary), \ (default_action), (cpar), (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, cpar, user_data, accept_cb, cancel_cb) \ purple_request_action((handle), (title), (primary), (secondary), \ (default_action), (cpar), (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 * @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 cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @param user_data The data to pass to the callback. * @return A UI-specific handle. purple_request_file(void *handle, const char *title, const char *filename, gboolean savedialog, GCallback ok_cb, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, void *user_data); * Displays a folder select dialog. Returns the selected filename to * @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 * @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 cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call. * @param user_data The data to pass to the callback. * @return A UI-specific handle. purple_request_folder(void *handle, const char *title, const char *dirname, GCallback ok_cb, GCallback cancel_cb, PurpleRequestCommonParameters *cpar, 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 * @param primary The main point of the message, or @c NULL if you're * @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 * @param cancel_text The text for the @c Cancel button, which may not be * @param cancel_cb The callback for the @c Cancel button, which may be * @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, /**************************************************************************/ /** @name UI Registration Functions */ /**************************************************************************/ * Sets the UI operations structure to be used when displaying a * @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 * @return The UI operations structure. PurpleRequestUiOps *purple_request_get_ui_ops(void); #endif /* _PURPLE_REQUEST_H_ */
