#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 | GaimRequestFields |
Multiple fields request data. More... | |
struct | GaimRequestFieldGroup |
A group of fields with a title. More... | |
struct | GaimRequestField |
A request field. More... | |
struct | GaimRequestUiOps |
Request UI operations. More... | |
Request API | |
#define | gaim_request_yes_no(handle, title, primary, secondary, default_action, user_data, yes_cb, no_cb) |
A wrapper for gaim_request_action() that uses Yes and No buttons. | |
#define | gaim_request_ok_cancel(handle, title, primary, secondary, default_action, user_data, ok_cb, cancel_cb) |
A wrapper for gaim_request_action() that uses OK and Cancel buttons. | |
#define | gaim_request_accept_cancel(handle, title, primary, secondary, default_action, user_data, accept_cb, cancel_cb) |
A wrapper for gaim_request_action() that uses Accept and Cancel buttons. | |
void * | gaim_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, void *user_data) |
Prompts the user for text input. | |
void * | gaim_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, void *user_data, size_t choice_count,...) |
Prompts the user for multiple-choice input. | |
void * | gaim_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, void *user_data, size_t choice_count, va_list choices) |
Prompts the user for multiple-choice input. | |
void * | gaim_request_action (void *handle, const char *title, const char *primary, const char *secondary, unsigned int default_action, void *user_data, size_t action_count,...) |
Prompts the user for an action. | |
void * | gaim_request_action_varg (void *handle, const char *title, const char *primary, const char *secondary, unsigned int default_action, void *user_data, size_t action_count, va_list actions) |
Prompts the user for an action. | |
void * | gaim_request_fields (void *handle, const char *title, const char *primary, const char *secondary, GaimRequestFields *fields, const char *ok_text, GCallback ok_cb, const char *cancel_text, GCallback cancel_cb, void *user_data) |
Displays groups of fields for the user to fill in. | |
void | gaim_request_close (GaimRequestType type, void *uihandle) |
Closes a request. | |
void | gaim_request_close_with_handle (void *handle) |
Closes all requests registered with the specified handle. | |
void * | gaim_request_file (void *handle, const char *title, const char *filename, gboolean savedialog, GCallback ok_cb, GCallback cancel_cb, void *user_data) |
Displays a file selector request dialog. | |
Defines | |
#define | GAIM_DEFAULT_ACTION_NONE -1 |
Typedefs | |
typedef void(*) | GaimRequestInputCb (void *, const char *) |
typedef void(*) | GaimRequestActionCb (void *, int) |
typedef void(*) | GaimRequestFieldsCb (void *, GaimRequestFields *fields) |
typedef void(*) | GaimRequestFileCb (void *, const char *filename) |
Enumerations | |
enum | GaimRequestType { GAIM_REQUEST_INPUT = 0, GAIM_REQUEST_CHOICE, GAIM_REQUEST_ACTION, GAIM_REQUEST_FIELDS, GAIM_REQUEST_FILE } |
Request types. More... | |
enum | GaimRequestFieldType { GAIM_REQUEST_FIELD_NONE, GAIM_REQUEST_FIELD_STRING, GAIM_REQUEST_FIELD_INTEGER, GAIM_REQUEST_FIELD_BOOLEAN, GAIM_REQUEST_FIELD_CHOICE, GAIM_REQUEST_FIELD_LIST, GAIM_REQUEST_FIELD_LABEL, GAIM_REQUEST_FIELD_ACCOUNT } |
A type of field. | |
Functions | |
Field List API | |
GaimRequestFields * | gaim_request_fields_new (void) |
Creates a list of fields to pass to gaim_request_fields(). | |
void | gaim_request_fields_destroy (GaimRequestFields *fields) |
Destroys a list of fields. | |
void | gaim_request_fields_add_group (GaimRequestFields *fields, GaimRequestFieldGroup *group) |
Adds a group of fields to the list. | |
GList * | gaim_request_fields_get_groups (const GaimRequestFields *fields) |
Returns a list of all groups in a field list. | |
gboolean | gaim_request_fields_exists (const GaimRequestFields *fields, const char *id) |
Returns whether or not the field with the specified ID exists. | |
const GList * | gaim_request_fields_get_required (const GaimRequestFields *fields) |
Returns a list of all required fields. | |
gboolean | gaim_request_fields_is_field_required (const GaimRequestFields *fields, const char *id) |
Returns whether or not a field with the specified ID is required. | |
gboolean | gaim_request_fields_all_required_filled (const GaimRequestFields *fields) |
Returns whether or not all required fields have values. | |
GaimRequestField * | gaim_request_fields_get_field (const GaimRequestFields *fields, const char *id) |
Return the field with the specified ID. | |
const char * | gaim_request_fields_get_string (const GaimRequestFields *fields, const char *id) |
Returns the string value of a field with the specified ID. | |
int | gaim_request_fields_get_integer (const GaimRequestFields *fields, const char *id) |
Returns the integer value of a field with the specified ID. | |
gboolean | gaim_request_fields_get_bool (const GaimRequestFields *fields, const char *id) |
Returns the boolean value of a field with the specified ID. | |
int | gaim_request_fields_get_choice (const GaimRequestFields *fields, const char *id) |
Returns the choice index of a field with the specified ID. | |
GaimAccount * | gaim_request_fields_get_account (const GaimRequestFields *fields, const char *id) |
Returns the account of a field with the specified ID. | |
Fields Group API | |
GaimRequestFieldGroup * | gaim_request_field_group_new (const char *title) |
Creates a fields group with an optional title. | |
void | gaim_request_field_group_destroy (GaimRequestFieldGroup *group) |
Destroys a fields group. | |
void | gaim_request_field_group_add_field (GaimRequestFieldGroup *group, GaimRequestField *field) |
Adds a field to the group. | |
const char * | gaim_request_field_group_get_title (const GaimRequestFieldGroup *group) |
Returns the title of a fields group. | |
GList * | gaim_request_field_group_get_fields (const GaimRequestFieldGroup *group) |
Returns a list of all fields in a group. | |
Field API | |
GaimRequestField * | gaim_request_field_new (const char *id, const char *text, GaimRequestFieldType type) |
Creates a field of the specified type. | |
void | gaim_request_field_destroy (GaimRequestField *field) |
Destroys a field. | |
void | gaim_request_field_set_label (GaimRequestField *field, const char *label) |
Sets the label text of a field. | |
void | gaim_request_field_set_visible (GaimRequestField *field, gboolean visible) |
Sets whether or not a field is visible. | |
void | gaim_request_field_set_type_hint (GaimRequestField *field, const char *type_hint) |
Sets the type hint for the field. | |
void | gaim_request_field_set_required (GaimRequestField *field, gboolean required) |
Sets whether or not a field is required. | |
GaimRequestFieldType | gaim_request_field_get_type (const GaimRequestField *field) |
Returns the type of a field. | |
const char * | gaim_request_field_get_id (const GaimRequestField *field) |
Returns the ID of a field. | |
const char * | gaim_request_field_get_label (const GaimRequestField *field) |
Returns the label text of a field. | |
gboolean | gaim_request_field_is_visible (const GaimRequestField *field) |
Returns whether or not a field is visible. | |
const char * | gaim_request_field_get_type_hint (const GaimRequestField *field) |
Returns the field's type hint. | |
gboolean | gaim_request_field_is_required (const GaimRequestField *field) |
Returns whether or not a field is required. | |
String Field API | |
GaimRequestField * | gaim_request_field_string_new (const char *id, const char *text, const char *default_value, gboolean multiline) |
Creates a string request field. | |
void | gaim_request_field_string_set_default_value (GaimRequestField *field, const char *default_value) |
Sets the default value in a string field. | |
void | gaim_request_field_string_set_value (GaimRequestField *field, const char *value) |
Sets the value in a string field. | |
void | gaim_request_field_string_set_masked (GaimRequestField *field, gboolean masked) |
Sets whether or not a string field is masked (commonly used for password fields). | |
void | gaim_request_field_string_set_editable (GaimRequestField *field, gboolean editable) |
Sets whether or not a string field is editable. | |
const char * | gaim_request_field_string_get_default_value (const GaimRequestField *field) |
Returns the default value in a string field. | |
const char * | gaim_request_field_string_get_value (const GaimRequestField *field) |
Returns the user-entered value in a string field. | |
gboolean | gaim_request_field_string_is_multiline (const GaimRequestField *field) |
Returns whether or not a string field is multi-line. | |
gboolean | gaim_request_field_string_is_masked (const GaimRequestField *field) |
Returns whether or not a string field is masked. | |
gboolean | gaim_request_field_string_is_editable (const GaimRequestField *field) |
Returns whether or not a string field is editable. | |
Integer Field API | |
GaimRequestField * | gaim_request_field_int_new (const char *id, const char *text, int default_value) |
Creates an integer field. | |
void | gaim_request_field_int_set_default_value (GaimRequestField *field, int default_value) |
Sets the default value in an integer field. | |
void | gaim_request_field_int_set_value (GaimRequestField *field, int value) |
Sets the value in an integer field. | |
int | gaim_request_field_int_get_default_value (const GaimRequestField *field) |
Returns the default value in an integer field. | |
int | gaim_request_field_int_get_value (const GaimRequestField *field) |
Returns the user-entered value in an integer field. | |
Boolean Field API | |
GaimRequestField * | gaim_request_field_bool_new (const char *id, const char *text, gboolean default_value) |
Creates a boolean field. | |
void | gaim_request_field_bool_set_default_value (GaimRequestField *field, gboolean default_value) |
Sets the default value in an boolean field. | |
void | gaim_request_field_bool_set_value (GaimRequestField *field, gboolean value) |
Sets the value in an boolean field. | |
gboolean | gaim_request_field_bool_get_default_value (const GaimRequestField *field) |
Returns the default value in an boolean field. | |
gboolean | gaim_request_field_bool_get_value (const GaimRequestField *field) |
Returns the user-entered value in an boolean field. | |
Choice Field API | |
GaimRequestField * | gaim_request_field_choice_new (const char *id, const char *text, int default_value) |
Creates a multiple choice field. | |
void | gaim_request_field_choice_add (GaimRequestField *field, const char *label) |
Adds a choice to a multiple choice field. | |
void | gaim_request_field_choice_set_default_value (GaimRequestField *field, int default_value) |
Sets the default value in an choice field. | |
void | gaim_request_field_choice_set_value (GaimRequestField *field, int value) |
Sets the value in an choice field. | |
int | gaim_request_field_choice_get_default_value (const GaimRequestField *field) |
Returns the default value in an choice field. | |
int | gaim_request_field_choice_get_value (const GaimRequestField *field) |
Returns the user-entered value in an choice field. | |
GList * | gaim_request_field_choice_get_labels (const GaimRequestField *field) |
Returns a list of labels in a choice field. | |
List Field API | |
GaimRequestField * | gaim_request_field_list_new (const char *id, const char *text) |
Creates a multiple list item field. | |
void | gaim_request_field_list_set_multi_select (GaimRequestField *field, gboolean multi_select) |
Sets whether or not a list field allows multiple selection. | |
gboolean | gaim_request_field_list_get_multi_select (const GaimRequestField *field) |
Returns whether or not a list field allows multiple selection. | |
void * | gaim_request_field_list_get_data (const GaimRequestField *field, const char *text) |
Returns the data for a particular item. | |
void | gaim_request_field_list_add (GaimRequestField *field, const char *item, void *data) |
Adds an item to a list field. | |
void | gaim_request_field_list_add_selected (GaimRequestField *field, const char *item) |
Adds a selected item to the list field. | |
void | gaim_request_field_list_clear_selected (GaimRequestField *field) |
Clears the list of selected items in a list field. | |
void | gaim_request_field_list_set_selected (GaimRequestField *field, GList *items) |
Sets a list of selected items in a list field. | |
gboolean | gaim_request_field_list_is_selected (const GaimRequestField *field, const char *item) |
Returns whether or not a particular item is selected in a list field. | |
const GList * | gaim_request_field_list_get_selected (const GaimRequestField *field) |
Returns a list of selected items in a list field. | |
const GList * | gaim_request_field_list_get_items (const GaimRequestField *field) |
Returns a list of items in a list field. | |
Label Field API | |
GaimRequestField * | gaim_request_field_label_new (const char *id, const char *text) |
Creates a label field. | |
Account Field API | |
GaimRequestField * | gaim_request_field_account_new (const char *id, const char *text, GaimAccount *account) |
Creates an account field. | |
void | gaim_request_field_account_set_default_value (GaimRequestField *field, GaimAccount *default_value) |
Sets the default account on an account field. | |
void | gaim_request_field_account_set_value (GaimRequestField *field, GaimAccount *value) |
Sets the account in an account field. | |
void | gaim_request_field_account_set_show_all (GaimRequestField *field, gboolean show_all) |
Sets whether or not to show all accounts in an account field. | |
void | gaim_request_field_account_set_filter (GaimRequestField *field, GaimFilterAccountFunc filter_func) |
Sets the account filter function in an account field. | |
GaimAccount * | gaim_request_field_account_get_default_value (const GaimRequestField *field) |
Returns the default account in an account field. | |
GaimAccount * | gaim_request_field_account_get_value (const GaimRequestField *field) |
Returns the user-entered account in an account field. | |
gboolean | gaim_request_field_account_get_show_all (const GaimRequestField *field) |
Returns whether or not to show all accounts in an account field. | |
GaimFilterAccountFunc | gaim_request_field_account_get_filter (const GaimRequestField *field) |
Returns the account filter function in an account field. | |
UI Operations API | |
void | gaim_request_set_ui_ops (GaimRequestUiOps *ops) |
Sets the UI operations structure to be used when displaying a request. | |
GaimRequestUiOps * | gaim_request_get_ui_ops (void) |
Returns the UI operations structure to be used when displaying a request. |
gaim
Gaim 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
#define gaim_request_accept_cancel | ( | handle, | |||
title, | |||||
primary, | |||||
secondary, | |||||
default_action, | |||||
user_data, | |||||
accept_cb, | |||||
cancel_cb | ) |
Value:
gaim_request_action((handle), (title), (primary), (secondary), \ (default_action), (user_data), 2, \ _("Accept"), (accept_cb), _("Cancel"), (cancel_cb))
#define gaim_request_ok_cancel | ( | handle, | |||
title, | |||||
primary, | |||||
secondary, | |||||
default_action, | |||||
user_data, | |||||
ok_cb, | |||||
cancel_cb | ) |
Value:
gaim_request_action((handle), (title), (primary), (secondary), \ (default_action), (user_data), 2, \ _("OK"), (ok_cb), _("Cancel"), (cancel_cb))
#define gaim_request_yes_no | ( | handle, | |||
title, | |||||
primary, | |||||
secondary, | |||||
default_action, | |||||
user_data, | |||||
yes_cb, | |||||
no_cb | ) |
Value:
gaim_request_action((handle), (title), (primary), (secondary), \ (default_action), (user_data), 2, \ _("Yes"), (yes_cb), _("No"), (no_cb))
enum GaimRequestType |
void* gaim_request_action | ( | void * | handle, | |
const char * | title, | |||
const char * | primary, | |||
const char * | secondary, | |||
unsigned int | default_action, | |||
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. | |
title | The title of the message. | |
primary | The main point of the message. | |
secondary | The secondary information. | |
default_action | The default value. | |
user_data | The data to pass to the callback. | |
action_count | The number of actions. | |
... | A list of actions. |
void* gaim_request_action_varg | ( | void * | handle, | |
const char * | title, | |||
const char * | primary, | |||
const char * | secondary, | |||
unsigned int | default_action, | |||
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. | |
title | The title of the message. | |
primary | The main point of the message. | |
secondary | The secondary information. | |
default_action | The default value. | |
user_data | The data to pass to the callback. | |
action_count | The number of actions. | |
actions | A list of actions and callbacks. |
void* gaim_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, | |||
void * | user_data, | |||
size_t | choice_count, | |||
... | ||||
) |
Prompts the user for multiple-choice input.
handle | The plugin or connection handle. | |
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. | |
user_data | The data to pass to the callback. | |
choice_count | The number of choices. | |
... | The choices. |
void* gaim_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, | |||
void * | user_data, | |||
size_t | choice_count, | |||
va_list | choices | |||
) |
Prompts the user for multiple-choice input.
handle | The plugin or connection handle. | |
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. | |
user_data | The data to pass to the callback. | |
choice_count | The number of choices. | |
choices | The choices. |
void gaim_request_close | ( | GaimRequestType | type, | |
void * | uihandle | |||
) |
Closes a request.
type | The request type. | |
uihandle | The request UI handle. |
void gaim_request_close_with_handle | ( | void * | handle | ) |
Closes all requests registered with the specified handle.
handle | The handle. |
GaimAccount* gaim_request_field_account_get_default_value | ( | const GaimRequestField * | field | ) |
Returns the default account in an account field.
field | The field. |
GaimFilterAccountFunc gaim_request_field_account_get_filter | ( | const GaimRequestField * | 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 gaim_request_field_account_get_show_all | ( | const GaimRequestField * | 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. |
GaimAccount* gaim_request_field_account_get_value | ( | const GaimRequestField * | field | ) |
Returns the user-entered account in an account field.
field | The field. |
GaimRequestField* gaim_request_field_account_new | ( | const char * | id, | |
const char * | text, | |||
GaimAccount * | 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 gaim_request_field_account_set_default_value | ( | GaimRequestField * | field, | |
GaimAccount * | default_value | |||
) |
Sets the default account on an account field.
field | The account field. | |
default_value | The default account. |
void gaim_request_field_account_set_filter | ( | GaimRequestField * | field, | |
GaimFilterAccountFunc | 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 gaim_request_field_account_set_show_all | ( | GaimRequestField * | 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 gaim_request_field_account_set_value | ( | GaimRequestField * | field, | |
GaimAccount * | value | |||
) |
Sets the account in an account field.
field | The account field. | |
value | The account. |
gboolean gaim_request_field_bool_get_default_value | ( | const GaimRequestField * | field | ) |
Returns the default value in an boolean field.
field | The field. |
gboolean gaim_request_field_bool_get_value | ( | const GaimRequestField * | field | ) |
Returns the user-entered value in an boolean field.
field | The field. |
GaimRequestField* gaim_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 gaim_request_field_bool_set_default_value | ( | GaimRequestField * | field, | |
gboolean | default_value | |||
) |
Sets the default value in an boolean field.
field | The field. | |
default_value | The default value. |
void gaim_request_field_bool_set_value | ( | GaimRequestField * | field, | |
gboolean | value | |||
) |
Sets the value in an boolean field.
field | The field. | |
value | The value. |
void gaim_request_field_choice_add | ( | GaimRequestField * | field, | |
const char * | label | |||
) |
Adds a choice to a multiple choice field.
field | The choice field. | |
label | The choice label. |
int gaim_request_field_choice_get_default_value | ( | const GaimRequestField * | field | ) |
Returns the default value in an choice field.
field | The field. |
GList* gaim_request_field_choice_get_labels | ( | const GaimRequestField * | field | ) |
Returns a list of labels in a choice field.
field | The field. |
int gaim_request_field_choice_get_value | ( | const GaimRequestField * | field | ) |
Returns the user-entered value in an choice field.
field | The field. |
GaimRequestField* gaim_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 gaim_request_field_choice_set_default_value | ( | GaimRequestField * | field, | |
int | default_value | |||
) |
Sets the default value in an choice field.
field | The field. | |
default_value | The default value. |
void gaim_request_field_choice_set_value | ( | GaimRequestField * | field, | |
int | value | |||
) |
Sets the value in an choice field.
field | The field. | |
value | The value. |
void gaim_request_field_destroy | ( | GaimRequestField * | field | ) |
Destroys a field.
field | The field to destroy. |
const char* gaim_request_field_get_id | ( | const GaimRequestField * | field | ) |
Returns the ID of a field.
field | The field. |
const char* gaim_request_field_get_label | ( | const GaimRequestField * | field | ) |
Returns the label text of a field.
field | The field. |
GaimRequestFieldType gaim_request_field_get_type | ( | const GaimRequestField * | field | ) |
Returns the type of a field.
field | The field. |
const char* gaim_request_field_get_type_hint | ( | const GaimRequestField * | field | ) |
Returns the field's type hint.
field | The field. |
void gaim_request_field_group_add_field | ( | GaimRequestFieldGroup * | group, | |
GaimRequestField * | field | |||
) |
Adds a field to the group.
group | The group to add the field to. | |
field | The field to add to the group. |
void gaim_request_field_group_destroy | ( | GaimRequestFieldGroup * | group | ) |
Destroys a fields group.
group | The group to destroy. |
GList* gaim_request_field_group_get_fields | ( | const GaimRequestFieldGroup * | group | ) |
Returns a list of all fields in a group.
group | The group. |
const char* gaim_request_field_group_get_title | ( | const GaimRequestFieldGroup * | group | ) |
Returns the title of a fields group.
group | The group. |
GaimRequestFieldGroup* gaim_request_field_group_new | ( | const char * | title | ) |
Creates a fields group with an optional title.
title | The optional title to give the group. |
int gaim_request_field_int_get_default_value | ( | const GaimRequestField * | field | ) |
Returns the default value in an integer field.
field | The field. |
int gaim_request_field_int_get_value | ( | const GaimRequestField * | field | ) |
Returns the user-entered value in an integer field.
field | The field. |
GaimRequestField* gaim_request_field_int_new | ( | const char * | id, | |
const char * | text, | |||
int | default_value | |||
) |
Creates an integer field.
id | The field ID. | |
text | The text label of the field. | |
default_value | The default value. |
void gaim_request_field_int_set_default_value | ( | GaimRequestField * | field, | |
int | default_value | |||
) |
Sets the default value in an integer field.
field | The field. | |
default_value | The default value. |
void gaim_request_field_int_set_value | ( | GaimRequestField * | field, | |
int | value | |||
) |
Sets the value in an integer field.
field | The field. | |
value | The value. |
gboolean gaim_request_field_is_required | ( | const GaimRequestField * | field | ) |
Returns whether or not a field is required.
field | The field. |
gboolean gaim_request_field_is_visible | ( | const GaimRequestField * | field | ) |
Returns whether or not a field is visible.
field | The field. |
GaimRequestField* gaim_request_field_label_new | ( | const char * | id, | |
const char * | text | |||
) |
Creates a label field.
id | The field ID. | |
text | The label of the field. |
void gaim_request_field_list_add | ( | GaimRequestField * | field, | |
const char * | item, | |||
void * | data | |||
) |
Adds an item to a list field.
field | The list field. | |
item | The list item. | |
data | The associated data. |
void gaim_request_field_list_add_selected | ( | GaimRequestField * | field, | |
const char * | item | |||
) |
Adds a selected item to the list field.
field | The field. | |
item | The item to add. |
void gaim_request_field_list_clear_selected | ( | GaimRequestField * | field | ) |
Clears the list of selected items in a list field.
field | The field. |
void* gaim_request_field_list_get_data | ( | const GaimRequestField * | field, | |
const char * | text | |||
) |
Returns the data for a particular item.
field | The list field. | |
text | The item text. |
const GList* gaim_request_field_list_get_items | ( | const GaimRequestField * | field | ) |
Returns a list of items in a list field.
field | The field. |
gboolean gaim_request_field_list_get_multi_select | ( | const GaimRequestField * | field | ) |
Returns whether or not a list field allows multiple selection.
field | The list field. |
const GList* gaim_request_field_list_get_selected | ( | const GaimRequestField * | field | ) |
Returns a list of selected items in a list field.
To retrieve the data for each item, use gaim_request_field_list_get_data().
field | The field. |
gboolean gaim_request_field_list_is_selected | ( | const GaimRequestField * | field, | |
const char * | item | |||
) |
Returns whether or not a particular item is selected in a list field.
field | The field. | |
item | The item. |
GaimRequestField* gaim_request_field_list_new | ( | const char * | id, | |
const char * | text | |||
) |
Creates a multiple list item field.
id | The field ID. | |
text | The optional label of the field. |
void gaim_request_field_list_set_multi_select | ( | GaimRequestField * | field, | |
gboolean | multi_select | |||
) |
Sets whether or not a list field allows multiple selection.
field | The list field. | |
multi_select | TRUE if multiple selection is enabled, or FALSE otherwise. |
void gaim_request_field_list_set_selected | ( | GaimRequestField * | field, | |
GList * | items | |||
) |
Sets a list of selected items in a list field.
field | The field. | |
items | The list of selected items. |
GaimRequestField* gaim_request_field_new | ( | const char * | id, | |
const char * | text, | |||
GaimRequestFieldType | type | |||
) |
Creates a field of the specified type.
id | The field ID. | |
text | The text label of the field. | |
type | The type of field. |
void gaim_request_field_set_label | ( | GaimRequestField * | field, | |
const char * | label | |||
) |
Sets the label text of a field.
field | The field. | |
label | The text label. |
void gaim_request_field_set_required | ( | GaimRequestField * | field, | |
gboolean | required | |||
) |
Sets whether or not a field is required.
field | The field. | |
required | TRUE if required, or FALSE. |
void gaim_request_field_set_type_hint | ( | GaimRequestField * | field, | |
const char * | type_hint | |||
) |
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 "screenname."
field | The field. | |
type_hint | The type hint. |
void gaim_request_field_set_visible | ( | GaimRequestField * | field, | |
gboolean | visible | |||
) |
Sets whether or not a field is visible.
field | The field. | |
visible | TRUE if visible, or FALSE if not. |
const char* gaim_request_field_string_get_default_value | ( | const GaimRequestField * | field | ) |
Returns the default value in a string field.
field | The field. |
const char* gaim_request_field_string_get_value | ( | const GaimRequestField * | field | ) |
Returns the user-entered value in a string field.
field | The field. |
gboolean gaim_request_field_string_is_editable | ( | const GaimRequestField * | field | ) |
Returns whether or not a string field is editable.
field | The field. |
TRUE
if the field is editable, or FALSE
otherwise. gboolean gaim_request_field_string_is_masked | ( | const GaimRequestField * | field | ) |
Returns whether or not a string field is masked.
field | The field. |
TRUE
if the field is masked, or FALSE
otherwise. gboolean gaim_request_field_string_is_multiline | ( | const GaimRequestField * | field | ) |
Returns whether or not a string field is multi-line.
field | The field. |
TRUE
if the field is mulit-line, or FALSE
otherwise. GaimRequestField* gaim_request_field_string_new | ( | const char * | id, | |
const char * | text, | |||
const char * | default_value, | |||
gboolean | multiline | |||
) |
Creates a string request field.
id | The field ID. | |
text | The text label of the field. | |
default_value | The optional default value. | |
multiline | Whether or not this should be a multiline string. |
void gaim_request_field_string_set_default_value | ( | GaimRequestField * | field, | |
const char * | default_value | |||
) |
Sets the default value in a string field.
field | The field. | |
default_value | The default value. |
void gaim_request_field_string_set_editable | ( | GaimRequestField * | field, | |
gboolean | editable | |||
) |
Sets whether or not a string field is editable.
field | The field. | |
editable | The editable value. |
void gaim_request_field_string_set_masked | ( | GaimRequestField * | field, | |
gboolean | masked | |||
) |
Sets whether or not a string field is masked (commonly used for password fields).
field | The field. | |
masked | The masked value. |
void gaim_request_field_string_set_value | ( | GaimRequestField * | field, | |
const char * | value | |||
) |
Sets the value in a string field.
field | The field. | |
value | The value. |
void* gaim_request_fields | ( | void * | handle, | |
const char * | title, | |||
const char * | primary, | |||
const char * | secondary, | |||
GaimRequestFields * | fields, | |||
const char * | ok_text, | |||
GCallback | ok_cb, | |||
const char * | cancel_text, | |||
GCallback | cancel_cb, | |||
void * | user_data | |||
) |
Displays groups of fields for the user to fill in.
handle | The plugin or connection handle. | |
title | The title of the message. | |
primary | The main point of the message. | |
secondary | The secondary information. | |
fields | The list of fields. | |
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. | |
user_data | The data to pass to the callback. |
void gaim_request_fields_add_group | ( | GaimRequestFields * | fields, | |
GaimRequestFieldGroup * | group | |||
) |
Adds a group of fields to the list.
fields | The fields list. | |
group | The group to add. |
gboolean gaim_request_fields_all_required_filled | ( | const GaimRequestFields * | fields | ) |
Returns whether or not all required fields have values.
fields | The fields list. |
void gaim_request_fields_destroy | ( | GaimRequestFields * | fields | ) |
Destroys a list of fields.
fields | The list of fields to destroy. |
gboolean gaim_request_fields_exists | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns whether or not the field with the specified ID exists.
fields | The fields list. | |
id | The ID of the field. |
GaimAccount* gaim_request_fields_get_account | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns the account of a field with the specified ID.
fields | The fields list. | |
id | The ID of the field. |
gboolean gaim_request_fields_get_bool | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns the boolean value of a field with the specified ID.
fields | The fields list. | |
id | The ID of the field. |
FALSE
otherwise. int gaim_request_fields_get_choice | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns the choice index of a field with the specified ID.
fields | The fields list. | |
id | The ID of the field. |
GaimRequestField* gaim_request_fields_get_field | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Return the field with the specified ID.
fields | The fields list. | |
id | The ID of the field. |
GList* gaim_request_fields_get_groups | ( | const GaimRequestFields * | fields | ) |
Returns a list of all groups in a field list.
fields | The fields list. |
int gaim_request_fields_get_integer | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns the integer value of a field with the specified ID.
fields | The fields list. | |
id | The ID of the field. |
const GList* gaim_request_fields_get_required | ( | const GaimRequestFields * | fields | ) |
Returns a list of all required fields.
fields | The fields list. |
const char* gaim_request_fields_get_string | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns the string value of a field with the specified ID.
fields | The fields list. | |
id | The ID of the field. |
NULL
otherwise. gboolean gaim_request_fields_is_field_required | ( | const GaimRequestFields * | fields, | |
const char * | id | |||
) |
Returns whether or not a field with the specified ID is required.
fields | The fields list. | |
id | The field ID. |
GaimRequestFields* gaim_request_fields_new | ( | void | ) |
void* gaim_request_file | ( | void * | handle, | |
const char * | title, | |||
const char * | filename, | |||
gboolean | savedialog, | |||
GCallback | ok_cb, | |||
GCallback | cancel_cb, | |||
void * | user_data | |||
) |
Displays a file selector request dialog.
Returns the selected filename into the callback. Can be used for either opening a file or saving a file.
handle | The plugin or connection handle. | |
title | The title for the dialog (may be NULL) | |
filename | The default filename (may be NULL) | |
savedialog | True if this dialog is being used to save a file. False if it is being used to open a file. | |
ok_cb | The callback for the OK button. | |
cancel_cb | The callback for the cancel button. | |
user_data | The data to pass to the callback. |
GaimRequestUiOps* gaim_request_get_ui_ops | ( | void | ) |
Returns the UI operations structure to be used when displaying a request.
void* gaim_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, | |||
void * | user_data | |||
) |
Prompts the user for text input.
handle | The plugin or connection handle. | |
title | The title of the message. | |
primary | The main point of the message. | |
secondary | The secondary information. | |
default_value | The default value. | |
multiline | TRUE if the inputted text can span multiple lines. | |
masked | TRUE if the inputted text should be masked in some way. | |
hint | Optionally suggest how the input box should appear. Use "html," for example, to allow the user to enter HTML. | |
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. | |
user_data | The data to pass to the callback. |
void gaim_request_set_ui_ops | ( | GaimRequestUiOps * | ops | ) |
Sets the UI operations structure to be used when displaying a request.
ops | The UI operations structure. |