aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/shell/Makefile.am3
-rw-r--r--doc/reference/shell/eshell-docs.sgml2
-rw-r--r--doc/reference/shell/eshell-sections.txt70
-rw-r--r--doc/reference/shell/eshell.types2
-rw-r--r--doc/reference/shell/tmpl/e-shell-view.sgml15
-rw-r--r--doc/reference/shell/tmpl/e-shell-window.sgml4
-rw-r--r--doc/reference/shell/tmpl/e-shell.sgml6
-rw-r--r--doc/reference/shell/tmpl/eshell-unused.sgml214
8 files changed, 265 insertions, 51 deletions
diff --git a/doc/reference/shell/Makefile.am b/doc/reference/shell/Makefile.am
index 1bdf90651b..95e6b09565 100644
--- a/doc/reference/shell/Makefile.am
+++ b/doc/reference/shell/Makefile.am
@@ -72,8 +72,8 @@ GTKDOC_LIBS= \
$(top_builddir)/shell/e-shell-nm.o \
$(top_builddir)/shell/e-shell-window-private.o \
$(top_builddir)/shell/es-event.o \
+ $(top_builddir)/shell/.libs/e-shell-backend.o \
$(top_builddir)/shell/.libs/e-shell-content.o \
- $(top_builddir)/shell/.libs/e-shell-module.o \
$(top_builddir)/shell/.libs/e-shell-settings.o \
$(top_builddir)/shell/.libs/e-shell-sidebar.o \
$(top_builddir)/shell/.libs/e-shell-switcher.o \
@@ -92,6 +92,7 @@ GTKDOC_LIBS= \
$(top_builddir)/e-util/.libs/e-logger.o \
$(top_builddir)/e-util/.libs/e-marshal.o \
$(top_builddir)/e-util/.libs/e-mktemp.o \
+ $(top_builddir)/e-util/.libs/e-module.o \
$(top_builddir)/e-util/.libs/e-plugin.o \
$(top_builddir)/e-util/.libs/e-plugin-ui.o \
$(top_builddir)/e-util/.libs/e-popup.o \
diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml
index 0e2c83cc77..3d7bdcd36e 100644
--- a/doc/reference/shell/eshell-docs.sgml
+++ b/doc/reference/shell/eshell-docs.sgml
@@ -14,7 +14,7 @@ url="http://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.o
<chapter>
<title>The Shell</title>
<xi:include href="xml/e-shell.xml"/>
- <xi:include href="xml/e-shell-module.xml"/>
+ <xi:include href="xml/e-shell-backend.xml"/>
<xi:include href="xml/e-shell-window.xml"/>
<xi:include href="xml/e-shell-view.xml"/>
<xi:include href="xml/e-shell-content.xml"/>
diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt
index 9ab9974fd1..c3e3a3598a 100644
--- a/doc/reference/shell/eshell-sections.txt
+++ b/doc/reference/shell/eshell-sections.txt
@@ -3,10 +3,10 @@
<TITLE>EShell</TITLE>
EShell
e_shell_get_default
-e_shell_get_shell_modules
+e_shell_get_shell_backends
e_shell_get_canonical_name
-e_shell_get_module_by_name
-e_shell_get_module_by_scheme
+e_shell_get_backend_by_name
+e_shell_get_backend_by_scheme
e_shell_get_shell_settings
e_shell_get_gconf_client
e_shell_create_shell_window
@@ -40,6 +40,37 @@ e_shell_migrate_error_quark
</SECTION>
<SECTION>
+<FILE>e-shell-backend</FILE>
+<TITLE>EShellBackend</TITLE>
+EShellBackend
+EShellBackendInfo
+e_shell_backend_new
+e_shell_backend_compare
+e_shell_backend_get_config_dir
+e_shell_backend_get_data_dir
+e_shell_backend_get_filename
+e_shell_backend_get_shell
+e_shell_backend_get_shell_view_type
+e_shell_backend_add_activity
+e_shell_backend_start
+e_shell_backend_is_busy
+e_shell_backend_shutdown
+e_shell_backend_migrate
+e_shell_backend_set_info
+<SUBSECTION Standard>
+E_SHELL_BACKEND
+E_IS_SHELL_BACKEND
+E_TYPE_SHELL_BACKEND
+E_SHELL_BACKEND_CLASS
+E_IS_SHELL_BACKEND_CLASS
+E_SHELL_BACKEND_GET_CLASS
+EShellBackendClass
+e_shell_backend_get_type
+<SUBSECTION Private>
+EShellBackendPrivate
+</SECTION>
+
+<SECTION>
<FILE>e-shell-content</FILE>
<TITLE>EShellContent</TITLE>
EShellContent
@@ -86,37 +117,6 @@ 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_get_shell_view_type
-e_shell_module_add_activity
-e_shell_module_start
-e_shell_module_is_busy
-e_shell_module_shutdown
-e_shell_module_migrate
-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-settings</FILE>
<TITLE>EShellSettings</TITLE>
EShellSettings
@@ -234,11 +234,11 @@ e_shell_view_is_active
e_shell_view_get_page_num
e_shell_view_set_page_num
e_shell_view_get_size_group
+e_shell_view_get_shell_backend
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
e_shell_view_new_view_instance
diff --git a/doc/reference/shell/eshell.types b/doc/reference/shell/eshell.types
index b0933d219f..7ad399f7c9 100644
--- a/doc/reference/shell/eshell.types
+++ b/doc/reference/shell/eshell.types
@@ -1,6 +1,6 @@
e_shell_get_type
+e_shell_backend_get_type
e_shell_content_get_type
-e_shell_module_get_type
e_shell_sidebar_get_type
e_shell_switcher_get_type
e_shell_taskbar_get_type
diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml
index fb10778576..2119b2793e 100644
--- a/doc/reference/shell/tmpl/e-shell-view.sgml
+++ b/doc/reference/shell/tmpl/e-shell-view.sgml
@@ -47,12 +47,12 @@ EShellView
</para>
-<!-- ##### ARG EShellView:shell-content ##### -->
+<!-- ##### ARG EShellView:shell-backend ##### -->
<para>
</para>
-<!-- ##### ARG EShellView:shell-module ##### -->
+<!-- ##### ARG EShellView:shell-content ##### -->
<para>
</para>
@@ -94,7 +94,6 @@ EShellView
@ui_manager_id:
@search_options:
@search_rules:
-@type_module:
@view_collection:
@new_shell_content:
@new_shell_sidebar:
@@ -192,7 +191,7 @@ EShellView
@Returns:
-<!-- ##### FUNCTION e_shell_view_get_shell_content ##### -->
+<!-- ##### FUNCTION e_shell_view_get_shell_backend ##### -->
<para>
</para>
@@ -201,7 +200,7 @@ EShellView
@Returns:
-<!-- ##### FUNCTION e_shell_view_get_shell_sidebar ##### -->
+<!-- ##### FUNCTION e_shell_view_get_shell_content ##### -->
<para>
</para>
@@ -210,7 +209,7 @@ EShellView
@Returns:
-<!-- ##### FUNCTION e_shell_view_get_shell_taskbar ##### -->
+<!-- ##### FUNCTION e_shell_view_get_shell_sidebar ##### -->
<para>
</para>
@@ -219,7 +218,7 @@ EShellView
@Returns:
-<!-- ##### FUNCTION e_shell_view_get_shell_window ##### -->
+<!-- ##### FUNCTION e_shell_view_get_shell_taskbar ##### -->
<para>
</para>
@@ -228,7 +227,7 @@ EShellView
@Returns:
-<!-- ##### FUNCTION e_shell_view_get_shell_module ##### -->
+<!-- ##### FUNCTION e_shell_view_get_shell_window ##### -->
<para>
</para>
diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml
index f1bbeac5e7..9571632bae 100644
--- a/doc/reference/shell/tmpl/e-shell-window.sgml
+++ b/doc/reference/shell/tmpl/e-shell-window.sgml
@@ -172,7 +172,7 @@ EShellWindow
</para>
@shell_window:
-@module_name:
+@backend_name:
@entries:
@n_entries:
@@ -183,7 +183,7 @@ EShellWindow
</para>
@shell_window:
-@module_name:
+@backend_name:
@entries:
@n_entries:
diff --git a/doc/reference/shell/tmpl/e-shell.sgml b/doc/reference/shell/tmpl/e-shell.sgml
index 04935e1de6..f1c5acec53 100644
--- a/doc/reference/shell/tmpl/e-shell.sgml
+++ b/doc/reference/shell/tmpl/e-shell.sgml
@@ -102,7 +102,7 @@ EShell
@Returns:
-<!-- ##### FUNCTION e_shell_get_shell_modules ##### -->
+<!-- ##### FUNCTION e_shell_get_shell_backends ##### -->
<para>
</para>
@@ -121,7 +121,7 @@ EShell
@Returns:
-<!-- ##### FUNCTION e_shell_get_module_by_name ##### -->
+<!-- ##### FUNCTION e_shell_get_backend_by_name ##### -->
<para>
</para>
@@ -131,7 +131,7 @@ EShell
@Returns:
-<!-- ##### FUNCTION e_shell_get_module_by_scheme ##### -->
+<!-- ##### FUNCTION e_shell_get_backend_by_scheme ##### -->
<para>
</para>
diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml
index 57aef32237..72168ee8e2 100644
--- a/doc/reference/shell/tmpl/eshell-unused.sgml
+++ b/doc/reference/shell/tmpl/eshell-unused.sgml
@@ -166,6 +166,30 @@ e-shell-marshal
Migration
+<!-- ##### SECTION ./tmpl/e-shell-module.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/e-shell-module.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/e-shell-module.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/e-shell-module.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/e-shell-module.sgml:Title ##### -->
+EShellModule
+
+
<!-- ##### SECTION ./tmpl/e-shell-window-actions.sgml:Long_Description ##### -->
<para>
@@ -461,6 +485,52 @@ intelligent
@E_SHELL_LINE_STATUS_OFFLINE:
@E_SHELL_LINE_STATUS_FORCED_OFFLINE:
+<!-- ##### STRUCT EShellModule ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL EShellModule::activity-added ##### -->
+<para>
+
+</para>
+
+@eshellmodule: the object which received the signal.
+@arg1:
+
+<!-- ##### ARG EShellModule:filename ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG EShellModule:shell ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT EShellModuleInfo ##### -->
+<para>
+
+</para>
+
+@name:
+@aliases:
+@schemes:
+@sort_order:
+@start:
+@is_busy:
+@shutdown:
+@migrate:
+
+<!-- ##### ARG EShellView:shell-module ##### -->
+<para>
+
+</para>
+
+
<!-- ##### STRUCT EShellWindowPrivate ##### -->
<para>
@@ -1805,6 +1875,24 @@ intelligent
@shell:
@Returns:
+<!-- ##### FUNCTION e_shell_get_module_by_name ##### -->
+<para>
+
+</para>
+
+@shell:
+@name:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_get_module_by_scheme ##### -->
+<para>
+
+</para>
+
+@shell:
+@scheme:
+@Returns:
+
<!-- ##### FUNCTION e_shell_get_online_mode ##### -->
<para>
@@ -1821,6 +1909,14 @@ intelligent
@shell:
@Returns:
+<!-- ##### FUNCTION e_shell_get_shell_modules ##### -->
+<para>
+
+</para>
+
+@shell:
+@Returns:
+
<!-- ##### FUNCTION e_shell_get_shell_windows ##### -->
<para>
@@ -1887,6 +1983,116 @@ intelligent
@Returns:
+<!-- ##### FUNCTION e_shell_module_add_activity ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@activity:
+
+<!-- ##### FUNCTION e_shell_module_compare ##### -->
+<para>
+
+</para>
+
+@shell_module_a:
+@shell_module_b:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_get_config_dir ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_get_data_dir ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_get_filename ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_get_shell ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_get_shell_view_type ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_is_busy ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_migrate ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@major:
+@minor:
+@micro:
+@error:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_new ##### -->
+<para>
+
+</para>
+
+@shell:
+@filename:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_set_info ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@info:
+@shell_view_type:
+
+<!-- ##### FUNCTION e_shell_module_shutdown ##### -->
+<para>
+
+</para>
+
+@shell_module:
+@Returns:
+
+<!-- ##### FUNCTION e_shell_module_start ##### -->
+<para>
+
+</para>
+
+@shell_module:
+
<!-- ##### FUNCTION e_shell_module_upgrade ##### -->
<para>
@@ -1931,6 +2137,14 @@ intelligent
@shell:
@Returns:
+<!-- ##### FUNCTION e_shell_view_get_shell_module ##### -->
+<para>
+
+</para>
+
+@shell_view:
+@Returns:
+
<!-- ##### VARIABLE e_test_shell_view_type ##### -->
<para>
generated by cgit (git 2.34.1) at 2024-12-27 15:04:49 +0800