evolution r36806 - in branches/kill-bonobo: doc/reference/shell doc/reference/shell/tmpl shell

From: mbarnes svn gnome org
To: svn-commits-list gnome org
Subject: evolution r36806 - in branches/kill-bonobo: doc/reference/shell doc/reference/shell/tmpl shell
Date: Wed, 19 Nov 2008 23:54:02 +0000 (UTC)
Author: mbarnes
Date: Wed Nov 19 23:54:02 2008
New Revision: 36806
URL: http://svn.gnome.org/viewvc/evolution?rev=36806&view=rev

Log:
Documentation improvements.


Modified:
   branches/kill-bonobo/doc/reference/shell/eshell-docs.sgml
   branches/kill-bonobo/doc/reference/shell/eshell-sections.txt
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-content.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-module.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-sidebar.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-taskbar.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-view.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-window.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/e-shell.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/eshell-unused.sgml
   branches/kill-bonobo/doc/reference/shell/tmpl/shell-actions.sgml
   branches/kill-bonobo/shell/e-shell-migrate.h
   branches/kill-bonobo/shell/e-shell-module.h
   branches/kill-bonobo/shell/e-shell-sidebar.c
   branches/kill-bonobo/shell/e-shell-switcher.c
   branches/kill-bonobo/shell/e-shell.c

Modified: branches/kill-bonobo/doc/reference/shell/eshell-docs.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/eshell-docs.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/eshell-docs.sgml	Wed Nov 19 23:54:02 2008
@@ -5,9 +5,9 @@
   <bookinfo>
     <title>Evolution Shell Reference Manual</title>
     <releaseinfo>
-      for eshell [VERSION]
       The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://[SERVER]/eshell/index.html";>http://[SERVER]/eshell/</ulink>.
+      <ulink role="online-location"
+url="http://mbarnes.fedorapeople.org/docs/eshell/";>http://mbarnes.fedorapeople.org/docs/eshell/</ulink>.
     </releaseinfo>
   </bookinfo>
 
@@ -20,6 +20,7 @@
     <xi:include href="xml/e-shell-content.xml"/>
     <xi:include href="xml/e-shell-sidebar.xml"/>
     <xi:include href="xml/e-shell-taskbar.xml"/>
+    <xi:include href="xml/e-shell-settings.xml"/>
     <xi:include href="xml/e-shell-switcher.xml"/>
     <xi:include href="xml/e-shell-importer.xml"/>
   </chapter>
@@ -30,6 +31,11 @@
     <xi:include href="xml/action-groups.xml"/>
   </chapter>
 
+  <chapter>
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+
   <index>
     <title>Index</title>
   </index>

Modified: branches/kill-bonobo/doc/reference/shell/eshell-sections.txt
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/eshell-sections.txt	(original)
+++ branches/kill-bonobo/doc/reference/shell/eshell-sections.txt	Wed Nov 19 23:54:02 2008
@@ -3,12 +3,14 @@
 <TITLE>EShell</TITLE>
 EShell
 EShellLineStatus
-e_shell_new
+e_shell_get_default
 e_shell_list_modules
 e_shell_get_canonical_name
 e_shell_get_module_by_name
 e_shell_get_module_by_scheme
+e_shell_get_settings
 e_shell_create_window
+e_shell_get_focused_window
 e_shell_handle_uri
 e_shell_send_receive
 e_shell_get_online_mode
@@ -16,6 +18,7 @@
 e_shell_get_line_status
 e_shell_set_line_status
 e_shell_get_preferences_window
+e_shell_event
 e_shell_is_busy
 e_shell_do_quit
 e_shell_quit
@@ -40,6 +43,7 @@
 <TITLE>EShellContent</TITLE>
 EShellContent
 e_shell_content_new
+e_shell_content_check_state
 e_shell_content_get_shell_view
 e_shell_content_get_context
 e_shell_content_set_context
@@ -94,6 +98,7 @@
 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_is_busy
 e_shell_module_shutdown
@@ -113,10 +118,30 @@
 </SECTION>
 
 <SECTION>
