EMailIdentityComboBox

EMailIdentityComboBox — Combo box of mail identities

Properties

gboolean allow-none Read / Write
ESourceRegistry * registry Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkComboBox
                        ╰── EMailIdentityComboBox

Implemented Interfaces

EMailIdentityComboBox implements AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

Includes

#include <e-util/e-util.h>

Description

EMailIdentity is a combo box of available mail identities, as described by ESource instances with an ESourceMailIdentity extension. For convenience, the combo box model's “id-column” is populated with ESource “uid” strings.

Functions

e_mail_identity_combo_box_new ()

GtkWidget *
e_mail_identity_combo_box_new (ESourceRegistry *registry);

Creates a new EMailIdentityComboBox widget using ESource instances in registry .

Parameters

registry

an ESourceRegistry

 

Returns

a new EMailIdentityComboBox


e_mail_identity_combo_box_refresh ()

void
e_mail_identity_combo_box_refresh (EMailIdentityComboBox *combo_box);

Rebuilds the combo box model with an updated list of ESource instances that describe a mail identity, without disrupting the previously active item (if possible).

This function is called automatically in response to ESourceRegistry signals which are pertinent to the combo_box .

Parameters

combo_box

an EMailIdentityComboBox

 

e_mail_identity_combo_box_get_registry ()

ESourceRegistry *
e_mail_identity_combo_box_get_registry
                               (EMailIdentityComboBox *combo_box);

Returns the ESourceRegistry passed to e_mail_identity_combo_box_new().

Parameters

combo_box

an EMailIdentityComboBox

 

Returns

an ESourceRegistry


e_mail_identity_combo_box_get_allow_none ()

gboolean
e_mail_identity_combo_box_get_allow_none
                               (EMailIdentityComboBox *combo_box);

Returns whether to append the mail identity list with a "None" item for use cases where the user may wish to opt out of choosing a mail identity.

Parameters

combo_box

an EMailIdentityComboBox

 

Returns

whether to include a "None" option


e_mail_identity_combo_box_set_allow_none ()

void
e_mail_identity_combo_box_set_allow_none
                               (EMailIdentityComboBox *combo_box,
                                gboolean allow_none);

Sets whether to append the mail identity list with a "None" item for use cases where the user may wish to opt out of choosing a mail identity.

Changing this property will automatically rebuild the combo box model.

Parameters

combo_box

an EMailIdentityComboBox

 

allow_none

whether to include a "None" option

 

e_mail_identity_combo_box_get_refreshing ()

gboolean
e_mail_identity_combo_box_get_refreshing
                               (EMailIdentityComboBox *combo_box);

Parameters

combo_box

an EMailIdentityComboBox

 

Returns

Whether the combo box content is currently refreshing.

Since: 3.16

Types and Values

struct EMailIdentityComboBox

struct EMailIdentityComboBox;

Contains only private data that should be read and manipulated using the functions below.

Property Details

The “allow-none” property

  “allow-none”               gboolean

Flags: Read / Write

Default value: FALSE


The “registry” property

  “registry”                 ESourceRegistry *

Flags: Read / Write / Construct Only