Struct

PurpleAccountOption

Description [src]

struct PurpleAccountOption {
  /* No available fields */
}

An option for an account.

This is set by protocols, and appears in the account settings dialogs.

Constructors

purple_account_option_bool_new

Creates a new boolean account option.

purple_account_option_int_new

Creates a new integer account option.

purple_account_option_list_new

Creates a new list account option.

purple_account_option_new

Creates a new account option. If you know what a type will be in advance, consider using purple_account_option_bool_new(), purple_account_option_int_new(), purple_account_option_string_new() or purple_account_option_list_new() (as appropriate) instead.

purple_account_option_string_new

Creates a new string account option.

Instance methods

purple_account_option_add_list_item

Adds an item to a list account option.

purple_account_option_copy

Creates a newly allocated copy of option.

Available since: 3.0.0

purple_account_option_destroy

Destroys an account option.

purple_account_option_get_default_bool

Returns the default boolean value for an account option.

purple_account_option_get_default_int

Returns the default integer value for an account option.

purple_account_option_get_default_list_value

Returns the default string value for a list account option.

purple_account_option_get_default_string

Returns the default string value for an account option.

purple_account_option_get_list

Returns the list values for an account option.

purple_account_option_get_pref_type

Returns the specified account option’s type.

purple_account_option_get_setting

Returns the name of an account option. This corresponds to the c pref_name parameter supplied to purple_account_option_new() or one of the type-specific constructors.

purple_account_option_get_text

Returns the text for an account option.

purple_account_option_set_default_bool

Sets the default boolean value for an account option.

purple_account_option_set_default_int

Sets the default integer value for an account option.

purple_account_option_set_default_string

Sets the default string value for an account option.

purple_account_option_set_list

Sets the list values for an account option.

purple_account_option_string_get_hints

Returns the list of hints for an account option.

purple_account_option_string_get_masked

Returns whether an option’s value should be masked from view, like a password. If so, the UI might display each character of the option as a ‘*’ (for example).

purple_account_option_string_set_hints

Sets the hint list for an account option.

purple_account_option_string_set_masked

Sets the masking for an account option. Setting this to TRUE acts as a hint to the UI that the option’s value should be obscured from view, like a password.