+<FILE>e-shell-settings</FILE>
+<TITLE>EShellSettings</TITLE>
+EShellSettings
+e_shell_settings_install_property
+e_shell_settings_bind_to_gconf
+<SUBSECTION Standard>
+E_SHELL_SETTINGS
+E_IS_SHELL_SETTINGS
+E_TYPE_SHELL_SETTINGS
+E_SHELL_SETTINGS_CLASS
+E_IS_SHELL_SETTINGS_CLASS
+E_SHELL_SETTINGS_GET_CLASS
+EShellSettingsClass
+e_shell_settings_get_type
+<SUBSECTION Private>
+EShellSettingsPrivate
+</SECTION>
+
+<SECTION>
 <FILE>e-shell-sidebar</FILE>
 <TITLE>EShellSidebar</TITLE>
 EShellSidebar
 e_shell_sidebar_new
+e_shell_sidebar_check_state
 e_shell_sidebar_get_shell_view
 e_shell_sidebar_get_primary_text
 e_shell_sidebar_set_primary_text
@@ -195,6 +220,7 @@
 e_shell_view_set_view_id
 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_content
 e_shell_view_get_shell_sidebar
@@ -203,6 +229,7 @@
 e_shell_view_get_shell_module
 e_shell_view_update_actions
 e_shell_view_show_popup_menu
+e_shell_view_new_view_instance
 <SUBSECTION Standard>
 E_SHELL_VIEW
 E_IS_SHELL_VIEW
@@ -222,6 +249,7 @@
 e_shell_window_new
 e_shell_window_get_shell
 e_shell_window_get_shell_view
+e_shell_window_get_shell_view_action
 e_shell_window_get_ui_manager
 e_shell_window_get_action
 e_shell_window_get_action_group
@@ -281,6 +309,7 @@
 E_SHELL_WINDOW_ACTION_SHOW_SWITCHER
 E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR
 E_SHELL_WINDOW_ACTION_SUBMIT_BUG
+E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL
 E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH
 E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS
 E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_TEXT

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-content.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-content.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-content.sgml	Wed Nov 19 23:54:02 2008
@@ -92,3 +92,279 @@
 @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: 
+
+

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-module.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-module.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-module.sgml	Wed Nov 19 23:54:02 2008
@@ -110,6 +110,15 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_shell_module_get_shell_view_type ##### -->
+<para>
+
+</para>
+
+ shell_module: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_shell_module_add_activity ##### -->
 <para>
 

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-sidebar.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-sidebar.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-sidebar.sgml	Wed Nov 19 23:54:02 2008
@@ -47,3 +47,57 @@
 @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: 
+
+

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-taskbar.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-taskbar.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-taskbar.sgml	Wed Nov 19 23:54:02 2008
@@ -42,3 +42,38 @@
 @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: 
+
+

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-view.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-view.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-view.sgml	Wed Nov 19 23:54:02 2008
@@ -168,6 +168,15 @@
 @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 @@
 @event: 
 
 
+<!-- ##### FUNCTION e_shell_view_new_view_instance ##### -->
+<para>
+
+</para>
+
+ shell_view: 
+ instance_id: 
+ Returns: 
+
+

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-window.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-window.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell-window.sgml	Wed Nov 19 23:54:02 2008
@@ -57,3 +57,120 @@
 @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: 
+
+

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/e-shell.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/e-shell.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/e-shell.sgml	Wed Nov 19 23:54:02 2008
@@ -84,6 +84,14 @@
 @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 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_shell_get_settings ##### -->
+<para>
+
+</para>
+
+ shell: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_shell_create_window ##### -->
 <para>
 
@@ -132,6 +149,15 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_shell_get_focused_window ##### -->
+<para>
+
+</para>
+
+ shell: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_shell_handle_uri ##### -->
 <para>
 
@@ -195,6 +221,16 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_shell_event ##### -->
+<para>
+
+</para>
+
+ shell: 
+ event_name: 
+ event_data: 
+
+
 <!-- ##### FUNCTION e_shell_is_busy ##### -->
 <para>
 

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/eshell-unused.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/eshell-unused.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/eshell-unused.sgml	Wed Nov 19 23:54:02 2008
@@ -142,6 +142,30 @@
 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 @@
 @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 @@
 </para>
 
 
+<!-- ##### FUNCTION e_shell_migrate_error_quark ##### -->
+<para>
+
+</para>
+
+ Returns: 
+
 <!-- ##### FUNCTION e_shell_module_upgrade ##### -->
 <para>
 
@@ -1972,77 +1766,6 @@
 @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 @@
 @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>
 

