aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2009-12-02 08:38:52 +0800
committerMatthew Barnes <mbarnes@redhat.com>2009-12-02 11:27:11 +0800
commit793e57e24ca2ac458baa0897ad971dfbf08e8291 (patch)
treebaf73cba7ce97485e03502d4eab2f551120bfb7e /doc/reference
parent9379111ae48dd0e9eaea3fcdd14593414a60c115 (diff)
downloadgsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.tar
gsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.tar.gz
gsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.tar.bz2
gsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.tar.lz
gsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.tar.xz
gsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.tar.zst
gsoc2013-evolution-793e57e24ca2ac458baa0897ad971dfbf08e8291.zip
Add private virtual methods to EShellWindowClass.
So Anjal can override what it needs to for its own purpose. Also makes the EShellWindow design a little cleaner. Methods added: GtkWidget * (*construct_menubar) (EShellWindow *shell_window); GtkWidget * (*construct_toolbar) (EShellWindow *shell_window); GtkWidget * (*construct_sidebar) (EShellWindow *shell_window); GtkWidget * (*construct_content) (EShellWindow *shell_window); GtkWidget * (*construct_taskbar) (EShellWindow *shell_window); EShellView * (*create_shell_view) (EShellWindow *shell_window, const gchar *view_name); Also added some new GObject properties to help decouple actions from internal EShellWindow widgets created by these methods: EShellWindow:sidebar-visible EShellWindow:switcher-visible EShellWindow:taskbar-visible EShellWindow:toolbar-visible
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/shell/eshell-docs.sgml2
-rw-r--r--doc/reference/shell/eshell-sections.txt53
-rw-r--r--doc/reference/shell/tmpl/e-alert.sgml173
-rw-r--r--doc/reference/shell/tmpl/e-error.sgml19
-rw-r--r--doc/reference/shell/tmpl/e-shell-taskbar.sgml9
-rw-r--r--doc/reference/shell/tmpl/e-shell-window.sgml92
-rw-r--r--doc/reference/shell/tmpl/eshell-unused.sgml31
-rw-r--r--doc/reference/shell/tmpl/shell-actions.sgml4
8 files changed, 341 insertions, 42 deletions
diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml
index 78a9e5a432..9c4e875992 100644
--- a/doc/reference/shell/eshell-docs.sgml
+++ b/doc/reference/shell/eshell-docs.sgml
@@ -28,12 +28,12 @@ url="http://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.o
<chapter>
<title>Basic Utility Functions</title>
<xi:include href="xml/e-account-utils.xml"/>
+ <xi:include href="xml/e-alert.xml"/>
<xi:include href="xml/e-bit-array.xml"/>
<xi:include href="xml/e-binding.xml"/>
<xi:include href="xml/e-categories-config.xml"/>
<xi:include href="xml/e-datetime-format.xml"/>
<xi:include href="xml/e-dialog-utils.xml"/>
- <xi:include href="xml/e-error.xml"/>
<xi:include href="xml/e-html-utils.xml"/>
<xi:include href="xml/e-icon-factory.xml"/>
<xi:include href="xml/e-logger.xml"/>
diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt
index 491d1b2945..e43bc6d99b 100644
--- a/doc/reference/shell/eshell-sections.txt
+++ b/doc/reference/shell/eshell-sections.txt
@@ -202,6 +202,7 @@ e_shell_taskbar_get_shell_view
e_shell_taskbar_get_message
e_shell_taskbar_set_message
e_shell_taskbar_unset_message
+e_shell_taskbar_get_activity_count
<SUBSECTION Standard>
E_SHELL_TASKBAR
E_IS_SHELL_TASKBAR
@@ -279,6 +280,14 @@ e_shell_window_set_active_view
e_shell_window_get_safe_mode
e_shell_window_set_safe_mode
e_shell_window_add_action_group
+e_shell_window_get_sidebar_visible
+e_shell_window_set_sidebar_visible
+e_shell_window_get_switcher_visible
+e_shell_window_set_switcher_visible
+e_shell_window_get_taskbar_visible
+e_shell_window_set_taskbar_visible
+e_shell_window_get_toolbar_visible
+e_shell_window_set_toolbar_visible
e_shell_window_register_new_item_actions
e_shell_window_register_new_source_actions
<SUBSECTION Standard>
@@ -307,6 +316,29 @@ e_get_account_by_uid
</SECTION>
<SECTION>
+<FILE>e-alert</FILE>
+<TITLE>User Alert Handling</TITLE>
+E_ALERT_INFO
+E_ALERT_INFO_PRIMARY
+E_ALERT_WARNING
+E_ALERT_WARNING_PRIMARY
+E_ALERT_ERROR
+E_ALERT_ERROR_PRIMARY
+E_ALERT_ASK_FILE_EXISTS_OVERWRITE
+E_ALERT_NO_SAVE_FILE
+E_ALERT_NO_LOAD_FILE
+EAlert
+e_alert_new
+e_alert_newv
+e_alert_free
+e_alert_new_dialog
+e_alert_new_dialog_for_args
+e_alert_run_dialog
+e_alert_run_dialog_for_args
+e_alert_dialog_count_buttons
+</SECTION>
+
+<SECTION>
<FILE>e-binding</FILE>
<TITLE>GObject Property Bindings</TITLE>
EBinding
@@ -383,25 +415,6 @@ e_dialog_combo_box_get
</SECTION>
<SECTION>
-<FILE>e-error</FILE>
-<TITLE>Error Dialogs</TITLE>
-E_ERROR_INFO
-E_ERROR_INFO_PRIMARY
-E_ERROR_WARNING
-E_ERROR_WARNING_PRIMARY
-E_ERROR_ERROR
-E_ERROR_ERROR_PRIMARY
-E_ERROR_ASK_FILE_EXISTS_OVERWRITE
-E_ERROR_NO_SAVE_FILE
-E_ERROR_NO_LOAD_FILE
-e_error_new
-e_error_newv
-e_error_run
-e_error_runv
-e_error_count_buttons
-</SECTION>
-
-<SECTION>
<FILE>e-html-utils</FILE>
<TITLE>Text to HTML Conversion</TITLE>
E_TEXT_TO_HTML_PRE
@@ -682,8 +695,8 @@ E_SHELL_WINDOW_ACTION_SEARCH_QUICK
E_SHELL_WINDOW_ACTION_SEARCH_SAVE
E_SHELL_WINDOW_ACTION_SEND_RECEIVE
E_SHELL_WINDOW_ACTION_SHOW_SIDEBAR
-E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR
E_SHELL_WINDOW_ACTION_SHOW_SWITCHER
+E_SHELL_WINDOW_ACTION_SHOW_TASKBAR
E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR
E_SHELL_WINDOW_ACTION_SUBMIT_BUG
E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL
diff --git a/doc/reference/shell/tmpl/e-alert.sgml b/doc/reference/shell/tmpl/e-alert.sgml
new file mode 100644
index 0000000000..d61c8a5888
--- /dev/null
+++ b/doc/reference/shell/tmpl/e-alert.sgml
@@ -0,0 +1,173 @@
+<!-- ##### SECTION Title ##### -->
+User Alert Handling
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO E_ALERT_INFO ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_INFO_PRIMARY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_WARNING ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_WARNING_PRIMARY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_ERROR_PRIMARY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_ASK_FILE_EXISTS_OVERWRITE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_NO_SAVE_FILE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_ALERT_NO_LOAD_FILE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### STRUCT EAlert ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION e_alert_new ##### -->
+<para>
+
+</para>
+
+@tag:
+@arg0:
+@Varargs:
+@Returns:
+
+
+<!-- ##### FUNCTION e_alert_newv ##### -->
+<para>
+
+</para>
+
+@tag:
+@arg0:
+@ap:
+@Returns:
+
+
+<!-- ##### FUNCTION e_alert_free ##### -->
+<para>
+
+</para>
+
+@alert:
+
+
+<!-- ##### FUNCTION e_alert_new_dialog ##### -->
+<para>
+
+</para>
+
+@parent:
+@alert:
+@Returns:
+
+
+<!-- ##### FUNCTION e_alert_new_dialog_for_args ##### -->
+<para>
+
+</para>
+
+@parent:
+@tag:
+@arg0:
+@Varargs:
+@Returns:
+
+
+<!-- ##### FUNCTION e_alert_run_dialog ##### -->
+<para>
+
+</para>
+
+@parent:
+@alert:
+@Returns:
+
+
+<!-- ##### FUNCTION e_alert_run_dialog_for_args ##### -->
+<para>
+
+</para>
+
+@parent:
+@tag:
+@arg0:
+@Varargs:
+@Returns:
+
+
+<!-- ##### FUNCTION e_alert_dialog_count_buttons ##### -->
+<para>
+
+</para>
+
+@dialog:
+@Returns:
+
+
diff --git a/doc/reference/shell/tmpl/e-error.sgml b/doc/reference/shell/tmpl/e-error.sgml
deleted file mode 100644
index 0aaf3e01c6..0000000000
--- a/doc/reference/shell/tmpl/e-error.sgml
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Error Dialog Functions
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</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 6aa90f1c72..f1bbdf02ef 100644
--- a/doc/reference/shell/tmpl/e-shell-taskbar.sgml
+++ b/doc/reference/shell/tmpl/e-shell-taskbar.sgml
@@ -77,3 +77,12 @@ EShellTaskbar
@shell_taskbar:
+<!-- ##### FUNCTION e_shell_taskbar_get_activity_count ##### -->
+<para>
+
+</para>
+
+@shell_taskbar:
+@Returns:
+
+
diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml
index 0020ae1eb8..33a5928476 100644
--- a/doc/reference/shell/tmpl/e-shell-window.sgml
+++ b/doc/reference/shell/tmpl/e-shell-window.sgml
@@ -43,6 +43,26 @@ EShellWindow
</para>
+<!-- ##### ARG EShellWindow:sidebar-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellWindow:switcher-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellWindow:taskbar-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellWindow:toolbar-visible ##### -->
+<para>
+
+</para>
+
<!-- ##### ARG EShellWindow:ui-manager ##### -->
<para>
@@ -172,6 +192,78 @@ EShellWindow
@group_name:
+<!-- ##### FUNCTION e_shell_window_get_sidebar_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@Returns:
+
+
+<!-- ##### FUNCTION e_shell_window_set_sidebar_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@sidebar_visible:
+
+
+<!-- ##### FUNCTION e_shell_window_get_switcher_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@Returns:
+
+
+<!-- ##### FUNCTION e_shell_window_set_switcher_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@switcher_visible:
+
+
+<!-- ##### FUNCTION e_shell_window_get_taskbar_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@Returns:
+
+
+<!-- ##### FUNCTION e_shell_window_set_taskbar_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@taskbar_visible:
+
+
+<!-- ##### FUNCTION e_shell_window_get_toolbar_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@Returns:
+
+
+<!-- ##### FUNCTION e_shell_window_set_toolbar_visible ##### -->
+<para>
+
+</para>
+
+@shell_window:
+@toolbar_visible:
+
+
<!-- ##### FUNCTION e_shell_window_register_new_item_actions ##### -->
<para>
diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml
index 9478259742..96fc342b98 100644
--- a/doc/reference/shell/tmpl/eshell-unused.sgml
+++ b/doc/reference/shell/tmpl/eshell-unused.sgml
@@ -70,6 +70,30 @@ EActivityHandler
e-config-upgrade
+<!-- ##### SECTION ./tmpl/e-error.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/e-error.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/e-error.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/e-error.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/e-error.sgml:Title ##### -->
+Error Dialog Functions
+
+
<!-- ##### SECTION ./tmpl/e-shell-common.sgml:Long_Description ##### -->
<para>
@@ -770,6 +794,13 @@ intelligent
@window:
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR ##### -->
+<para>
+
+</para>
+
+@window:
+
<!-- ##### MACRO E_SUMMARY_STORAGE_NAME ##### -->
<para>
diff --git a/doc/reference/shell/tmpl/shell-actions.sgml b/doc/reference/shell/tmpl/shell-actions.sgml
index ff50f7ac45..539cdb017a 100644
--- a/doc/reference/shell/tmpl/shell-actions.sgml
+++ b/doc/reference/shell/tmpl/shell-actions.sgml
@@ -193,7 +193,7 @@ Shell Actions
@window:
-<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR ##### -->
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SWITCHER ##### -->
<para>
</para>
@@ -201,7 +201,7 @@ Shell Actions
@window:
-<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SWITCHER ##### -->
+<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_TASKBAR ##### -->
<para>
</para>