#include <stdlib.h>
#include <glib-object.h>
#include <glib.h>
#include "account.h"
Include dependency graph for request.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
struct | PurpleRequestFields |
Multiple fields request data. More... | |
struct | PurpleRequestFieldGroup |
A group of fields with a title. More... | |
struct | PurpleRequestField |
A request field. More... | |
struct | PurpleRequestUiOps |
Request UI operations. More... | |
Request API | |
#define | purple_request_yes_no(handle, title, primary, secondary, default_action, account, who, conv, user_data, yes_cb, no_cb) |
A wrapper for purple_request_action() that uses Yes and No buttons. | |
#define | purple_request_ok_cancel(handle, title, primary, secondary, default_action, account, who, conv, user_data, ok_cb, cancel_cb) |
A wrapper for purple_request_action() that uses OK and Cancel buttons. | |
#define | purple_request_accept_cancel(handle, title, primary, secondary, default_action, account, who, conv, user_data, accept_cb, cancel_cb) |
A wrapper for purple_request_action() that uses Accept and Cancel buttons. | |
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 text input. | |
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 |
Prompts the user for multiple-choice input. | |
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) |
va_list version of purple_request_choice(); see its documentation. | |
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,...) |
Prompts the user for an action. | |
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) |
va_list version of purple_request_action(); see its documentation. | |
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) |
Displays groups of fields for the user to fill in. | |
void | purple_request_close (PurpleRequestType type, void *uihandle) |
Closes a request. | |
void | purple_request_close_with_handle (void *handle) |
Closes all requests registered with the specified 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 file selector request dialog. | |
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 folder select dialog. | |
Field List API | |
PurpleRequestFields * | purple_request_fields_new (void) |
Creates a list of fields to pass to purple_request_fields(). | |
void | purple_request_fields_destroy (PurpleRequestFields *fields) |
Destroys a list of fields. | |
void | purple_request_fields_add_group (PurpleRequestFields *fields, PurpleRequestFieldGroup *group) |
Adds a group of fields to the list. | |
GList * | purple_request_fields_get_groups (const PurpleRequestFields *fields) |
Returns a list of all groups in a field list. | |
gboolean | purple_request_fields_exists (const PurpleRequestFields *fields, const char *id) |
Returns whether or not the field with the specified ID exists. | |
GList * | purple_request_fields_get_required (const PurpleRequestFields *fields) |
Returns a list of all required fields. | |
gboolean | purple_request_fields_is_field_required (const PurpleRequestFields *fields, const char *id) |
Returns whether or not a field with the specified ID is required. | |
gboolean | purple_request_fields_all_required_filled (const PurpleRequestFields *fields) |
Returns whether or not all required fields have values. | |
PurpleRequestField * | purple_request_fields_get_field (const PurpleRequestFields *fields, const char *id) |
Return the field with the specified ID. | |
const char * | purple_request_fields_get_string (const PurpleRequestFields *fields, const char *id) |
Returns the string value of a field with the specified ID. | |
int | purple_request_fields_get_integer (const PurpleRequestFields *fields, const char *id) |
Returns the integer value of a field with the specified ID. | |
gboolean | purple_request_fields_get_bool (const PurpleRequestFields *fields, const char *id) |
Returns the boolean value of a field with the specified ID. | |
int | purple_request_fields_get_choice (const PurpleRequestFields *fields, const char *id) |
Returns the choice index of a field with the specified ID. | |
PurpleAccount * | purple_request_fields_get_account (const PurpleRequestFields *fields, const char *id) |
Returns the account of a field with the specified ID. | |
Fields Group API | |
PurpleRequestFieldGroup * | purple_request_field_group_new (const char *title) |
Creates a fields group with an optional title. | |
void | purple_request_field_group_destroy (PurpleRequestFieldGroup *group) |
Destroys a fields group. | |
void | purple_request_field_group_add_field (PurpleRequestFieldGroup *group, PurpleRequestField *field) |
Adds a field to the group. | |
const char * | purple_request_field_group_get_title (const PurpleRequestFieldGroup *group) |
Returns the title of a fields group. | |
GList * | purple_request_field_group_get_fields (const PurpleRequestFieldGroup *group) |
Returns a list of all fields in a group. | |
Field API | |
PurpleRequestField * | purple_request_field_new (const char *id, const char *text, PurpleRequestFieldType type) |
Creates a field of the specified type. | |
void | purple_request_field_destroy (PurpleRequestField *field) |
Destroys a field. | |
void | purple_request_field_set_label (PurpleRequestField *field, const char *label) |
Sets the label text of a field. | |
void | purple_request_field_set_visible (PurpleRequestField *field, gboolean visible) |
Sets whether or not a field is visible. | |
void | purple_request_field_set_type_hint (PurpleRequestField *field, const char *type_hint) |
Sets the type hint for the field. | |
void | purple_request_field_set_required (PurpleRequestField *field, gboolean required) |
Sets whether or not a field is required. | |
PurpleRequestFieldType | purple_request_field_get_type (const PurpleRequestField *field) |
Returns the type of a field. | |
const char * | purple_request_field_get_id (const PurpleRequestField *field) |
Returns the ID of a field. | |
const char * | purple_request_field_get_label (const PurpleRequestField *field) |
Returns the label text of a field. | |
gboolean | purple_request_field_is_visible (const PurpleRequestField *field) |
Returns whether or not a field is visible. | |
const char * | purple_request_field_get_type_hint (const PurpleRequestField *field) |
Returns the field's type hint. | |
gboolean | purple_request_field_is_required (const PurpleRequestField *field) |
Returns whether or not a field is required. | |
String Field API | |
PurpleRequestField * | purple_request_field_string_new (const char *id, const char *text, const char *default_value, gboolean multiline) |
Creates a string request field. | |
void | purple_request_field_string_set_default_value (PurpleRequestField *field, const char *default_value) |
Sets the default value in a string field. | |
void | purple_request_field_string_set_value (PurpleRequestField *field, const char *value) |
Sets the value in a string field. | |
void | purple_request_field_string_set_masked (PurpleRequestField *field, gboolean masked) |
Sets whether or not a string field is masked (commonly used for password fields). | |
void | purple_request_field_string_set_editable (PurpleRequestField *field, gboolean editable) |
Sets whether or not a string field is editable. | |
const char * | purple_request_field_string_get_default_value (const PurpleRequestField *field) |
Returns the default value in a string field. | |
const char * | purple_request_field_string_get_value (const PurpleRequestField *field) |
Returns the user-entered value in a string field. | |
gboolean | purple_request_field_string_is_multiline (const PurpleRequestField *field) |
Returns whether or not a string field is multi-line. | |
gboolean | purple_request_field_string_is_masked (const PurpleRequestField *field) |
Returns whether or not a string field is masked. | |
gboolean | purple_request_field_string_is_editable (const PurpleRequestField *field) |
Returns whether or not a string field is editable. | |
Integer Field API | |
PurpleRequestField * | purple_request_field_int_new (const char *id, const char *text, int default_value) |
Creates an integer field. | |
void | purple_request_field_int_set_default_value (PurpleRequestField *field, int default_value) |
Sets the default value in an integer field. | |
void | purple_request_field_int_set_value (PurpleRequestField *field, int value) |
Sets the value in an integer field. | |
int | purple_request_field_int_get_default_value (const PurpleRequestField *field) |
Returns the default value in an integer field. | |
int | purple_request_field_int_get_value (const PurpleRequestField *field) |
Returns the user-entered value in an integer field. | |
Boolean Field API | |
PurpleRequestField * | purple_request_field_bool_new (const char *id, const char *text, gboolean default_value) |
Creates a boolean field. | |
void | purple_request_field_bool_set_default_value (PurpleRequestField *field, gboolean default_value) |
Sets the default value in an boolean field. | |
void | purple_request_field_bool_set_value (PurpleRequestField *field, gboolean value) |
Sets the value in an boolean field. | |
gboolean | purple_request_field_bool_get_default_value (const PurpleRequestField *field) |
Returns the default value in an boolean field. | |
gboolean | purple_request_field_bool_get_value (const PurpleRequestField *field) |
Returns the user-entered value in an boolean field. | |
Choice Field API | |
PurpleRequestField * | purple_request_field_choice_new (const char *id, const char *text, int default_value) |
Creates a multiple choice field. | |
void | purple_request_field_choice_add (PurpleRequestField *field, const char *label) |
Adds a choice to a multiple choice field. | |
void | purple_request_field_choice_set_default_value (PurpleRequestField *field, int default_value) |
Sets the default value in an choice field. | |
void | purple_request_field_choice_set_value (PurpleRequestField *field, int value) |
Sets the value in an choice field. | |
int | purple_request_field_choice_get_default_value (const PurpleRequestField *field) |
Returns the default value in an choice field. | |
int | purple_request_field_choice_get_value (const PurpleRequestField *field) |
Returns the user-entered value in an choice field. | |
GList * | purple_request_field_choice_get_labels (const PurpleRequestField *field) |
Returns a list of labels in a choice field. | |
List Field API | |
PurpleRequestField * | purple_request_field_list_new (const char *id, const char *text) |
Creates a multiple list item field. | |
void | purple_request_field_list_set_multi_select (PurpleRequestField *field, gboolean multi_select) |
Sets whether or not a list field allows multiple selection. | |
gboolean | purple_request_field_list_get_multi_select (const PurpleRequestField *field) |
Returns whether or not a list field allows multiple selection. | |
void * | purple_request_field_list_get_data (const PurpleRequestField *field, const char *text) |
Returns the data for a particular item. | |
void | purple_request_field_list_add (PurpleRequestField *field, const char *item, void *data) |
Adds an item to a list field. | |
void | purple_request_field_list_add_selected (PurpleRequestField *field, const char *item) |
Adds a selected item to the list field. | |
void | purple_request_field_list_clear_selected (PurpleRequestField *field) |
Clears the list of selected items in a list field. | |
void | purple_request_field_list_set_selected (PurpleRequestField *field, GList *items) |
Sets a list of selected items in a list field. | |
gboolean | purple_request_field_list_is_selected (const PurpleRequestField *field, const char *item) |
Returns whether or not a particular item is selected in a list field. | |
GList * | purple_request_field_list_get_selected (const PurpleRequestField *field) |
Returns a list of selected items in a list field. | |
GList * | purple_request_field_list_get_items (const PurpleRequestField *field) |
Returns a list of items in a list field. | |
Label Field API | |
PurpleRequestField * | purple_request_field_label_new (const char *id, const char *text) |
Creates a label field. | |
Image Field API | |
PurpleRequestField * | purple_request_field_image_new (const char *id, const char *text, const char *buf, gsize size) |
Creates an image field. | |
void | purple_request_field_image_set_scale (PurpleRequestField *field, unsigned int x, unsigned int y) |
Sets the scale factors of an image field. | |
const char * | purple_request_field_image_get_buffer (PurpleRequestField *field) |
Returns pointer to the image. | |
gsize | purple_request_field_image_get_size (PurpleRequestField *field) |
Returns size (in bytes) of the image. | |
unsigned int | purple_request_field_image_get_scale_x (PurpleRequestField *field) |
Returns X scale coefficient of the image. | |
unsigned int | purple_request_field_image_get_scale_y (PurpleRequestField *field) |
Returns Y scale coefficient of the image. | |
Account Field API | |
PurpleRequestField * | purple_request_field_account_new (const char *id, const char *text, PurpleAccount *account) |
Creates an account field. | |
void | purple_request_field_account_set_default_value (PurpleRequestField *field, PurpleAccount *default_value) |
Sets the default account on an account field. | |
void | purple_request_field_account_set_value (PurpleRequestField *field, PurpleAccount *value) |
Sets the account in an account field. | |
void | purple_request_field_account_set_show_all (PurpleRequestField *field, gboolean show_all) |
Sets whether or not to show all accounts in an account field. | |
void | purple_request_field_account_set_filter (PurpleRequestField *field, PurpleFilterAccountFunc filter_func) |
Sets the account filter function in an account field. | |
PurpleAccount * | purple_request_field_account_get_default_value (const PurpleRequestField *field) |
Returns the default account in an account field. | |
PurpleAccount * | purple_request_field_account_get_value (const PurpleRequestField *field) |
Returns the user-entered account in an account field. | |
gboolean | purple_request_field_account_get_show_all (const PurpleRequestField *field) |
Returns whether or not to show all accounts in an account field. | |
PurpleFilterAccountFunc | purple_request_field_account_get_filter (const PurpleRequestField *field) |
Returns the account filter function in an account field. | |
UI Registration Functions | |
void | purple_request_set_ui_ops (PurpleRequestUiOps *ops) |
Sets the UI operations structure to be used when displaying a request. | |
PurpleRequestUiOps * | purple_request_get_ui_ops (void) |
Returns the UI operations structure to be used when displaying a request. | |
Defines | |
#define | PURPLE_DEFAULT_ACTION_NONE -1 |
Typedefs | |
typedef void(* | PurpleRequestInputCb )(void *, const char *) |
typedef void(* | PurpleRequestActionCb )(void *, int) |
The type of callbacks passed to purple_request_action(). | |
typedef void(* | PurpleRequestChoiceCb )(void *, int) |
typedef void(* | PurpleRequestFieldsCb )(void *, PurpleRequestFields *fields) |
typedef void(* | PurpleRequestFileCb )(void *, const char *filename) |
Enumerations | |
enum | PurpleRequestType { PURPLE_REQUEST_INPUT = 0, PURPLE_REQUEST_CHOICE, PURPLE_REQUEST_ACTION, PURPLE_REQUEST_FIELDS, PURPLE_REQUEST_FILE, PURPLE_REQUEST_FOLDER } |
Request types. More... | |
enum | PurpleRequestFieldType { 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 } |
A type of field. |
Definition in file request.h.
|
Value: purple_request_action((handle), (title), (primary), (secondary), \ (default_action), account, who, conv, (user_data), 2, \ _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
|
|
Value: purple_request_action((handle), (title), (primary), (secondary), \ (default_action), account, who, conv, (user_data), 2, \ _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb)) OK and Cancel buttons.
|
|
Value: purple_request_action((handle), (title), (primary), (secondary), \ (default_action), account, who, conv, (user_data), 2, \ _("_Yes"), (yes_cb), _("_No"), (no_cb)) Yes and No buttons.
|
|
The type of callbacks passed to purple_request_action(). The first argument is the user_data parameter; the second is the index in the list of actions of the one chosen. |
|
Request types.
|
|
Prompts the user for an action. This is often represented as a dialog with a button for each action.
|
|
Prompts the user for multiple-choice input.
|
|
Closes a request.
|
|
Closes all requests registered with the specified handle.
|
|
Returns the default account in an account field.
|
|
Returns the account filter function in an account field. This function will determine which accounts get displayed and which don't.
|
|
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.
|
|
Returns the user-entered account in an account field.
|
|
Creates an account field. By default, this field will not show offline accounts.
|
|
Sets the default account on an account field.
|
|
Sets the account filter function in an account field. This function will determine which accounts get displayed and which don't.
|
|
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.
|
|
Sets the account in an account field.
|
|
Returns the default value in an boolean field.
|
|
Returns the user-entered value in an boolean field.
|
|
Creates a boolean field. This is often represented as a checkbox.
|
|
Sets the default value in an boolean field.
|
|
Sets the value in an boolean field.
|
|
Adds a choice to a multiple choice field.
|
|
Returns the default value in an choice field.
|
|
Returns a list of labels in a choice field.
|
|
Returns the user-entered value in an choice field.
|
|
Creates a multiple choice field. This is often represented as a group of radio buttons.
|
|
Sets the default value in an choice field.
|
|
Sets the value in an choice field.
|
|
Destroys a field.
|
|
Returns the ID of a field.
|
|
Returns the label text of a field.
|
|
Returns the type of a field.
|
|
Returns the field's type hint.
|
|
Adds a field to the group.
|
|
Destroys a fields group.
|
|
Returns a list of all fields in a group.
|
|
Returns the title of a fields group.
|
|
Creates a fields group with an optional title.
|
|
Returns pointer to the image.
|
|
Returns X scale coefficient of the image.
|
|
Returns Y scale coefficient of the image.
|
|
Returns size (in bytes) of the image.
|
|
Creates an image field.
|
|
Sets the scale factors of an image field.
|
|
Returns the default value in an integer field.
|
|
Returns the user-entered value in an integer field.
|
|
Creates an integer field.
|
|
Sets the default value in an integer field.
|
|
Sets the value in an integer field.
|
|
Returns whether or not a field is required.
|
|
Returns whether or not a field is visible.
|
|
Creates a label field.
|
|
Adds an item to a list field.
|
|
Adds a selected item to the list field.
|
|
Clears the list of selected items in a list field.
|
|
Returns the data for a particular item.
|
|
Returns a list of items in a list field.
|
|
Returns whether or not a list field allows multiple selection.
|
|
Returns a list of selected items in a list field. To retrieve the data for each item, use purple_request_field_list_get_data().
|
|
Returns whether or not a particular item is selected in a list field.
|
|
Creates a multiple list item field.
|
|
Sets whether or not a list field allows multiple selection.
|
|
Sets a list of selected items in a list field.
|
|
Creates a field of the specified type.
|
|
Sets the label text of a field.
|
|
Sets whether or not a field is required.
|
|
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".
|
|
Sets whether or not a field is visible.
|
|
Returns the default value in a string field.
|
|
Returns the user-entered value in a string field.
|
|
Returns whether or not a string field is editable.
|
|
Returns whether or not a string field is masked.
|
|
Returns whether or not a string field is multi-line.
|
|
Creates a string request field.
|
|
Sets the default value in a string field.
|
|
Sets whether or not a string field is editable.
|
|
Sets whether or not a string field is masked (commonly used for password fields).
|
|
Sets the value in a string field.
|
|
Displays groups of fields for the user to fill in.
|
|
Adds a group of fields to the list.
|
|
Returns whether or not all required fields have values.
|
|
Destroys a list of fields.
|
|
Returns whether or not the field with the specified ID exists.
|
|
Returns the account of a field with the specified ID.
|
|
Returns the boolean value of a field with the specified ID.
|
|
Returns the choice index of a field with the specified ID.
|
|
Return the field with the specified ID.
|
|
Returns a list of all groups in a field list.
|
|
Returns the integer value of a field with the specified ID.
|
|
Returns a list of all required fields.
|
|
Returns the string value of a field with the specified ID.
|
|
Returns whether or not a field with the specified ID is required.
|
|
Creates a list of fields to pass to purple_request_fields().
|
|
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.
|
|
Displays a folder select dialog. Returns the selected filename to the callback.
|
|
Returns the UI operations structure to be used when displaying a request.
|
|
Prompts the user for text input.
|
|
Sets the UI operations structure to be used when displaying a request.
|