Modified: branches/kill-bonobo/doc/reference/shell/tmpl/shell-actions.sgml
==============================================================================
--- branches/kill-bonobo/doc/reference/shell/tmpl/shell-actions.sgml	(original)
+++ branches/kill-bonobo/doc/reference/shell/tmpl/shell-actions.sgml	Wed Nov 19 23:54:02 2008
@@ -225,6 +225,14 @@
 @window: 
 
 
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL ##### -->
+<para>
+
+</para>
+
+ window: 
+
+
 <!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH ##### -->
 <para>
 

Modified: branches/kill-bonobo/shell/e-shell-migrate.h
==============================================================================
--- branches/kill-bonobo/shell/e-shell-migrate.h	(original)
+++ branches/kill-bonobo/shell/e-shell-migrate.h	Wed Nov 19 23:54:02 2008
@@ -27,6 +27,13 @@
 #include <shell/e-shell-common.h>
 #include <shell/e-shell.h>
 
+/**
+ * E_SHELL_MIGRATE_ERROR:
+ *
+ * Error domain for migration operations.  Errors in this domain will be
+ * from the #EShellMigrateError enumeration.  See #GError for information
+ * on error domains.
+ **/
 #define E_SHELL_MIGRATE_ERROR \
 	(e_shell_migrate_error_quark ())
 

Modified: branches/kill-bonobo/shell/e-shell-module.h
==============================================================================
--- branches/kill-bonobo/shell/e-shell-module.h	(original)
+++ branches/kill-bonobo/shell/e-shell-module.h	Wed Nov 19 23:54:02 2008
@@ -60,9 +60,6 @@
 typedef struct _EShellModuleClass EShellModuleClass;
 typedef struct _EShellModulePrivate EShellModulePrivate;
 
-typedef struct _EShellModuleEvent EShellModuleEvent;
-typedef void (*EShellModuleEventFunc) (EShellModuleEvent *event);
-
 /**
  * EShellModuleInfo:
  * @name:	The name of the module.  Also becomes the name of

Modified: branches/kill-bonobo/shell/e-shell-sidebar.c
==============================================================================
--- branches/kill-bonobo/shell/e-shell-sidebar.c	(original)
+++ branches/kill-bonobo/shell/e-shell-sidebar.c	Wed Nov 19 23:54:02 2008
@@ -333,7 +333,7 @@
 	container_class->forall = shell_sidebar_forall;
 
 	/**
-	 * EShellTaskbar:primary-text
+	 * EShellSidebar:primary-text
 	 *
 	 * The primary text is displayed in bold at the top of the sidebar.
 	 **/
@@ -348,7 +348,7 @@
 			G_PARAM_READWRITE));
 
 	/**
-	 * EShellTaskbar:secondary-text
+	 * EShellSidebar:secondary-text
 	 *
 	 * The secondary text is displayed in a smaller font at the top of
 	 * the sidebar.
@@ -448,7 +448,7 @@
 
 /**
  * e_shell_sidebar_check_state:
- * @shell_sidebar an #EShellSidebar
+ * @shell_sidebar: an #EShellSidebar
  *
  * #EShellSidebar subclasses should implement the
  * <structfield>check_state</structfield> method in #EShellSidebarClass
@@ -511,6 +511,7 @@
 /**
  * e_shell_sidebar_set_primary_text:
  * @shell_sidebar: an #EShellSidebar
+ * @primary_text: text to be displayed in a bold font
  *
  * Sets the primary text for @shell_sidebar.
  *
@@ -566,6 +567,7 @@
 /**
  * e_shell_sidebar_set_secondary_text:
  * @shell_sidebar: an #EShellSidebar
+ * @secondary_text: text to be displayed in a smaller font
  *
  * Sets the secondary text for @shell_sidebar.
  *

Modified: branches/kill-bonobo/shell/e-shell-switcher.c
==============================================================================
--- branches/kill-bonobo/shell/e-shell-switcher.c	(original)
+++ branches/kill-bonobo/shell/e-shell-switcher.c	Wed Nov 19 23:54:02 2008
@@ -673,6 +673,7 @@
 /**
  * e_shell_switcher_set_visible:
  * @switcher: an #EShellSwitcher
+ * @visible: whether the switcher buttons should be visible
  *
  * Sets the switcher button visiblity to @visible.
  *

Modified: branches/kill-bonobo/shell/e-shell.c
==============================================================================
--- branches/kill-bonobo/shell/e-shell.c	(original)
+++ branches/kill-bonobo/shell/e-shell.c	Wed Nov 19 23:54:02 2008
@@ -360,6 +360,11 @@
 	object_class->finalize = shell_finalize;
 	object_class->constructed = shell_constructed;
 
+	/**
+	 * EShell:online-mode
+	 *
+	 * Whether the shell is online.
+	 **/
 	g_object_class_install_property (
 		object_class,
 		PROP_ONLINE_MODE,
@@ -371,6 +376,11 @@
 			G_PARAM_READWRITE |
 			G_PARAM_CONSTRUCT));
 
