#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 | PurpleRequestField |
| A request field. More... | |
| struct | PurpleRequestFieldGroup |
| A group of fields with a title. More... | |
| struct | PurpleRequestFields |
| Multiple fields request data. More... | |
| struct | PurpleRequestUiOps |
| Request UI operations. More... | |
Request API | |
| #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. | |
| #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_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. | |
| void * | purple_request_action (void *handle, const char *title, const char *primary, const char *secondary, unsigned 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, unsigned int default_action, PurpleAccount *account, const char *who, PurpleConversation *conv, void *user_data, size_t action_count, va_list actions) |
| Prompts the user for an action. | |
| void * | purple_request_choice (void *handle, const char *title, const char *primary, const char *secondary, unsigned 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, unsigned 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 multiple-choice input. | |
| 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_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_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. | |
| 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. | |
Defines | |
| #define | PURPLE_DEFAULT_ACTION_NONE -1 |
Typedefs | |
| 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(*) | PurpleRequestInputCb (void *, const char *) |
Enumerations | |
| 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. | |
| enum | PurpleRequestType { PURPLE_REQUEST_INPUT = 0, PURPLE_REQUEST_CHOICE, PURPLE_REQUEST_ACTION, PURPLE_REQUEST_FIELDS, PURPLE_REQUEST_FILE, PURPLE_REQUEST_FOLDER } |
| Request types. More... | |
Functions | |
Account Field API | |
| PurpleAccount * | purple_request_field_account_get_default_value (const PurpleRequestField *field) |
| Returns the default account in an account field. | |
| PurpleFilterAccountFunc | purple_request_field_account_get_filter (const PurpleRequestField *field) |
| Returns the account filter function 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. | |
| PurpleAccount * | purple_request_field_account_get_value (const PurpleRequestField *field) |
| Returns the user-entered account in an account field. | |
| 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_filter (PurpleRequestField *field, PurpleFilterAccountFunc filter_func) |
| Sets the account filter function 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_value (PurpleRequestField *field, PurpleAccount *value) |
| Sets the account in an account field. | |
Boolean Field API | |
| 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. | |
| 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. | |
Choice Field API | |
| void | purple_request_field_choice_add (PurpleRequestField *field, const char *label) |
| Adds a choice to a multiple choice field. | |
| int | purple_request_field_choice_get_default_value (const PurpleRequestField *field) |
| Returns the default value in an choice field. | |
| GList * | purple_request_field_choice_get_labels (const PurpleRequestField *field) |
| Returns a list of labels in a choice field. | |
| int | purple_request_field_choice_get_value (const PurpleRequestField *field) |
| Returns the user-entered value in an choice field. | |
| 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_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. | |
Field API | |
| void | purple_request_field_destroy (PurpleRequestField *field) |
| Destroys 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. | |
| PurpleRequestFieldType | purple_request_field_get_type (const PurpleRequestField *field) |
| Returns the type of a field. | |
| 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. | |
| gboolean | purple_request_field_is_visible (const PurpleRequestField *field) |
| Returns whether or not a field is visible. | |
| PurpleRequestField * | purple_request_field_new (const char *id, const char *text, PurpleRequestFieldType type) |
| Creates a field of the specified type. | |
| void | purple_request_field_set_label (PurpleRequestField *field, const char *label) |
| Sets the label text of a field. | |
| void | purple_request_field_set_required (PurpleRequestField *field, gboolean required) |
| Sets whether or not a field is required. | |
| 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_visible (PurpleRequestField *field, gboolean visible) |
| Sets whether or not a field is visible. | |
Fields Group API | |
| void | purple_request_field_group_add_field (PurpleRequestFieldGroup *group, PurpleRequestField *field) |
| Adds a field to the group. | |
| void | purple_request_field_group_destroy (PurpleRequestFieldGroup *group) |
| Destroys a fields group. | |
| GList * | purple_request_field_group_get_fields (const PurpleRequestFieldGroup *group) |
| Returns a list of all fields in a group. | |
| const char * | purple_request_field_group_get_title (const PurpleRequestFieldGroup *group) |
| Returns the title of a fields group. | |
| PurpleRequestFieldGroup * | purple_request_field_group_new (const char *title) |
| Creates a fields group with an optional title. | |
Image Field API | |
| const char * | purple_request_field_image_get_buffer (PurpleRequestField *field) |
| Returns pointer to 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. | |
| gsize | purple_request_field_image_get_size (PurpleRequestField *field) |
| Returns size (in bytes) of the image. | |
| 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. | |
Integer Field API | |
| 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. | |
| 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. | |
Label Field API | |
| PurpleRequestField * | purple_request_field_label_new (const char *id, const char *text) |
| Creates a label field. | |
List Field API | |
| 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_get_data (const PurpleRequestField *field, const char *text) |
| Returns the data for a particular item. | |
| GList * | purple_request_field_list_get_items (const PurpleRequestField *field) |
| Returns a list of items in a list field. | |
| gboolean | purple_request_field_list_get_multi_select (const PurpleRequestField *field) |
| Returns whether or not a list field allows multiple selection. | |
| GList * | purple_request_field_list_get_selected (const PurpleRequestField *field) |
| Returns 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. | |
| 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. | |
| void | purple_request_field_list_set_selected (PurpleRequestField *field, GList *items) |
| Sets a list of selected items in a list field. | |
String Field API | |
| 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_editable (const PurpleRequestField *field) |
| Returns whether or not a string field is editable. | |
| 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_multiline (const PurpleRequestField *field) |
| Returns whether or not a string field is multi-line. | |
| 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_editable (PurpleRequestField *field, gboolean editable) |
| Sets whether or not a string field is editable. | |
| 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_value (PurpleRequestField *field, const char *value) |
| Sets the value in a string field. | |
Field List API | |
| void | purple_request_fields_add_group (PurpleRequestFields *fields, PurpleRequestFieldGroup *group) |
| Adds a group of fields to the list. | |
| gboolean | purple_request_fields_all_required_filled (const PurpleRequestFields *fields) |
| Returns whether or not all required fields have values. | |
| void | purple_request_fields_destroy (PurpleRequestFields *fields) |
| Destroys a list of fields. | |
| gboolean | purple_request_fields_exists (const PurpleRequestFields *fields, const char *id) |
| Returns whether or not the field with the specified ID exists. | |
| PurpleAccount * | purple_request_fields_get_account (const PurpleRequestFields *fields, const char *id) |
| Returns the account 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. | |
| PurpleRequestField * | purple_request_fields_get_field (const PurpleRequestFields *fields, const char *id) |
| Return the field with the specified ID. | |
| GList * | purple_request_fields_get_groups (const PurpleRequestFields *fields) |
| Returns a list of all groups in a field list. | |
| int | purple_request_fields_get_integer (const PurpleRequestFields *fields, const char *id) |
| Returns the integer value of a field with the specified ID. | |
| GList * | purple_request_fields_get_required (const PurpleRequestFields *fields) |
| Returns a list of all required fields. | |
| const char * | purple_request_fields_get_string (const PurpleRequestFields *fields, const char *id) |
| Returns the string value of a field with the specified ID. | |
| 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. | |
| PurpleRequestFields * | purple_request_fields_new (void) |
| Creates a list of fields to pass to purple_request_fields(). | |
UI Registration Functions | |
| PurpleRequestUiOps * | purple_request_get_ui_ops (void) |
| Returns the UI operations structure to be used when displaying a request. | |
| void | purple_request_set_ui_ops (PurpleRequestUiOps *ops) |
| Sets the UI operations structure to be used when displaying a request. | |
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Definition in file request.h.
| #define purple_request_accept_cancel | ( | handle, | |||
| title, | |||||
| primary, | |||||
| secondary, | |||||
| default_action, | |||||
| account, | |||||
| who, | |||||
| conv, | |||||
| user_data, | |||||
| accept_cb, | |||||
| cancel_cb | ) |
Value:
purple_request_action((handle), (title), (primary), (secondary), \ (default_action), account, who, conv, (user_data), 2, \ _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
| #define purple_request_ok_cancel | ( | handle, | |||
| title, | |||||
| primary, | |||||
| secondary, | |||||
| default_action, | |||||
| account, | |||||
| who, | |||||
| conv, | |||||
| user_data, | |||||
| ok_cb, | |||||
| 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.
| #define purple_request_yes_no | ( | handle, | |||
| title, | |||||
| primary, | |||||
| secondary, | |||||
| default_action, | |||||
| account, | |||||
| who, | |||||
| conv, | |||||
| user_data, | |||||
| yes_cb, | |||||
| no_cb | ) |
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.
| enum PurpleRequestType |
| void* purple_request_action | ( | void * | handle, | |
| const char * | title, | |||
| const char * | primary, | |||
| const char * | secondary, | |||
| unsigned int | default_action, | |||
| PurpleAccount * | account, | |||
| const char * | who, | |||
| PurpleConversation * | conv, | |||
| void * | user_data, | |||
| size_t | action_count, | |||
| ... | ||||
| ) |
Prompts the user for an action.
This is often represented as a dialog with a button for each action.
| handle | The plugin or connection handle. For some things this is EXTREMELY important. See the comments on purple_request_input. | |
| title | The title of the message. | |
| primary | The main point of the message. | |
| secondary | The secondary information. | |
| default_action | The default value. | |
| account | The PurpleAccount associated with this request, or NULL if none is | |
| who | The username of the buddy assocaited with this request, or NULL if none is | |
| conv | The PurpleConversation associated with this request, or NULL if none is | |
| user_data | The data to pass to the callback. | |
| action_count | The number of actions. | |
| ... | A list of actions. These are pairs of arguments. The first of each pair is the string 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 callback function to use when the button is clicked. |
| void* purple_request_action_varg | ( | void * | handle, | |
| const char * | title, | |||
| const char * | primary, | |||
| const char * | secondary, | |||
| unsigned int | default_action, | |||
| PurpleAccount * | account, | |||
| const char * | who, | |||
| PurpleConversation * | conv, | |||
| void * | user_data, | |||
| size_t | action_count, | |||
| va_list | actions | |||
| ) |
Prompts the user for an action.
This is often represented as a dialog with a button for each action.
| handle | The plugin or connection handle. For some things this is EXTREMELY important. See the comments on purple_request_input. | |
| title | The title of the message. | |
| primary | The main point of the message. | |
| secondary | The secondary information. | |
| default_action | The default value. | |
| account | The PurpleAccount associated with this request, or NULL if none is | |
| who | The username of the buddy assocaited with this request, or NULL if none is | |
| conv | The PurpleConversation associated with this request, or NULL if none is | |
| user_data | The data to pass to the callback. | |
| action_count | The number of actions. | |
| actions | A list of actions and callbacks. |
| void* purple_request_choice | ( | void * | handle, | |
| const char * | title, | |||
| const char * | primary, | |||
| const char * | secondary, | |||
| unsigned 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, | |||
| ... | ||||
| ) |
Prompts the user for multiple-choice input.
| handle | The plugin or connection handle. For some things this is EXTREMELY important. See the comments on purple_request_input. | |
| title | The title of the message. | |
| primary | The main point of the message. | |
| secondary | The secondary information. | |
| default_value | The default value. | |
| ok_text | The text for the OK button. | |
| ok_cb | The callback for the OK button. | |
| cancel_text | The text for the Cancel button. | |
| cancel_cb | The callback for the Cancel button. | |
| account | The PurpleAccount associated with this request, or NULL if none is | |
| who | The username of the buddy assocaited with this request, or NULL if none is | |
| conv | The PurpleConversation associated with this request, or NULL if none is | |
| user_data | The data to pass to the callback. | |
| ... | The choices. This argument list should be terminated with a NULL parameter. |
| void* purple_request_choice_varg | ( | void * | handle, | |
| const char * | title, | |||
| const char * | primary, | |||
| const char * | secondary, | |||
| unsigned 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 multiple-choice input.
| handle | The plugin or connection handle. For some things this is EXTREMELY important. See the comments on purple_request_input. | |
| title | The title of the message. | |
| primary | The main point of the message. | |
| secondary | The secondary information. | |
| default_value | The default value. | |
| ok_text | The text for the OK button. | |
| ok_cb | The callback for the OK button. | |
| cancel_text | The text for the Cancel button. | |
| cancel_cb | The callback for the Cancel button. | |
| account | The PurpleAccount associated with this request, or NULL if none is | |
| who | The username of the buddy assocaited with this request, or NULL if none is | |
| conv | The PurpleConversation associated with this request, or NULL if none is | |
| user_data | The data to pass to the callback. | |
| choices | The choices. This argument list should be terminated with a NULL parameter. |
| void purple_request_close | ( | PurpleRequestType | type, | |
| void * | uihandle | |||
| ) |
Closes a request.
| type | The request type. | |
| uihandle | The request UI handle. |
| void purple_request_close_with_handle | ( | void * | handle | ) |
Closes all requests registered with the specified handle.
| handle | The handle. |
| PurpleAccount* purple_request_field_account_get_default_value | ( | const PurpleRequestField * | field | ) |
Returns the default account in an account field.
| field | The field. |
| PurpleFilterAccountFunc purple_request_field_account_get_filter | ( | const PurpleRequestField * | field | ) |
Returns the account filter function in an account field.
This function will determine which accounts get displayed and which don't.
| field | The 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.
If TRUE, all accounts, online or offline, will be shown. If FALSE, only online accounts will be shown.
| field | The account field. |
| PurpleAccount* purple_request_field_account_get_value | ( | const PurpleRequestField * | field | ) |
Returns the user-entered account in an account field.
| field | The field. |
| PurpleRequestField* purple_request_field_account_new | ( | const char * | id, | |
| const char * | text, | |||
| PurpleAccount * | account | |||
| ) |
Creates an account field.
By default, this field will not show offline accounts.
| id | The field ID. | |
| text | The text label of the field. | |
| account | The optional default account. |
| void purple_request_field_account_set_default_value | ( | PurpleRequestField * | field, | |
| PurpleAccount * | default_value | |||
| ) |
Sets the default account on an account field.
| field | The account field. | |
| default_value | The default account. |
| void purple_request_field_account_set_filter | ( | PurpleRequestField * | field, | |
| PurpleFilterAccountFunc | filter_func | |||
| ) |
Sets the account filter function in an account field.
This function will determine which accounts get displayed and which don't.
| field | The account field. | |
| filter_func | The account filter function. |
| 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.
If TRUE, all accounts, online or offline, will be shown. If FALSE, only online accounts will be shown.
| field | The account field. | |
| show_all | Whether or not to show all accounts. |
| void purple_request_field_account_set_value | ( | PurpleRequestField * | field, | |
| PurpleAccount * | value | |||
| ) |
Sets the account in an account field.
| field | The account field. | |
| value | The account. |
| gboolean purple_request_field_bool_get_default_value | ( | const PurpleRequestField * | field | ) |
Returns the default value in an boolean field.
| field | The field. |
| gboolean purple_request_field_bool_get_value | ( | const PurpleRequestField * | field | ) |
Returns the user-entered value in an boolean field.
| field | The field. |
| PurpleRequestField* purple_request_field_bool_new | ( | const char * | id, | |
| const char * | text, | |||
| gboolean | default_value | |||
| ) |
Creates a boolean field.
This is often represented as a checkbox.
| id | The field ID. | |
| text | The text label of the field. | |
| default_value | The default value. |
| void purple_request_field_bool_set_default_value | ( | PurpleRequestField * | field, | |
| gboolean | default_value | |||
| ) |
Sets the default value in an boolean field.
| field | The field. | |
| default_value | The default value. |
| void purple_request_field_bool_set_value | ( | PurpleRequestField * | field, | |
| gboolean | value | |||
| ) |
Sets the value in an boolean field.
| field | The field. | |
| value | The value. |
| void purple_request_field_choice_add | ( | PurpleRequestField * | field, | |
| const char * | label | |||
| ) |
Adds a choice to a multiple choice field.
| field | The choice field. | |
| label | The choice label. |
| int purple_request_field_choice_get_default_value | ( | const PurpleRequestField * | field | ) |
Returns the default value in an choice field.
| field | The field. |
| GList* purple_request_field_choice_get_labels | ( | const PurpleRequestField * | field | ) |
Returns a list of labels in a choice field.
| field | The field. |
| int purple_request_field_choice_get_value | ( | const PurpleRequestField * | field | ) |
Returns the user-entered value in an choice field.
| field | The field. |
| PurpleRequestField* purple_request_field_choice_new | ( | const char * | id, | |
| const char * | text, | |||
| int | default_value | |||
| ) |
Creates a multiple choice field.
This is often represented as a group of radio buttons.
| id | The field ID. | |
| text | The optional label of the field. | |
| default_value | The default choice. |
| void purple_request_field_choice_set_default_value | ( | PurpleRequestField * | field, | |
| int | default_value | |||
| ) |
Sets the default value in an choice field.
| field | The field. | |
| default_value | The default value. |
| void purple_request_field_choice_set_value | ( | PurpleRequestField * | field, | |
| int | value | |||
| ) |
Sets the value in an choice field.
| field | The field. | |
| value | The value. |
| void purple_request_field_destroy | ( | PurpleRequestField * | field | ) |
Destroys a field.
| field | The field to destroy. |
| const char* purple_request_field_get_id | ( | const PurpleRequestField * | field |