Struct

PurpleRequestField

Description [src]

struct PurpleRequestField {
  /* No available fields */
}

A request field.

Functions

purple_request_field_account_new

Creates an account field.

purple_request_field_bool_new

Creates a boolean field.

purple_request_field_choice_new

Creates a multiple choice field.

purple_request_field_datasheet_new

Creates a datasheet item field.

purple_request_field_image_new

Creates an image field.

purple_request_field_int_new

Creates an integer field.

purple_request_field_label_new

Creates a label field.

purple_request_field_list_new

Creates a multiple list item field.

purple_request_field_new

Creates a field of the specified type.

purple_request_field_string_new

Creates a string request field.

Instance methods

purple_request_field_account_get_default_value

Returns the default account in an account field.

purple_request_field_account_get_filter

Returns the account filter function in an account field.

purple_request_field_account_get_show_all

Returns whether or not to show all accounts in an account field.

purple_request_field_account_get_value

Returns the user-entered account in an account field.

purple_request_field_account_set_default_value

Sets the default account on an account field.

purple_request_field_account_set_filter

Sets the account filter function in an account field.

purple_request_field_account_set_show_all

Sets whether or not to show all accounts in an account field.

purple_request_field_account_set_value

Sets the account in an account field.

purple_request_field_alphanumeric_validator

Validates a field which should contain alphanumeric content.

purple_request_field_bool_get_default_value

Returns the default value in an boolean field.

purple_request_field_bool_get_value

Returns the user-entered value in an boolean field.

purple_request_field_bool_set_default_value

Sets the default value in an boolean field.

purple_request_field_bool_set_value

Sets the value in an boolean field.

purple_request_field_choice_add

Adds a choice to a multiple choice field.

purple_request_field_choice_add_full

Adds a choice to a multiple choice field with destructor for value.

Available since: 3.0.0

purple_request_field_choice_get_default_value

Returns the default value in an choice field.

purple_request_field_choice_get_elements

Returns a list of elements in a choice field.

purple_request_field_choice_get_value

Returns the user-entered value in an choice field.

purple_request_field_choice_set_default_value

Sets the default value in an choice field.

purple_request_field_choice_set_value

Sets the value in an choice field.

purple_request_field_datasheet_get_sheet

Returns a datasheet for a field.

purple_request_field_destroy

Destroys a field.

purple_request_field_email_validator

Validates a field which should contain an email address.

purple_request_field_get_field_type

Returns the type of a field.

purple_request_field_get_field_type_hint

Returns the field’s type hint.

purple_request_field_get_group

Returns the group for the field.

purple_request_field_get_id

Returns the ID of a field.

purple_request_field_get_label

Returns the label text of a field.

purple_request_field_get_tooltip

Returns the field’s tooltip.

purple_request_field_get_ui_data

Returns the ui_data for a field.

purple_request_field_image_get_buffer

Returns pointer to the image.

purple_request_field_image_get_scale_x

Returns X scale coefficient of the image.

purple_request_field_image_get_scale_y

Returns Y scale coefficient of the image.

purple_request_field_image_get_size

Returns size (in bytes) of the image.

purple_request_field_image_set_scale

Sets the scale factors of an image field.

purple_request_field_int_get_default_value

Returns the default value in an integer field.

purple_request_field_int_get_lower_bound

Returns the lower bound in an integer field.

purple_request_field_int_get_upper_bound

Returns the upper bound in an integer field.

purple_request_field_int_get_value

Returns the user-entered value in an integer field.

purple_request_field_int_set_default_value

Sets the default value in an integer field.

purple_request_field_int_set_lower_bound

Sets the lower bound in an integer field.

purple_request_field_int_set_upper_bound

Sets the upper bound in an integer field.

purple_request_field_int_set_value

Sets the value in an integer field.

purple_request_field_is_filled

Checks, if specified field has value.

purple_request_field_is_required

Returns whether or not a field is required.

purple_request_field_is_sensitive

Checks, if field is editable.

purple_request_field_is_valid

Checks, if specified field is valid.

purple_request_field_is_validatable

Returns whether or not field has validator set.

purple_request_field_is_visible

Returns whether or not a field is visible.

purple_request_field_list_add_icon

Adds an item to a list field.

purple_request_field_list_add_selected

Adds a selected item to the list field.

purple_request_field_list_clear_selected

Clears the list of selected items in a list field.

purple_request_field_list_get_data

Returns the data for a particular item.

purple_request_field_list_get_items

Returns a list of items in a list field.

purple_request_field_list_get_multi_select

Returns whether or not a list field allows multiple selection.

purple_request_field_list_get_selected

Returns a list of selected items in a list field.

purple_request_field_list_has_icons

Indicates if list field has icons.

Available since: 3.0.0

purple_request_field_list_is_selected

Returns whether or not a particular item is selected in a list field.

purple_request_field_list_set_multi_select

Sets whether or not a list field allows multiple selection.

purple_request_field_list_set_selected

Sets a list of selected items in a list field.

purple_request_field_set_label

Sets the label text of a field.

purple_request_field_set_required

Sets whether or not a field is required.

purple_request_field_set_sensitive

Sets field editable.

purple_request_field_set_sensitivity_cb

Sets the callback, used to determine if the field should be editable.

purple_request_field_set_tooltip

Sets the tooltip for the field.

purple_request_field_set_type_hint

Sets the type hint for the field.

purple_request_field_set_ui_data

Sets the ui_data for a field.

purple_request_field_set_validator

Sets validator for a single field.

purple_request_field_set_visible

Sets whether or not a field is visible.

purple_request_field_string_get_default_value

Returns the default value in a string field.

purple_request_field_string_get_value

Returns the user-entered value in a string field.

purple_request_field_string_is_masked

Returns whether or not a string field is masked.

purple_request_field_string_is_multiline

Returns whether or not a string field is multi-line.

purple_request_field_string_set_default_value

Sets the default value in a string field.

purple_request_field_string_set_masked

Sets whether or not a string field is masked (commonly used for password fields).

purple_request_field_string_set_value

Sets the value in a string field.