+	/**
+	 * EShell:settings
+	 *
+	 * The #EShellSettings object stores application settings.
+	 **/
 	g_object_class_install_property (
 		object_class,
 		PROP_SETTINGS,
@@ -381,6 +391,15 @@
 			E_TYPE_SHELL_SETTINGS,
 			G_PARAM_READABLE));
 
+	/**
+	 * EShell::event
+	 * @shell: the #EShell which emitted the signal
+	 * @event_data: data associated with the event
+	 *
+	 * This signal is used to broadcast custom events to the entire
+	 * application.  The nature of @event_data depends on the event
+	 * being broadcast.  The signal's detail denotes the event.
+	 **/
 	signals[EVENT] = g_signal_new (
 		"event",
 		G_OBJECT_CLASS_TYPE (object_class),
@@ -390,6 +409,18 @@
 		G_TYPE_NONE, 1,
 		G_TYPE_POINTER);
 
+	/**
+	 * EShell:handle-uri
+	 * @shell: the #EShell which emitted the signal
+	 * @uri: the URI to be handled
+	 *
+	 * Emitted when @shell receives a URI to be handled, usually by
+	 * way of a command-line argument.  An #EShellModule should listen
+	 * for this signal and try to handle the URI, usually by opening an
+	 * editor window for the identified resource.
+	 *
+	 * Returns: %TRUE if the URI could be handled, %FALSE otherwise
+	 **/
 	signals[HANDLE_URI] = g_signal_new (
 		"handle-uri",
 		G_OBJECT_CLASS_TYPE (object_class),
@@ -399,6 +430,14 @@
 		G_TYPE_BOOLEAN, 1,
 		G_TYPE_STRING);
 
+	/**
+	 * EShell:send-receive
+	 * @shell: the #EShell which emitted the signal
+	 * @parent: a parent #GtkWindow
+	 *
+	 * Emitted when the user chooses the "Send / Receive" action.
+	 * The parent window can be used for showing transient windows.
+	 **/
 	signals[SEND_RECEIVE] = g_signal_new (
 		"send-receive",
 		G_OBJECT_CLASS_TYPE (object_class),
@@ -408,6 +447,13 @@
 		G_TYPE_NONE, 1,
 		GTK_TYPE_WINDOW);
 
+	/**
+	 * EShell:window-created
+	 * @shell: the #EShell which emitted the signal
+	 * @shell_window: the newly created #EShellWindow
+	 *
+	 * Emitted when a new #EShellWindow is created.
+	 **/
 	signals[WINDOW_CREATED] = g_signal_new (
 		"window-created",
 		G_OBJECT_CLASS_TYPE (object_class),
@@ -417,6 +463,13 @@
 		G_TYPE_NONE, 1,
 		E_TYPE_SHELL_WINDOW);
 
+	/**
+	 * EShell:window-destroyed
+	 * @shell: the #EShell which emitted the signal
+	 * @last_window: whether that was the last #EShellWindow
+	 *
+	 * Emitted when an #EShellWindow is destroyed.
+	 **/
 	signals[WINDOW_DESTROYED] = g_signal_new (
 		"window-destroyed",
 		G_OBJECT_CLASS_TYPE (object_class),
@@ -476,6 +529,13 @@
 	return type;
 }
 
+/**
+ * e_shell_get_default:
+ *
+ * Returns the #EShell created by <function>main()</function>.
+ *
+ * Returns: the #EShell singleton
+ **/
 EShell *
 e_shell_get_default (void)
 {
@@ -485,6 +545,15 @@
 	return default_shell;
 }
 
+/**
+ * e_shell_list_modules:
+ * @shell: an #EShell
+ *
+ * Returns a list of loaded #EShellModule instances.  The list is
+ * owned by @shell and should not be modified or freed.
+ *
+ * Returns: a list of loaded #EShellModule instances
+ **/
 GList *
 e_shell_list_modules (EShell *shell)
 {
@@ -493,6 +562,18 @@
 	return shell->priv->loaded_modules;
 }
 
+/**
+ * e_shell_get_canonical_name:
+ * @shell: an #EShell
+ * @name: the name or alias of an #EShellModule
+ *
+ * Returns the canonical name for the #EShellModule whose name or alias
+ * is @name.
+ *
+ * XXX Not sure this function is worth keeping around.
+ *
+ * Returns: the canonical #EShellModule name
+ **/
 const gchar *
 e_shell_get_canonical_name (EShell *shell,
                             const gchar *name)
@@ -513,6 +594,16 @@
 	return G_TYPE_MODULE (shell_module)->name;
 }
 
+/**
+ * e_shell_get_module_by_name:
+ * @shell: an #EShell
+ * @name: the name or alias of an #EShellModule
+ *
+ * Returns the corresponding #EShellModule for the given name or alias,
+ * or %NULL if @name is not recognized.
+ *
+ * Returns: the #EShellModule named @name, or %NULL
+ **/
 EShellModule *
 e_shell_get_module_by_name (EShell *shell,
                             const gchar *name)
@@ -527,6 +618,16 @@
 	return g_hash_table_lookup (hash_table, name);
 }
 
+/**
+ * e_shell_get_module_by_scheme:
+ * @shell: an #EShell
+ * @scheme: a URI scheme
+ *
+ * Returns the #EShellModule that implements the given URI scheme,
+ * or %NULL if @scheme is not recognized.
+ *
+ * Returns: the #EShellModule that implements @scheme, or %NULL
+ **/
 EShellModule *
 e_shell_get_module_by_scheme (EShell *shell,
                               const gchar *scheme)
@@ -541,6 +642,14 @@
 	return g_hash_table_lookup (hash_table, scheme);
 }
 
+/**
+ * e_shell_get_settings:
+ * @shell: an #EShell
+ *
+ * Returns the #EShellSettings instance for @shell.
+ *
+ * Returns: the #EShellSettings instance for @shell
+ **/
 EShellSettings *
 e_shell_get_settings (EShell *shell)
 {
@@ -549,6 +658,16 @@
 	return shell->priv->settings;
 }
 
+/**
+ * e_shell_create_window:
+ * @shell: an #EShell
+ *
+ * Creates a new #EShellWindow and emits the #EShell::window-created
+ * signal.  Use this function instead of e_shell_window_new() so that
+ * @shell can track the window.
+ *
+ * Returns: a new #EShellWindow
+ **/
 GtkWidget *
 e_shell_create_window (EShell *shell)
 {
@@ -582,6 +701,16 @@
 	return shell_window;
 }
 
+/**
+ * e_shell_get_focused_window:
+ * @shell: an #EShell
+ *
+ * Returns the most recently focused #EShellWindow.  Useful for choosing
+ * a parent for a transient window.  This only works for windows created
+ * with e_shell_create_window().
+ *
+ * Returns: the most recently focused #EShellWindow
+ **/
 GtkWidget *
 e_shell_get_focused_window (EShell *shell)
 {
@@ -593,6 +722,15 @@
 	return GTK_WIDGET (shell->priv->active_windows->data);
 }
 
+/**
+ * e_shell_handle_uri:
+ * @shell: an #EShell
+ * @uri: the URI to be handled
+ *
+ * Emits the #EShell::handle-uri signal.
+ *
+ * Returns: %TRUE if the URI was handled, %FALSE otherwise
+ **/
 gboolean
 e_shell_handle_uri (EShell *shell,
                     const gchar *uri)
@@ -607,6 +745,13 @@
 	return handled;
 }
 
+/**
+ * e_shell_send_receive:
+ * @shell: an #EShell
+ * @parent: the parent #GtkWindow
+ *
+ * Emits the #EShell::send-receive signal.
+ **/
 void
 e_shell_send_receive (EShell *shell,
                       GtkWindow *parent)
@@ -661,6 +806,17 @@
 	return preferences_window;
 }
 
+/**
+ * e_shell_event:
+ * @shell: an #EShell
+ * @event_name: the name of the event
+ * @event_data: data associated with the event
+ *
+ * The #EShell::event signal acts as a cheap mechanism for broadcasting
+ * events to the rest of the application, such as new mail arriving.  The
+ * @event_name is used as the signal detail, and @event_data may point to
+ * an object or data structure associated with the event.
+ **/
 void
 e_shell_event (EShell *shell,
                const gchar *event_name,
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]