struct EShellBackend

struct EShellBackend;

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

e_shell_backend_compare ()

gint                e_shell_backend_compare             (EShellBackend *shell_backend_a,
                                                         EShellBackend *shell_backend_b);

Using the <structfield>sort_order</structfield> field from both backends' EShellBackendClass, compares shell_backend_a with shell_mobule_b and returns -1, 0 or +1 if shell_backend_a is found to be less than, equal to or greater than shell_backend_b, respectively.

e_shell_backend_get_config_dir ()

const gchar *       e_shell_backend_get_config_dir      (EShellBackend *shell_backend);

Returns the absolute path to the configuration directory for shell_backend. The string is owned by shell_backend and should not be modified or freed.

e_shell_backend_get_data_dir ()

const gchar *       e_shell_backend_get_data_dir        (EShellBackend *shell_backend);

Returns the absolute path to the data directory for shell_backend. The string is owned by shell_backend and should not be modified or freed.

e_shell_backend_get_shell ()

struct _EShell *    e_shell_backend_get_shell           (EShellBackend *shell_backend);

Returns the EShell singleton.

e_shell_backend_add_activity ()

void                e_shell_backend_add_activity        (EShellBackend *shell_backend,
                                                         EActivity *activity);

Emits an "activity-added" signal and tracks the activity until it is finalized.

e_shell_backend_cancel_all ()

void                e_shell_backend_cancel_all          (EShellBackend *shell_backend);

Cancels all activities passed to e_shell_backend_add_activity() that have not already been finalized. Note that an EActivity can only be cancelled if it was given a GCancellable object.

Also, assuming all activities are cancellable, there may still be a delay before e_shell_backend_is_busy() returns FALSE, because some activities may not be able to respond to the cancellation request immediately. Connect to the "notify::busy" signal if you need notification of shell_backend becoming idle.

e_shell_backend_is_busy ()

gboolean            e_shell_backend_is_busy             (EShellBackend *shell_backend);

Returns TRUE if any activities passed to e_shell_backend_add_activity() are still in progress, FALSE if the shell_backend is currently idle.

e_shell_backend_get_prefer_new_item ()

const gchar *       e_shell_backend_get_prefer_new_item (EShellBackend *shell_backend);

Since 3.4

e_shell_backend_set_prefer_new_item ()

void                e_shell_backend_set_prefer_new_item (EShellBackend *shell_backend,
                                                         const gchar *prefer_new_item);

Sets name of a preferred item in New toolbar button. Use NULL or an empty string for no preference.

Since 3.4

e_shell_backend_start ()

void                e_shell_backend_start               (EShellBackend *shell_backend);

Tells the shell_backend to begin loading data or running background tasks which may consume significant resources. This gets called in reponse to the user switching to the corresponding EShellView for the first time. The function is idempotent for each shell_backend.

e_shell_backend_is_started ()

gboolean            e_shell_backend_is_started          (EShellBackend *shell_backend);

Returns whether e_shell_backend_start() was called for shell_backend.

e_shell_backend_migrate ()

gboolean            e_shell_backend_migrate             (EShellBackend *shell_backend,
                                                         gint major,
                                                         gint minor,
                                                         gint micro,
                                                         GError **error);

Attempts to migrate data and settings from version major.minor.micro. Returns TRUE if the migration was successful or if no action was necessary. Returns FALSE and sets error if the migration failed.

The "busy" property

  "busy"                     gboolean              : Read

Whether any activities are still in progress.

Default value: FALSE

The "prefer-new-item" property

  "prefer-new-item"          gchar*                : Read / Write

Name of an item to prefer in New toolbar button; can be NULL

Default value: NULL

The "activity-added" signal

void                user_function                      (EShellBackend *shell_backend,
                                                        EActivity     *activity,
                                                        gpointer       user_data)          : Run Last

Broadcasts a newly added activity.