| Evolution-Data-Server Manual: Utilities (libedataserver) | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
EAccountList; enum e_account_find_t; EAccountList * e_account_list_new (GConfClient *gconf); void e_account_list_construct (EAccountList *account_list,GConfClient *gconf); void e_account_list_save (EAccountList *account_list); void e_account_list_add (EAccountList *Param1,EAccount *Param2); void e_account_list_change (EAccountList *Param1,EAccount *Param2); void e_account_list_remove (EAccountList *Param1,EAccount *Param2); const EAccount * e_account_list_get_default (EAccountList *Param1); void e_account_list_set_default (EAccountList *Param1,EAccount *Param2); const EAccount * e_account_list_find (EAccountList *Param1,e_account_find_t type,const gchar *key); void e_account_list_prune_proxies (EAccountList *Param1); void e_account_list_remove_account_proxies (EAccountList *Param1,EAccount *Param2); gint e_account_list_account_has_proxies (EAccountList *Param1,EAccount *Param2);
typedef enum _e_account_find_t {
E_ACCOUNT_FIND_NAME,
E_ACCOUNT_FIND_UID,
E_ACCOUNT_FIND_ID_NAME,
E_ACCOUNT_FIND_ID_ADDRESS,
E_ACCOUNT_FIND_PARENT_UID
} e_account_find_t;
EAccountList * e_account_list_new (GConfClient *gconf);
Reads the list of accounts from gconf and listens for changes.
Will emit account_added, account_changed, and account_removed
signals according to notifications from GConf.
You can modify the list using e_list_append(), e_list_remove(), and
e_iterator_delete(). After adding, removing, or changing accounts,
you must call e_account_list_save() to push the changes back to
GConf.
|
a GConfClient |
Returns : |
the list of accounts |
void e_account_list_construct (EAccountList *account_list,GConfClient *gconf);
|
|
|
void e_account_list_save (EAccountList *account_list);
Saves account_list to GConf. Signals will be emitted for changes.
|
an EAccountList |
void e_account_list_add (EAccountList *Param1,EAccount *Param2);
Add an account to the account list. Will emit the account-changed event.
|
|
|
void e_account_list_change (EAccountList *Param1,EAccount *Param2);
Signal that the details of an account have changed.
|
|
|
void e_account_list_remove (EAccountList *Param1,EAccount *Param2);
Remove an account from the account list, and emit the account-removed signal. If the account was the default account, then reset the default to the first account.
|
|
|
const EAccount * e_account_list_get_default (EAccountList *Param1);
Get the default account. If no default is specified, or the default has become stale, then the first account is made the default.
|
|
Returns : |
The account or NULL if no accounts are defined. |
void e_account_list_set_default (EAccountList *Param1,EAccount *Param2);
Set the account account to be the default account.
|
|
|
const EAccount * e_account_list_find (EAccountList *Param1,e_account_find_t type,const gchar *key);
Perform a search of the account list on a single key.
type must be set from one of the following search types:
E_ACCOUNT_FIND_NAME - Find an account by account name.
E_ACCOUNT_FIND_ID_NAME - Find an account by the owner's identity name.
E_ACCOUNT_FIND_ID_ADDRESS - Find an account by the owner's identity address.
|
|
|
Type of search. |
|
Search key. |
Returns : |
The account or NULL if it doesn't exist. |
void e_account_list_remove_account_proxies (EAccountList *Param1,EAccount *Param2);
|
|
|
gint e_account_list_account_has_proxies (EAccountList *Param1,EAccount *Param2);
|
|
|
|
Returns : |
"account-added" signalvoid user_function (EAccountList *eaccountlist, EAccount *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"account-changed" signalvoid user_function (EAccountList *eaccountlist, EAccount *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"account-removed" signalvoid user_function (EAccountList *eaccountlist, EAccount *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |