Class

PurpleRequestFieldChoice

unstable since: 3.0

Description [src]

final class Purple.RequestFieldChoice : Purple.RequestField
  implements Gio.ListModel {
  /* No available fields */
}

A choice request field which is often represented as a drop down or group of radio buttons.

This implements GListModel with an item type of BirbLocalizedString.

If you need to associate random data to the list items see g_object_set_data() and g_object_set_data_full().

Available since: 3.0

Implements

Constructors

purple_request_field_choice_new

Creates a multiple choice field.

unstable since: 3.0

Instance methods

purple_request_field_choice_add

Adds a choice to the field.

unstable since: 3.0

purple_request_field_choice_add_item

Adds a choice to the field.

unstable since: 3.0

purple_request_field_choice_clear

Removes all items from the choice.

unstable since: 3.0

purple_request_field_choice_get_selected

Gets the position of the selected item.

unstable since: 3.0

purple_request_field_choice_get_selected_item

Gets the item that is selected.

unstable since: 3.0

purple_request_field_choice_remove

Removes the item at the given position.

unstable since: 3.0

purple_request_field_choice_remove_by_id

Removes an item with the given id.

unstable since: 3.0

purple_request_field_choice_remove_item

Removes the given item.

unstable since: 3.0

purple_request_field_choice_set_selected

Selects the item at the given position.

unstable since: 3.0

purple_request_field_choice_take

Adds an item to the choices but takes ownership of it.

unstable since: 3.0

Methods inherited from PurpleRequestField (18)
purple_request_field_alphanumeric_validator

Validates a field which should contain alphanumeric content.

unstable since: 3.0

purple_request_field_email_validator

Validates a field which should contain an email address.

unstable since: 3.0

purple_request_field_get_id

Returns the ID of a field.

unstable since: 3.0

purple_request_field_get_label

Returns the label text of a field.

unstable since: 3.0

purple_request_field_get_tooltip

Returns the field’s tooltip.

unstable since: 3.0

purple_request_field_get_type_hint

Returns the field’s type hint.

unstable since: 3.0

purple_request_field_is_filled

Returns whether the field is currently filled.

unstable since: 3.0

purple_request_field_is_required

Returns whether or not a field is required.

unstable since: 3.0

purple_request_field_is_sensitive

Checks, if field is editable.

unstable since: 3.0

purple_request_field_is_valid

Checks, if specified field is valid.

unstable since: 3.0

purple_request_field_is_visible

Returns whether or not a field is visible.

unstable since: 3.0

purple_request_field_set_label

Sets the label text of a field.

unstable since: 3.0

purple_request_field_set_required

Sets whether or not a field is required.

unstable since: 3.0

purple_request_field_set_sensitive

Sets field editable.

unstable since: 3.0

purple_request_field_set_tooltip

Sets the tooltip for the field.

unstable since: 3.0

purple_request_field_set_type_hint

Sets the type hint for the field.

unstable since: 3.0

purple_request_field_set_validator

Set an additional validator for a field.

unstable since: 3.0

purple_request_field_set_visible

Sets whether or not a field is visible.

unstable since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GListModel (5)
g_list_model_get_item

Get the item at position.

g_list_model_get_item_type

Gets the type of the items in list.

g_list_model_get_n_items

Gets the number of items in list.

g_list_model_get_object

Get the item at position.

g_list_model_items_changed

Emits the GListModel::items-changed signal on list.

Properties

Purple.RequestFieldChoice:item-type

The type of items. See Gio.ListModelInterface.get_item_type.

unstable since: 3.0

Purple.RequestFieldChoice:n-items

The number of items. See Gio.ListModelInterface.get_n_items.

unstable since: 3.0

Purple.RequestFieldChoice:selected

The position of the currently selected item.

unstable since: 3.0

Purple.RequestFieldChoice:selected-item

The currently selected item.

unstable since: 3.0

Properties inherited from PurpleRequestField (9)
Purple.RequestField:filled

Whether the field has been filled.

unstable since: 3.0

Purple.RequestField:id

The ID of the field.

unstable since: 3.0

Purple.RequestField:label

The label of the field.

unstable since: 3.0

Purple.RequestField:required

Whether the field is required to complete the request.

unstable since: 3.0

Purple.RequestField:sensitive

Whether the field should be sensitive.

unstable since: 3.0

Purple.RequestField:tooltip

The tooltip of the field.

unstable since: 3.0

Purple.RequestField:type-hint

The type hint of the field.

unstable since: 3.0

Purple.RequestField:valid

Whether the field has a valid value.

unstable since: 3.0

Purple.RequestField:visible

Whether the field should be visible.

unstable since: 3.0

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Signals inherited from GListModel (1)
GListModel::items-changed

This signal is emitted whenever items were added to or removed from list. At position, removed items were removed and added items were added in their place.

Class structure

struct PurpleRequestFieldChoiceClass {
  PurpleRequestFieldClass parent_class;
  
}

No description available.

Class members
parent_class: PurpleRequestFieldClass

No description available.