aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@src.gnome.org>2008-10-02 02:58:37 +0800
committerMatthew Barnes <mbarnes@src.gnome.org>2008-10-02 02:58:37 +0800
commite52986f4225cbe8496043da74ca250521d244705 (patch)
treeb77ea07323e7ae339410012e672e643c1502eb91 /doc
parentc6795be3a8b7b17ced9e99e17db9ac6cbed6e018 (diff)
downloadgsoc2013-evolution-e52986f4225cbe8496043da74ca250521d244705.tar.gz
gsoc2013-evolution-e52986f4225cbe8496043da74ca250521d244705.tar.zst
gsoc2013-evolution-e52986f4225cbe8496043da74ca250521d244705.zip
Add more EShell API documentation.
svn path=/branches/kill-bonobo/; revision=36533
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/shell/eshell-sections.txt25
-rw-r--r--doc/reference/shell/tmpl/e-shell-view.sgml27
-rw-r--r--doc/reference/shell/tmpl/eshell-unused.sgml8
3 files changed, 42 insertions, 18 deletions
diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt
index fc9a599558..2a7b3d81b2 100644
--- a/doc/reference/shell/eshell-sections.txt
+++ b/doc/reference/shell/eshell-sections.txt
@@ -23,10 +23,11 @@ e_shell_quit
E_SHELL
E_IS_SHELL
E_TYPE_SHELL
-e_shell_get_type
E_SHELL_CLASS
E_IS_SHELL_CLASS
E_SHELL_GET_CLASS
+EShellClass
+e_shell_get_type
<SUBSECTION Private>
EShellPrivate
</SECTION>
@@ -35,6 +36,7 @@ EShellPrivate
<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
@@ -42,7 +44,6 @@ 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_add_activity
e_shell_view_get_page_num
e_shell_view_get_size_group
e_shell_view_get_shell_content
@@ -56,10 +57,10 @@ e_shell_view_show_popup_menu
E_SHELL_VIEW
E_IS_SHELL_VIEW
E_TYPE_SHELL_VIEW
-e_shell_view_get_type
E_SHELL_VIEW_CLASS
E_IS_SHELL_VIEW_CLASS
E_SHELL_VIEW_GET_CLASS
+e_shell_view_get_type
<SUBSECTION Private>
EShellViewPrivate
</SECTION>
@@ -79,10 +80,11 @@ e_shell_switcher_set_visible
E_SHELL_SWITCHER
E_IS_SHELL_SWITCHER
E_TYPE_SHELL_SWITCHER
-e_shell_switcher_get_type
E_SHELL_SWITCHER_CLASS
E_IS_SHELL_SWITCHER_CLASS
E_SHELL_SWITCHER_GET_CLASS
+EShellSwitcherClass
+e_shell_switcher_get_type
<SUBSECTION Private>
EShellSwitcherPrivate
E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE
@@ -97,10 +99,11 @@ e_shell_sidebar_new
E_SHELL_SIDEBAR
E_IS_SHELL_SIDEBAR
E_TYPE_SHELL_SIDEBAR
-e_shell_sidebar_get_type
E_SHELL_SIDEBAR_CLASS
E_IS_SHELL_SIDEBAR_CLASS
E_SHELL_SIDEBAR_GET_CLASS
+EShellSidebarClass
+e_shell_sidebar_get_type
<SUBSECTION Private>
EShellSidebarPrivate
</SECTION>
@@ -114,10 +117,11 @@ e_shell_taskbar_new
E_SHELL_TASKBAR
E_IS_SHELL_TASKBAR
E_TYPE_SHELL_TASKBAR
-e_shell_taskbar_get_type
E_SHELL_TASKBAR_CLASS
E_IS_SHELL_TASKBAR_CLASS
E_SHELL_TASKBAR_GET_CLASS
+EShellTaskbarClass
+e_shell_taskbar_get_type
<SUBSECTION Private>
EShellTaskbarPrivate
</SECTION>
@@ -142,10 +146,11 @@ e_shell_module_set_info
E_SHELL_MODULE
E_IS_SHELL_MODULE
E_TYPE_SHELL_MODULE
-e_shell_module_get_type
E_SHELL_MODULE_CLASS
E_IS_SHELL_MODULE_CLASS
E_SHELL_MODULE_GET_CLASS
+EShellModuleClass
+e_shell_module_get_type
<SUBSECTION Private>
EShellModulePrivate
</SECTION>
@@ -159,10 +164,11 @@ e_shell_content_new
E_SHELL_CONTENT
E_IS_SHELL_CONTENT
E_TYPE_SHELL_CONTENT
-e_shell_content_get_type
E_SHELL_CONTENT_CLASS
E_IS_SHELL_CONTENT_CLASS
E_SHELL_CONTENT_GET_CLASS
+EShellContentClass
+e_shell_content_get_type
<SUBSECTION Private>
EShellContentPrivate
</SECTION>
@@ -188,10 +194,11 @@ e_shell_window_register_new_source_actions
E_SHELL_WINDOW
E_IS_SHELL_WINDOW
E_TYPE_SHELL_WINDOW
-e_shell_window_get_type
E_SHELL_WINDOW_CLASS
E_IS_SHELL_WINDOW_CLASS
E_SHELL_WINDOW_GET_CLASS
+EShellWindowClass
+e_shell_window_get_type
<SUBSECTION Private>
EShellWindowPrivate
E_SHELL_WINDOW_ACTION
diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml
index b6d35b18be..b5ee5e22a6 100644
--- a/doc/reference/shell/tmpl/e-shell-view.sgml
+++ b/doc/reference/shell/tmpl/e-shell-view.sgml
@@ -77,6 +77,24 @@ EShellView
</para>
+<!-- ##### STRUCT EShellViewClass ##### -->
+<para>
+
+</para>
+
+@parent_class:
+@label:
+@icon_name:
+@ui_definition:
+@search_options:
+@type_module:
+@view_collection:
+@new_shell_content:
+@new_shell_sidebar:
+@new_shell_taskbar:
+@toggled:
+@update_actions:
+
<!-- ##### FUNCTION e_shell_view_get_name ##### -->
<para>
@@ -140,15 +158,6 @@ EShellView
@Returns:
-<!-- ##### FUNCTION e_shell_view_add_activity ##### -->
-<para>
-
-</para>
-
-@shell_view:
-@activity:
-
-
<!-- ##### FUNCTION e_shell_view_get_page_num ##### -->
<para>
diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml
index 9360a7003c..80bd636991 100644
--- a/doc/reference/shell/tmpl/eshell-unused.sgml
+++ b/doc/reference/shell/tmpl/eshell-unused.sgml
@@ -5,3 +5,11 @@
@window:
+<!-- ##### FUNCTION e_shell_view_add_activity ##### -->
+<para>
+
+</para>
+
+@shell_view:
+@activity:
+