diff options
Diffstat (limited to 'doc/reference/shell/tmpl')
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell-content.sgml | 276 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell-module.sgml | 9 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell-sidebar.sgml | 54 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell-taskbar.sgml | 35 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell-view.sgml | 19 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell-window.sgml | 117 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/e-shell.sgml | 36 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/eshell-unused.sgml | 435 | ||||
| -rw-r--r-- | doc/reference/shell/tmpl/shell-actions.sgml | 8 |
9 files changed, 585 insertions, 404 deletions
diff --git a/doc/reference/shell/tmpl/e-shell-content.sgml b/doc/reference/shell/tmpl/e-shell-content.sgml index bb62b33070..cb09ae28e7 100644 --- a/doc/reference/shell/tmpl/e-shell-content.sgml +++ b/doc/reference/shell/tmpl/e-shell-content.sgml @@ -92,3 +92,279 @@ EShellContent @Returns: +<!-- ##### FUNCTION e_shell_content_check_state ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_get_shell_view ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_get_context ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_context ##### --> +<para> + +</para> + +@shell_content: +@context: + + +<!-- ##### FUNCTION e_shell_content_get_filter_action ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_filter_action ##### --> +<para> + +</para> + +@shell_content: +@filter_action: + + +<!-- ##### FUNCTION e_shell_content_get_filter_value ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_filter_value ##### --> +<para> + +</para> + +@shell_content: +@filter_value: + + +<!-- ##### FUNCTION e_shell_content_get_filter_visible ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_filter_visible ##### --> +<para> + +</para> + +@shell_content: +@filter_visible: + + +<!-- ##### FUNCTION e_shell_content_add_filter_separator_after ##### --> +<para> + +</para> + +@shell_content: +@action_value: + + +<!-- ##### FUNCTION e_shell_content_get_search_context ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_get_search_rule ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_search_rule ##### --> +<para> + +</para> + +@shell_content: +@search_rule: + + +<!-- ##### FUNCTION e_shell_content_get_search_text ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_search_text ##### --> +<para> + +</para> + +@shell_content: +@search_text: + + +<!-- ##### FUNCTION e_shell_content_get_search_value ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_search_value ##### --> +<para> + +</para> + +@shell_content: +@search_value: + + +<!-- ##### FUNCTION e_shell_content_get_search_visible ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_search_visible ##### --> +<para> + +</para> + +@shell_content: +@search_visible: + + +<!-- ##### FUNCTION e_shell_content_get_scope_action ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_scope_action ##### --> +<para> + +</para> + +@shell_content: +@scope_action: + + +<!-- ##### FUNCTION e_shell_content_get_scope_value ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_scope_value ##### --> +<para> + +</para> + +@shell_content: +@scope_value: + + +<!-- ##### FUNCTION e_shell_content_get_scope_visible ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_scope_visible ##### --> +<para> + +</para> + +@shell_content: +@scope_visible: + + +<!-- ##### FUNCTION e_shell_content_get_view_id ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_view_id ##### --> +<para> + +</para> + +@shell_content: +@view_id: + + +<!-- ##### FUNCTION e_shell_content_run_advanced_search_dialog ##### --> +<para> + +</para> + +@shell_content: + + +<!-- ##### FUNCTION e_shell_content_run_edit_searches_dialog ##### --> +<para> + +</para> + +@shell_content: + + +<!-- ##### FUNCTION e_shell_content_run_save_search_dialog ##### --> +<para> + +</para> + +@shell_content: + + diff --git a/doc/reference/shell/tmpl/e-shell-module.sgml b/doc/reference/shell/tmpl/e-shell-module.sgml index 313a0aa989..883ae1a9af 100644 --- a/doc/reference/shell/tmpl/e-shell-module.sgml +++ b/doc/reference/shell/tmpl/e-shell-module.sgml @@ -110,6 +110,15 @@ EShellModule @Returns: +<!-- ##### FUNCTION e_shell_module_get_shell_view_type ##### --> +<para> + +</para> + +@shell_module: +@Returns: + + <!-- ##### FUNCTION e_shell_module_add_activity ##### --> <para> diff --git a/doc/reference/shell/tmpl/e-shell-sidebar.sgml b/doc/reference/shell/tmpl/e-shell-sidebar.sgml index de7fd21433..6e3d22d620 100644 --- a/doc/reference/shell/tmpl/e-shell-sidebar.sgml +++ b/doc/reference/shell/tmpl/e-shell-sidebar.sgml @@ -47,3 +47,57 @@ EShellSidebar @Returns: +<!-- ##### FUNCTION e_shell_sidebar_check_state ##### --> +<para> + +</para> + +@shell_sidebar: +@Returns: + + +<!-- ##### FUNCTION e_shell_sidebar_get_shell_view ##### --> +<para> + +</para> + +@shell_sidebar: +@Returns: + + +<!-- ##### FUNCTION e_shell_sidebar_get_primary_text ##### --> +<para> + +</para> + +@shell_sidebar: +@Returns: + + +<!-- ##### FUNCTION e_shell_sidebar_set_primary_text ##### --> +<para> + +</para> + +@shell_sidebar: +@primary_text: + + +<!-- ##### FUNCTION e_shell_sidebar_get_secondary_text ##### --> +<para> + +</para> + +@shell_sidebar: +@Returns: + + +<!-- ##### FUNCTION e_shell_sidebar_set_secondary_text ##### --> +<para> + +</para> + +@shell_sidebar: +@secondary_text: + + diff --git a/doc/reference/shell/tmpl/e-shell-taskbar.sgml b/doc/reference/shell/tmpl/e-shell-taskbar.sgml index ff99855e5e..6aa90f1c72 100644 --- a/doc/reference/shell/tmpl/e-shell-taskbar.sgml +++ b/doc/reference/shell/tmpl/e-shell-taskbar.sgml @@ -42,3 +42,38 @@ EShellTaskbar @Returns: +<!-- ##### FUNCTION e_shell_taskbar_get_shell_view ##### --> +<para> + +</para> + +@shell_taskbar: +@Returns: + + +<!-- ##### FUNCTION e_shell_taskbar_get_message ##### --> +<para> + +</para> + +@shell_taskbar: +@Returns: + + +<!-- ##### FUNCTION e_shell_taskbar_set_message ##### --> +<para> + +</para> + +@shell_taskbar: +@message: + + +<!-- ##### FUNCTION e_shell_taskbar_unset_message ##### --> +<para> + +</para> + +@shell_taskbar: + + diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml index 60798be7e5..1ea1eb6118 100644 --- a/doc/reference/shell/tmpl/e-shell-view.sgml +++ b/doc/reference/shell/tmpl/e-shell-view.sgml @@ -168,6 +168,15 @@ EShellView @Returns: +<!-- ##### FUNCTION e_shell_view_set_page_num ##### --> +<para> + +</para> + +@shell_view: +@page_num: + + <!-- ##### FUNCTION e_shell_view_get_size_group ##### --> <para> @@ -240,3 +249,13 @@ EShellView @event: +<!-- ##### FUNCTION e_shell_view_new_view_instance ##### --> +<para> + +</para> + +@shell_view: +@instance_id: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml index 750f9cf529..48f51ef992 100644 --- a/doc/reference/shell/tmpl/e-shell-window.sgml +++ b/doc/reference/shell/tmpl/e-shell-window.sgml @@ -57,3 +57,120 @@ EShellWindow @Returns: +<!-- ##### FUNCTION e_shell_window_get_shell_view ##### --> +<para> + +</para> + +@shell_window: +@view_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_shell_view_action ##### --> +<para> + +</para> + +@shell_window: +@view_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_ui_manager ##### --> +<para> + +</para> + +@shell_window: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_action ##### --> +<para> + +</para> + +@shell_window: +@action_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_action_group ##### --> +<para> + +</para> + +@shell_window: +@group_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_managed_widget ##### --> +<para> + +</para> + +@shell_window: +@widget_path: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_active_view ##### --> +<para> + +</para> + +@shell_window: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_set_active_view ##### --> +<para> + +</para> + +@shell_window: +@view_name: + + +<!-- ##### FUNCTION e_shell_window_get_safe_mode ##### --> +<para> + +</para> + +@shell_window: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_set_safe_mode ##### --> +<para> + +</para> + +@shell_window: +@safe_mode: + + +<!-- ##### FUNCTION e_shell_window_register_new_item_actions ##### --> +<para> + +</para> + +@shell_window: +@module_name: +@entries: +@n_entries: + + +<!-- ##### FUNCTION e_shell_window_register_new_source_actions ##### --> +<para> + +</para> + +@shell_window: +@module_name: +@entries: +@n_entries: + + diff --git a/doc/reference/shell/tmpl/e-shell.sgml b/doc/reference/shell/tmpl/e-shell.sgml index 2b1b292778..f5e844dce5 100644 --- a/doc/reference/shell/tmpl/e-shell.sgml +++ b/doc/reference/shell/tmpl/e-shell.sgml @@ -84,6 +84,14 @@ EShell @E_SHELL_LINE_STATUS_OFFLINE: @E_SHELL_LINE_STATUS_FORCED_OFFLINE: +<!-- ##### FUNCTION e_shell_get_default ##### --> +<para> + +</para> + +@Returns: + + <!-- ##### FUNCTION e_shell_list_modules ##### --> <para> @@ -123,6 +131,15 @@ EShell @Returns: +<!-- ##### FUNCTION e_shell_get_settings ##### --> +<para> + +</para> + +@shell: +@Returns: + + <!-- ##### FUNCTION e_shell_create_window ##### --> <para> @@ -132,6 +149,15 @@ EShell @Returns: +<!-- ##### FUNCTION e_shell_get_focused_window ##### --> +<para> + +</para> + +@shell: +@Returns: + + <!-- ##### FUNCTION e_shell_handle_uri ##### --> <para> @@ -195,6 +221,16 @@ EShell @Returns: +<!-- ##### FUNCTION e_shell_event ##### --> +<para> + +</para> + +@shell: +@event_name: +@event_data: + + <!-- ##### FUNCTION e_shell_is_busy ##### --> <para> diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml index 334903498f..3ed67b59d1 100644 --- a/doc/reference/shell/tmpl/eshell-unused.sgml +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -142,6 +142,30 @@ e-shell-constants e-shell-marshal +<!-- ##### SECTION ./tmpl/e-shell-migrate.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-migrate.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-migrate.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-migrate.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-migrate.sgml:Title ##### --> +Migration + + <!-- ##### SECTION ./tmpl/e-shell-window-actions.sgml:Long_Description ##### --> <para> @@ -1697,243 +1721,6 @@ intelligent @revision: @Returns: -<!-- ##### FUNCTION e_shell_content_add_filter_separator_after ##### --> -<para> - -</para> - -@shell_content: -@action_value: - -<!-- ##### FUNCTION e_shell_content_get_context ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_filter_action ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_filter_value ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_filter_visible ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_scope_action ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_scope_value ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_scope_visible ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_search_context ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_search_rule ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_search_text ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_search_value ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_search_visible ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_shell_view ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_get_view_id ##### --> -<para> - -</para> - -@shell_content: -@Returns: - -<!-- ##### FUNCTION e_shell_content_run_advanced_search_dialog ##### --> -<para> - -</para> - -@shell_content: - -<!-- ##### FUNCTION e_shell_content_run_edit_searches_dialog ##### --> -<para> - -</para> - -@shell_content: - -<!-- ##### FUNCTION e_shell_content_run_save_search_dialog ##### --> -<para> - -</para> - -@shell_content: - -<!-- ##### FUNCTION e_shell_content_set_context ##### --> -<para> - -</para> - -@shell_content: -@context: - -<!-- ##### FUNCTION e_shell_content_set_filter_action ##### --> -<para> - -</para> - -@shell_content: -@filter_action: - -<!-- ##### FUNCTION e_shell_content_set_filter_value ##### --> -<para> - -</para> - -@shell_content: -@filter_value: - -<!-- ##### FUNCTION e_shell_content_set_filter_visible ##### --> -<para> - -</para> - -@shell_content: -@filter_visible: - -<!-- ##### FUNCTION e_shell_content_set_scope_action ##### --> -<para> - -</para> - -@shell_content: -@scope_action: - -<!-- ##### FUNCTION e_shell_content_set_scope_value ##### --> -<para> - -</para> - -@shell_content: -@scope_value: - -<!-- ##### FUNCTION e_shell_content_set_scope_visible ##### --> -<para> - -</para> - -@shell_content: -@scope_visible: - -<!-- ##### FUNCTION e_shell_content_set_search_rule ##### --> -<para> - -</para> - -@shell_content: -@search_rule: - -<!-- ##### FUNCTION e_shell_content_set_search_text ##### --> -<para> - -</para> - -@shell_content: -@search_text: - -<!-- ##### FUNCTION e_shell_content_set_search_value ##### --> -<para> - -</para> - -@shell_content: -@search_value: - -<!-- ##### FUNCTION e_shell_content_set_search_visible ##### --> -<para> - -</para> - -@shell_content: -@search_visible: - -<!-- ##### FUNCTION e_shell_content_set_view_id ##### --> -<para> - -</para> - -@shell_content: -@view_id: - <!-- ##### FUNCTION e_shell_marshal_BOOLEAN__STRING ##### --> <para> @@ -1952,6 +1739,13 @@ intelligent </para> +<!-- ##### FUNCTION e_shell_migrate_error_quark ##### --> +<para> + +</para> + +@Returns: + <!-- ##### FUNCTION e_shell_module_upgrade ##### --> <para> @@ -1972,77 +1766,6 @@ intelligent @online: @Returns: -<!-- ##### FUNCTION e_shell_sidebar_get_primary_text ##### --> -<para> - -</para> - -@shell_sidebar: -@Returns: - -<!-- ##### FUNCTION e_shell_sidebar_get_secondary_text ##### --> -<para> - -</para> - -@shell_sidebar: -@Returns: - -<!-- ##### FUNCTION e_shell_sidebar_get_shell_view ##### --> -<para> - -</para> - -@shell_sidebar: -@Returns: - -<!-- ##### FUNCTION e_shell_sidebar_set_primary_text ##### --> -<para> - -</para> - -@shell_sidebar: -@primary_text: - -<!-- ##### FUNCTION e_shell_sidebar_set_secondary_text ##### --> -<para> - -</para> - -@shell_sidebar: -@secondary_text: - -<!-- ##### FUNCTION e_shell_taskbar_get_message ##### --> -<para> - -</para> - -@shell_taskbar: -@Returns: - -<!-- ##### FUNCTION e_shell_taskbar_get_shell_view ##### --> -<para> - -</para> - -@shell_taskbar: -@Returns: - -<!-- ##### FUNCTION e_shell_taskbar_set_message ##### --> -<para> - -</para> - -@shell_taskbar: -@message: - -<!-- ##### FUNCTION e_shell_taskbar_unset_message ##### --> -<para> - -</para> - -@shell_taskbar: - <!-- ##### FUNCTION e_shell_upgrade_attempt ##### --> <para> @@ -2051,102 +1774,6 @@ intelligent @shell: @Returns: -<!-- ##### FUNCTION e_shell_window_get_action ##### --> -<para> - -</para> - -@shell_window: -@action_name: -@Returns: - -<!-- ##### FUNCTION e_shell_window_get_action_group ##### --> -<para> - -</para> - -@shell_window: -@group_name: -@Returns: - -<!-- ##### FUNCTION e_shell_window_get_active_view ##### --> -<para> - -</para> - -@shell_window: -@Returns: - -<!-- ##### FUNCTION e_shell_window_get_managed_widget ##### --> -<para> - -</para> - -@shell_window: -@widget_path: -@Returns: - -<!-- ##### FUNCTION e_shell_window_get_safe_mode ##### --> -<para> - -</para> - -@shell_window: -@Returns: - -<!-- ##### FUNCTION e_shell_window_get_shell_view ##### --> -<para> - -</para> - -@shell_window: -@view_name: -@Returns: - -<!-- ##### FUNCTION e_shell_window_get_ui_manager ##### --> -<para> - -</para> - -@shell_window: -@Returns: - -<!-- ##### FUNCTION e_shell_window_register_new_item_actions ##### --> -<para> - -</para> - -@shell_window: -@module_name: -@entries: -@n_entries: - -<!-- ##### FUNCTION e_shell_window_register_new_source_actions ##### --> -<para> - -</para> - -@shell_window: -@module_name: -@entries: -@n_entries: - -<!-- ##### FUNCTION e_shell_window_set_active_view ##### --> -<para> - -</para> - -@shell_window: -@view_name: - -<!-- ##### FUNCTION e_shell_window_set_safe_mode ##### --> -<para> - -</para> - -@shell_window: -@safe_mode: - <!-- ##### VARIABLE e_test_shell_view_type ##### --> <para> diff --git a/doc/reference/shell/tmpl/shell-actions.sgml b/doc/reference/shell/tmpl/shell-actions.sgml index 170ca0e502..60001d61bb 100644 --- a/doc/reference/shell/tmpl/shell-actions.sgml +++ b/doc/reference/shell/tmpl/shell-actions.sgml @@ -225,6 +225,14 @@ Shell Actions @window: +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL ##### --> +<para> + +</para> + +@window: + + <!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH ##### --> <para> |