aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/shell/eshell-sections.txt214
-rw-r--r--doc/reference/shell/tmpl/action-groups.sgml69
-rw-r--r--doc/reference/shell/tmpl/e-shell-content.sgml2
-rw-r--r--doc/reference/shell/tmpl/e-shell-importer.sgml2
-rw-r--r--doc/reference/shell/tmpl/e-shell-module.sgml12
-rw-r--r--doc/reference/shell/tmpl/e-shell-sidebar.sgml2
-rw-r--r--doc/reference/shell/tmpl/e-shell-switcher.sgml2
-rw-r--r--doc/reference/shell/tmpl/e-shell-taskbar.sgml2
-rw-r--r--doc/reference/shell/tmpl/e-shell-view.sgml3
-rw-r--r--doc/reference/shell/tmpl/e-shell-window.sgml2
-rw-r--r--doc/reference/shell/tmpl/e-shell.sgml2
-rw-r--r--doc/reference/shell/tmpl/eshell-unused.sgml15
-rw-r--r--doc/reference/shell/tmpl/shell-actions.sgml285
13 files changed, 499 insertions, 113 deletions
diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt
index 2a7b3d81b2..4e0474f0c2 100644
--- a/doc/reference/shell/eshell-sections.txt
+++ b/doc/reference/shell/eshell-sections.txt
@@ -33,36 +33,102 @@ EShellPrivate
</SECTION>
<SECTION>
-<FILE>e-shell-view</FILE>
-<TITLE>EShellView</TITLE>
-EShellView
-EShellViewClass
-e_shell_view_get_name
-e_shell_view_get_action
-e_shell_view_get_title
-e_shell_view_set_title
-e_shell_view_get_view_id
-e_shell_view_set_view_id
-e_shell_view_is_active
-e_shell_view_get_page_num
-e_shell_view_get_size_group
-e_shell_view_get_shell_content
-e_shell_view_get_shell_sidebar
-e_shell_view_get_shell_taskbar
-e_shell_view_get_shell_window
-e_shell_view_get_shell_module
-e_shell_view_update_actions
-e_shell_view_show_popup_menu
+<FILE>e-shell-content</FILE>
+<TITLE>EShellContent</TITLE>
+EShellContent
+e_shell_content_new
+e_shell_content_get_shell_view
+e_shell_content_get_context
+e_shell_content_set_context
+e_shell_content_get_filter_action
+e_shell_content_set_filter_action
+e_shell_content_get_filter_value
+e_shell_content_set_filter_value
+e_shell_content_get_filter_visible
+e_shell_content_set_filter_visible
+e_shell_content_add_filter_separator_after
+e_shell_content_get_search_context
+e_shell_content_get_search_rule
+e_shell_content_set_search_rule
+e_shell_content_get_search_text
+e_shell_content_set_search_text
+e_shell_content_get_search_value
+e_shell_content_set_search_value
+e_shell_content_get_search_visible
+e_shell_content_set_search_visible
+e_shell_content_get_scope_action
+e_shell_content_set_scope_action
+e_shell_content_get_scope_value
+e_shell_content_set_scope_value
+e_shell_content_get_scope_visible
+e_shell_content_set_scope_visible
+e_shell_content_get_view_id
+e_shell_content_set_view_id
+e_shell_content_run_advanced_search_dialog
+e_shell_content_run_edit_searches_dialog
+e_shell_content_run_save_search_dialog
<SUBSECTION Standard>
-E_SHELL_VIEW
-E_IS_SHELL_VIEW
-E_TYPE_SHELL_VIEW
-E_SHELL_VIEW_CLASS
-E_IS_SHELL_VIEW_CLASS
-E_SHELL_VIEW_GET_CLASS
-e_shell_view_get_type
+E_SHELL_CONTENT
+E_IS_SHELL_CONTENT
+E_TYPE_SHELL_CONTENT
+E_SHELL_CONTENT_CLASS
+E_IS_SHELL_CONTENT_CLASS
+E_SHELL_CONTENT_GET_CLASS
+EShellContentClass
+e_shell_content_get_type
<SUBSECTION Private>
-EShellViewPrivate
+EShellContentPrivate
+</SECTION>
+
+<SECTION>
+<FILE>e-shell-module</FILE>
+<TITLE>EShellModule</TITLE>
+EShellModule
+EShellModuleInfo
+e_shell_module_new
+e_shell_module_compare
+e_shell_module_get_config_dir
+e_shell_module_get_data_dir
+e_shell_module_get_filename
+e_shell_module_get_shell
+e_shell_module_add_activity
+e_shell_module_is_busy
+e_shell_module_shutdown
+e_shell_module_set_info
+<SUBSECTION Standard>
+E_SHELL_MODULE
+E_IS_SHELL_MODULE
+E_TYPE_SHELL_MODULE
+E_SHELL_MODULE_CLASS
+E_IS_SHELL_MODULE_CLASS
+E_SHELL_MODULE_GET_CLASS
+EShellModuleClass
+e_shell_module_get_type
+<SUBSECTION Private>
+EShellModulePrivate
+</SECTION>
+
+<SECTION>
+<FILE>e-shell-sidebar</FILE>
+<TITLE>EShellSidebar</TITLE>
+EShellSidebar
+e_shell_sidebar_new
+e_shell_sidebar_get_shell_view
+e_shell_sidebar_get_primary_text
+e_shell_sidebar_set_primary_text
+e_shell_sidebar_get_secondary_text
+e_shell_sidebar_set_secondary_text
+<SUBSECTION Standard>
+E_SHELL_SIDEBAR
+E_IS_SHELL_SIDEBAR
+E_TYPE_SHELL_SIDEBAR
+E_SHELL_SIDEBAR_CLASS
+E_IS_SHELL_SIDEBAR_CLASS
+E_SHELL_SIDEBAR_GET_CLASS
+EShellSidebarClass
+e_shell_sidebar_get_type
+<SUBSECTION Private>
+EShellSidebarPrivate
</SECTION>
<SECTION>
@@ -91,28 +157,14 @@ E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE
</SECTION>
<SECTION>
-<FILE>e-shell-sidebar</FILE>
-<TITLE>EShellSidebar</TITLE>
-EShellSidebar
-e_shell_sidebar_new
-<SUBSECTION Standard>
-E_SHELL_SIDEBAR
-E_IS_SHELL_SIDEBAR
-E_TYPE_SHELL_SIDEBAR
-E_SHELL_SIDEBAR_CLASS
-E_IS_SHELL_SIDEBAR_CLASS
-E_SHELL_SIDEBAR_GET_CLASS
-EShellSidebarClass
-e_shell_sidebar_get_type
-<SUBSECTION Private>
-EShellSidebarPrivate
-</SECTION>
-
-<SECTION>
<FILE>e-shell-taskbar</FILE>
<TITLE>EShellTaskbar</TITLE>
EShellTaskbar
e_shell_taskbar_new
+e_shell_taskbar_get_shell_view
+e_shell_taskbar_get_message
+e_shell_taskbar_set_message
+e_shell_taskbar_unset_message
<SUBSECTION Standard>
E_SHELL_TASKBAR
E_IS_SHELL_TASKBAR
@@ -127,50 +179,36 @@ EShellTaskbarPrivate
</SECTION>
<SECTION>
-<FILE>e-shell-module</FILE>
-<TITLE>EShellModule</TITLE>
-EShellModule
-EShellModuleInfo
-e_shell_module_new
-e_shell_module_compare
-e_shell_module_get_config_dir
-e_shell_module_get_data_dir
-e_shell_module_get_filename
-e_shell_module_get_searches
-e_shell_module_get_shell
-e_shell_module_add_activity
-e_shell_module_is_busy
-e_shell_module_shutdown
-e_shell_module_set_info
-<SUBSECTION Standard>
-E_SHELL_MODULE
-E_IS_SHELL_MODULE
-E_TYPE_SHELL_MODULE
-E_SHELL_MODULE_CLASS
-E_IS_SHELL_MODULE_CLASS
-E_SHELL_MODULE_GET_CLASS
-EShellModuleClass
-e_shell_module_get_type
-<SUBSECTION Private>
-EShellModulePrivate
-</SECTION>
-
-<SECTION>
-<FILE>e-shell-content</FILE>
-<TITLE>EShellContent</TITLE>
-EShellContent
-e_shell_content_new
+<FILE>e-shell-view</FILE>
+<TITLE>EShellView</TITLE>
+EShellView
+EShellViewClass
+e_shell_view_get_name
+e_shell_view_get_action
+e_shell_view_get_title
+e_shell_view_set_title
+e_shell_view_get_view_id
+e_shell_view_set_view_id
+e_shell_view_is_active
+e_shell_view_get_page_num
+e_shell_view_get_size_group
+e_shell_view_get_shell_content
+e_shell_view_get_shell_sidebar
+e_shell_view_get_shell_taskbar
+e_shell_view_get_shell_window
+e_shell_view_get_shell_module
+e_shell_view_update_actions
+e_shell_view_show_popup_menu
<SUBSECTION Standard>
-E_SHELL_CONTENT
-E_IS_SHELL_CONTENT
-E_TYPE_SHELL_CONTENT
-E_SHELL_CONTENT_CLASS
-E_IS_SHELL_CONTENT_CLASS
-E_SHELL_CONTENT_GET_CLASS
-EShellContentClass
-e_shell_content_get_type
+E_SHELL_VIEW
+E_IS_SHELL_VIEW
+E_TYPE_SHELL_VIEW
+E_SHELL_VIEW_CLASS
+E_IS_SHELL_VIEW_CLASS
+E_SHELL_VIEW_GET_CLASS
+e_shell_view_get_type
<SUBSECTION Private>
-EShellContentPrivate
+EShellViewPrivate
</SECTION>
<SECTION>
diff --git a/doc/reference/shell/tmpl/action-groups.sgml b/doc/reference/shell/tmpl/action-groups.sgml
new file mode 100644
index 0000000000..1aa47ad9da
--- /dev/null
+++ b/doc/reference/shell/tmpl/action-groups.sgml
@@ -0,0 +1,69 @@
+<!-- ##### SECTION Title ##### -->
+Action Groups
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SHELL ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SWITCHER ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_NEW_ITEM ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_NEW_SOURCE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_CUSTOM_RULES ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW ##### -->
+<para>
+
+</para>
+
+@window:
+
+
diff --git a/doc/reference/shell/tmpl/e-shell-content.sgml b/doc/reference/shell/tmpl/e-shell-content.sgml
index bb62b33070..86fdc441aa 100644
--- a/doc/reference/shell/tmpl/e-shell-content.sgml
+++ b/doc/reference/shell/tmpl/e-shell-content.sgml
@@ -9,11 +9,13 @@ EShellContent
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/e-shell-importer.sgml b/doc/reference/shell/tmpl/e-shell-importer.sgml
index 0b3aa44506..e5c58e2791 100644
--- a/doc/reference/shell/tmpl/e-shell-importer.sgml
+++ b/doc/reference/shell/tmpl/e-shell-importer.sgml
@@ -9,11 +9,13 @@ e-shell-importer
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/e-shell-module.sgml b/doc/reference/shell/tmpl/e-shell-module.sgml
index 3b9b642688..9deb78ca62 100644
--- a/doc/reference/shell/tmpl/e-shell-module.sgml
+++ b/doc/reference/shell/tmpl/e-shell-module.sgml
@@ -9,11 +9,13 @@ EShellModule
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
@@ -49,7 +51,6 @@ EShellModule
@name:
@aliases:
@schemes:
-@searches:
@sort_order:
@is_busy:
@shutdown:
@@ -101,15 +102,6 @@ EShellModule
@Returns:
-<!-- ##### FUNCTION e_shell_module_get_searches ##### -->
-<para>
-
-</para>
-
-@shell_module:
-@Returns:
-
-
<!-- ##### FUNCTION e_shell_module_get_shell ##### -->
<para>
diff --git a/doc/reference/shell/tmpl/e-shell-sidebar.sgml b/doc/reference/shell/tmpl/e-shell-sidebar.sgml
index de7fd21433..fef40a242f 100644
--- a/doc/reference/shell/tmpl/e-shell-sidebar.sgml
+++ b/doc/reference/shell/tmpl/e-shell-sidebar.sgml
@@ -9,11 +9,13 @@ EShellSidebar
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/e-shell-switcher.sgml b/doc/reference/shell/tmpl/e-shell-switcher.sgml
index f656b65988..4f7e093c98 100644
--- a/doc/reference/shell/tmpl/e-shell-switcher.sgml
+++ b/doc/reference/shell/tmpl/e-shell-switcher.sgml
@@ -9,11 +9,13 @@ EShellSwitcher
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/e-shell-taskbar.sgml b/doc/reference/shell/tmpl/e-shell-taskbar.sgml
index ff99855e5e..0c25dabb0d 100644
--- a/doc/reference/shell/tmpl/e-shell-taskbar.sgml
+++ b/doc/reference/shell/tmpl/e-shell-taskbar.sgml
@@ -9,11 +9,13 @@ EShellTaskbar
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml
index b5ee5e22a6..25bb98e774 100644
--- a/doc/reference/shell/tmpl/e-shell-view.sgml
+++ b/doc/reference/shell/tmpl/e-shell-view.sgml
@@ -9,11 +9,13 @@ EShellView
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
@@ -87,6 +89,7 @@ EShellView
@icon_name:
@ui_definition:
@search_options:
+@search_rules:
@type_module:
@view_collection:
@new_shell_content:
diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml
index 50349dae87..12bef47e63 100644
--- a/doc/reference/shell/tmpl/e-shell-window.sgml
+++ b/doc/reference/shell/tmpl/e-shell-window.sgml
@@ -9,11 +9,13 @@ EShellWindow
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/e-shell.sgml b/doc/reference/shell/tmpl/e-shell.sgml
index db92be82ed..e8a37782d3 100644
--- a/doc/reference/shell/tmpl/e-shell.sgml
+++ b/doc/reference/shell/tmpl/e-shell.sgml
@@ -9,11 +9,13 @@ EShell
</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml
index 80bd636991..e69de29bb2 100644
--- a/doc/reference/shell/tmpl/eshell-unused.sgml
+++ b/doc/reference/shell/tmpl/eshell-unused.sgml
@@ -1,15 +0,0 @@
-<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_VIEW_MENU ##### -->
-<para>
-
-</para>
-
-@window:
-
-<!-- ##### FUNCTION e_shell_view_add_activity ##### -->
-<para>
-
-</para>
-
-@shell_view:
-@activity:
-
diff --git a/doc/reference/shell/tmpl/shell-actions.sgml b/doc/reference/shell/tmpl/shell-actions.sgml
new file mode 100644
index 0000000000..0a33b6c50f
--- /dev/null
+++ b/doc/reference/shell/tmpl/shell-actions.sgml
@@ -0,0 +1,285 @@
+<!-- ##### SECTION Title ##### -->
+Shell Actions
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_ABOUT ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_CLOSE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_CONTENTS ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_FAQ ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_FORGET_PASSWORDS ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_CUSTOM_VIEW ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_DEFINE_VIEWS ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_SAVE_CUSTOM_VIEW ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_IMPORT ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_NEW_WINDOW ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_PAGE_SETUP ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_PREFERENCES ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_QUICK_REFERENCE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_QUIT ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_ADVANCED ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_CLEAR ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_EDIT ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_EXECUTE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_OPTIONS ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_SAVE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEND_RECEIVE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SIDEBAR ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SWITCHER ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SUBMIT_BUG ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_TEXT ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_USER ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SYNC_OPTIONS ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_WORK_OFFLINE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_WORK_ONLINE ##### -->
+<para>
+
+</para>
+
+@window:
+
+
generated by cgit (git 2.34.1) at 2024-11-14 20:30:28 +0800