Top | ![]() |
![]() |
![]() |
![]() |
GtkWidget * | e_collection_account_wizard_new () |
ESourceRegistry * | e_collection_account_wizard_get_registry () |
gboolean | e_collection_account_wizard_get_can_run () |
void | e_collection_account_wizard_reset () |
gboolean | e_collection_account_wizard_next () |
gboolean | e_collection_account_wizard_prev () |
gboolean | e_collection_account_wizard_is_finish_page () |
void | e_collection_account_wizard_run () |
void | e_collection_account_wizard_run_finish () |
void | e_collection_account_wizard_abort () |
ECollectionAccountWizard is a configuration wizard which guides user through steps to created collection accounts. Such accounts provide multiple sources at once, being it address books, calendars, mail and others.
GtkWidget *
e_collection_account_wizard_new (ESourceRegistry *registry
);
Creates a new ECollectionAccountWizard instance.
Since: 3.28
ESourceRegistry *
e_collection_account_wizard_get_registry
(ECollectionAccountWizard *wizard
);
Returns the ESourceRegistry passed to e_collection_account_wizard_new()
.
Since: 3.28
gboolean
e_collection_account_wizard_get_can_run
(ECollectionAccountWizard *wizard
);
Returns whether e_collection_account_wizard_run()
can be called, that is,
whether at least one worker is enabled to run and the wizard
is not
running.
Since: 3.28
void
e_collection_account_wizard_reset (ECollectionAccountWizard *wizard
);
Resets content of the wizard
to the initial state. This might be called
whenever the widget is going to be shown.
Since: 3.28
gboolean
e_collection_account_wizard_next (ECollectionAccountWizard *wizard
);
Instructs the wizard
to advance to the next step. It does nothing
when there is an ongoing lookup or when the current page cannot
be advanced.
This can influence e_collection_account_wizard_is_finish_page()
.
TRUE
, when the step had been changed, FALSE
otherwise.
Note that when this is called on a finish page, then the TRUE
means that the wizard
finished all its settings and should be
closed now.
Since: 3.28
gboolean
e_collection_account_wizard_prev (ECollectionAccountWizard *wizard
);
Instructs the wizard
to go back to the previous step.
This can influence e_collection_account_wizard_is_finish_page()
.
Since: 3.28
gboolean
e_collection_account_wizard_is_finish_page
(ECollectionAccountWizard *wizard
);
Since: 3.28
void e_collection_account_wizard_run (ECollectionAccountWizard *wizard
,GAsyncReadyCallback callback
,gpointer user_data
);
Runs lookup for all enabled lookup workers. Finish the call
with e_collection_account_wizard_run_finish()
from the callback
.
This function can be called only if e_collection_account_wizard_get_can_run()
returns TRUE
.
wizard |
||
callback |
a callback to call, when the run is finished |
|
user_data |
user data for the |
Since: 3.28
void e_collection_account_wizard_run_finish (ECollectionAccountWizard *wizard
,GAsyncResult *result
);
Finishes the wizard run issued by e_collection_account_wizard_run()
.
It doesn't return anything, because everything is handled within
the wizard
, thus it is provided mainly for consistency with asynchronous API.
Since: 3.28
void
e_collection_account_wizard_abort (ECollectionAccountWizard *wizard
);
Aborts any ongoing operation the wizard
may run. If there is nothing
running, then does nothing.
Since: 3.28
struct ECollectionAccountWizard { };
Contains only private data that should be read and manipulated using the functions below.
Since: 3.28