fdf1c024b5
An easy way to broadcast application-wide alerts to shell windows. These alerts will persist in all current and future shell windows until responded to (either programmatically or by the user).
451 lines
5.1 KiB
Plaintext
451 lines
5.1 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
EShell
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Image ##### -->
|
|
|
|
|
|
<!-- ##### STRUCT EShell ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### SIGNAL EShell::event ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@arg1:
|
|
|
|
<!-- ##### SIGNAL EShell::handle-uri ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@arg1:
|
|
@Returns:
|
|
|
|
<!-- ##### SIGNAL EShell::prepare-for-offline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@arg1:
|
|
|
|
<!-- ##### SIGNAL EShell::prepare-for-online ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@arg1:
|
|
|
|
<!-- ##### SIGNAL EShell::prepare-for-quit ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@arg1:
|
|
|
|
<!-- ##### SIGNAL EShell::quit-requested ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@Param2:
|
|
|
|
<!-- ##### SIGNAL EShell::window-created ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
@arg1:
|
|
|
|
<!-- ##### SIGNAL EShell::window-destroyed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@eshell: the object which received the signal.
|
|
|
|
<!-- ##### ARG EShell:express-mode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:geometry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:meego-mode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:module-directory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:network-available ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:online ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:shell-settings ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG EShell:small-screen-mode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION e_shell_get_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@void:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_load_modules ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_shell_backends ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_canonical_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_backend_by_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_backend_by_scheme ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@scheme:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_shell_settings ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_gconf_client ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_create_shell_window ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@view_name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_handle_uris ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@uris:
|
|
@do_import:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_submit_alert ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@alert:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_watch_window ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@window:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_watched_windows ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_active_window ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_meego_mode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_express_mode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_small_screen_mode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_module_directory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_network_available ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_set_network_available ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@network_available:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_lock_network_available ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_online ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_set_online ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@online:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_preferences_window ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_event ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@event_name:
|
|
@event_data:
|
|
|
|
|
|
<!-- ##### ENUM EShellQuitReason ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@E_SHELL_QUIT_ACTION:
|
|
@E_SHELL_QUIT_LAST_WINDOW:
|
|
@E_SHELL_QUIT_OPTION:
|
|
@E_SHELL_QUIT_REMOTE_REQUEST:
|
|
@E_SHELL_QUIT_SESSION_REQUEST:
|
|
|
|
<!-- ##### FUNCTION e_shell_quit ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@reason:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_cancel_quit ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_adapt_window_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@window:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_set_startup_view ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@view:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_get_startup_view ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### MACRO E_SHELL_MIGRATE_ERROR ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ENUM EShellMigrateError ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@E_SHELL_MIGRATE_ERROR_FAILED:
|
|
|
|
<!-- ##### FUNCTION e_shell_migrate_attempt ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@shell:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION e_shell_detect_meego ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@is_meego:
|
|
@small_screen:
|
|
|
|
|