diff options
Diffstat (limited to 'doc/reference/evolution-shell')
8 files changed, 702 insertions, 0 deletions
diff --git a/doc/reference/evolution-shell/Makefile.am b/doc/reference/evolution-shell/Makefile.am new file mode 100644 index 0000000000..5ff5a0af32 --- /dev/null +++ b/doc/reference/evolution-shell/Makefile.am @@ -0,0 +1,43 @@ +# The name of the module. +DOC_MODULE=evolution-shell + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +DOC_SOURCE_DIR=$(top_srcdir)/shell + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB=$(top_srcdir)/shell/*.h +CFILE_GLOB=$(top_srcdir)/shell/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + evo-version.h \ + e-shell-window-private.h \ + es-event.h \ + $(NULL) + +GTKDOC_CFLAGS= \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(EVOLUTION_DATA_SERVER_CFLAGS) \ + $(GNOME_PLATFORM_CFLAGS) \ + $(GTKHTML_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS= \ + $(top_builddir)/libemail-engine/libemail-engine.la \ + $(top_builddir)/shell/libevolution-shell.la \ + $(top_builddir)/e-util/libevolution-util.la \ + $(EVOLUTION_DATA_SERVER_LIBS) \ + $(GNOME_PLATFORM_LIBS) \ + $(GTKHTML_LIBS) \ + $(NULL) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/evolution-shell/evolution-shell-docs.sgml b/doc/reference/evolution-shell/evolution-shell-docs.sgml new file mode 100644 index 0000000000..ba1305eaf5 --- /dev/null +++ b/doc/reference/evolution-shell/evolution-shell-docs.sgml @@ -0,0 +1,46 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>Evolution Shell Reference Manual</title> + <releaseinfo> + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://developer.gnome.org/evolution-shell/">http://developer.gnome.org/evolution-shell/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>The Shell</title> + <xi:include href="xml/e-shell.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"/> + <xi:include href="xml/e-shell-sidebar.xml"/> + <xi:include href="xml/e-shell-taskbar.xml"/> + <xi:include href="xml/e-shell-searchbar.xml"/> + <xi:include href="xml/e-shell-switcher.xml"/> + <xi:include href="xml/e-shell-utils.xml"/> + </chapter> + + <chapter> + <title>Actions</title> + <xi:include href="xml/shell-actions.xml"/> + <xi:include href="xml/action-groups.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <index id="api-index-full"> + <title>Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + +</book> diff --git a/doc/reference/evolution-shell/evolution-shell-overrides.txt b/doc/reference/evolution-shell/evolution-shell-overrides.txt new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/reference/evolution-shell/evolution-shell-overrides.txt diff --git a/doc/reference/evolution-shell/evolution-shell-sections.txt b/doc/reference/evolution-shell/evolution-shell-sections.txt new file mode 100644 index 0000000000..5798533fd6 --- /dev/null +++ b/doc/reference/evolution-shell/evolution-shell-sections.txt @@ -0,0 +1,376 @@ +<SECTION> +<FILE>e-shell</FILE> +<TITLE>EShell</TITLE> +EShell +e_shell_get_default +e_shell_load_modules +e_shell_get_shell_backends +e_shell_get_canonical_name +e_shell_get_backend_by_name +e_shell_get_backend_by_scheme +e_shell_get_client_cache +e_shell_get_registry +e_shell_create_shell_window +e_shell_handle_uris +e_shell_submit_alert +e_shell_get_active_window +e_shell_get_express_mode +e_shell_get_module_directory +e_shell_get_network_available +e_shell_set_network_available +e_shell_lock_network_available +e_shell_get_online +e_shell_set_online +e_shell_get_preferences_window +e_shell_event +EShellQuitReason +e_shell_quit +e_shell_cancel_quit +e_shell_migrate_attempt +<SUBSECTION Standard> +E_SHELL +E_IS_SHELL +E_TYPE_SHELL +E_SHELL_CLASS +E_IS_SHELL_CLASS +E_SHELL_GET_CLASS +E_TYPE_SHELL_QUIT_REASON +EShellClass +e_shell_get_type +e_shell_quit_reason_get_type +<SUBSECTION Private> +EShellPrivate +e_shell_migrate_error_quark +</SECTION> + +<SECTION> +<FILE>e-shell-backend</FILE> +<TITLE>EShellBackend</TITLE> +EShellBackend +e_shell_backend_compare +e_shell_backend_get_config_dir +e_shell_backend_get_data_dir +e_shell_backend_get_shell +e_shell_backend_add_activity +e_shell_backend_cancel_all +e_shell_backend_is_busy +e_shell_backend_get_prefer_new_item +e_shell_backend_set_prefer_new_item +e_shell_backend_start +e_shell_backend_is_started +e_shell_backend_migrate +<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 +e_shell_content_new +e_shell_content_set_searchbar +e_shell_content_check_state +e_shell_content_focus_search_results +e_shell_content_get_alert_bar +e_shell_content_get_shell_view +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_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> +EShellContentPrivate +</SECTION> + +<SECTION> +<FILE>e-shell-searchbar</FILE> +<TITLE>EShellSearchbar</TITLE> +EShellSearchbar +e_shell_searchbar_new +e_shell_searchbar_get_shell_view +e_shell_searchbar_get_filter_combo_box +e_shell_searchbar_get_search_hint +e_shell_searchbar_set_search_hint +e_shell_searchbar_get_search_option +e_shell_searchbar_set_search_option +e_shell_searchbar_get_search_text +e_shell_searchbar_set_search_text +e_shell_searchbar_get_search_box +e_shell_searchbar_get_scope_combo_box +e_shell_searchbar_get_scope_visible +e_shell_searchbar_set_scope_visible +e_shell_searchbar_set_state_dirty +e_shell_searchbar_get_state_group +e_shell_searchbar_set_state_group +e_shell_searchbar_load_state +e_shell_searchbar_save_state +<SUBSECTION Standard> +E_SHELL_SEARCHBAR +E_IS_SHELL_SEARCHBAR +E_TYPE_SHELL_SEARCHBAR +E_SHELL_SEARCHBAR_CLASS +E_IS_SHELL_SEARCHBAR_CLASS +E_SHELL_SEARCHBAR_GET_CLASS +EShellSearchbarClass +e_shell_searchbar_get_type +<SUBSECTION Private> +EShellSearchbarPrivate +</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_icon_name +e_shell_sidebar_set_icon_name +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> +<FILE>e-shell-switcher</FILE> +<TITLE>EShellSwitcher</TITLE> +EShellSwitcher +e_shell_switcher_new +e_shell_switcher_add_action +e_shell_switcher_get_style +e_shell_switcher_set_style +e_shell_switcher_unset_style +e_shell_switcher_get_visible +e_shell_switcher_set_visible +<SUBSECTION Standard> +E_SHELL_SWITCHER +E_IS_SHELL_SWITCHER +E_TYPE_SHELL_SWITCHER +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 +</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 +e_shell_taskbar_get_activity_count +<SUBSECTION Standard> +E_SHELL_TASKBAR +E_IS_SHELL_TASKBAR +E_TYPE_SHELL_TASKBAR +E_SHELL_TASKBAR_CLASS +E_IS_SHELL_TASKBAR_CLASS +E_SHELL_TASKBAR_GET_CLASS +EShellTaskbarClass +e_shell_taskbar_get_type +<SUBSECTION Private> +EShellTaskbarPrivate +</SECTION> + +<SECTION> +<FILE>e-shell-utils</FILE> +<TITLE>Shell Utilities</TITLE> +e_shell_run_open_dialog +e_shell_run_save_dialog +e_shell_utils_import_uris +</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_set_page_num +e_shell_view_get_searchbar +e_shell_view_get_search_name +e_shell_view_get_search_rule +e_shell_view_set_search_rule +e_shell_view_get_search_query +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_state_key_file +e_shell_view_set_state_dirty +e_shell_view_clear_search +e_shell_view_custom_search +e_shell_view_execute_search +e_shell_view_block_execute_search +e_shell_view_unblock_execute_search +e_shell_view_is_execute_search_blocked +e_shell_view_update_actions +e_shell_view_block_update_actions +e_shell_view_unblock_update_actions +e_shell_view_show_popup_menu +e_shell_view_new_view_instance +e_shell_view_write_source +e_shell_view_remove_source +e_shell_view_remote_delete_source +<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 +<SUBSECTION Private> +EShellViewPrivate +</SECTION> + +<SECTION> +<FILE>e-shell-window</FILE> +<TITLE>EShellWindow</TITLE> +EShellWindow +e_shell_window_new +e_shell_window_get_shell +e_shell_window_get_shell_view +e_shell_window_peek_shell_view +e_shell_window_get_shell_view_action +e_shell_window_get_alert_bar +e_shell_window_get_focus_tracker +e_shell_window_get_ui_manager +e_shell_window_get_action +e_shell_window_get_action_group +e_shell_window_get_managed_widget +e_shell_window_get_active_view +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_get_toolbar_new_prefer_item +e_shell_window_set_toolbar_new_prefer_item +e_shell_window_register_new_item_actions +e_shell_window_register_new_source_actions +e_shell_window_get_menu_bar_box +<SUBSECTION Standard> +E_SHELL_WINDOW +E_IS_SHELL_WINDOW +E_TYPE_SHELL_WINDOW +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 +E_SHELL_WINDOW_ACTION_GROUP +</SECTION> + +<SECTION> +<FILE>shell-actions</FILE> +<TITLE>Shell Actions</TITLE> +E_SHELL_WINDOW_ACTION_ABOUT +E_SHELL_WINDOW_ACTION_CLOSE +E_SHELL_WINDOW_ACTION_CONTENTS +E_SHELL_WINDOW_ACTION_COPY_CLIPBOARD +E_SHELL_WINDOW_ACTION_CUT_CLIPBOARD +E_SHELL_WINDOW_ACTION_DELETE_SELECTION +E_SHELL_WINDOW_ACTION_GAL_CUSTOM_VIEW +E_SHELL_WINDOW_ACTION_GAL_DEFINE_VIEWS +E_SHELL_WINDOW_ACTION_GAL_SAVE_CUSTOM_VIEW +E_SHELL_WINDOW_ACTION_GROUP_NEW_WINDOW +E_SHELL_WINDOW_ACTION_IMPORT +E_SHELL_WINDOW_ACTION_NEW_WINDOW +E_SHELL_WINDOW_ACTION_PAGE_SETUP +E_SHELL_WINDOW_ACTION_PASTE_CLIPBOARD +E_SHELL_WINDOW_ACTION_PREFERENCES +E_SHELL_WINDOW_ACTION_QUICK_REFERENCE +E_SHELL_WINDOW_ACTION_QUIT +E_SHELL_WINDOW_ACTION_SEARCH_ADVANCED +E_SHELL_WINDOW_ACTION_SEARCH_CLEAR +E_SHELL_WINDOW_ACTION_SEARCH_EDIT +E_SHELL_WINDOW_ACTION_SEARCH_OPTIONS +E_SHELL_WINDOW_ACTION_SEARCH_QUICK +E_SHELL_WINDOW_ACTION_SEARCH_SAVE +E_SHELL_WINDOW_ACTION_SELECT_ALL +E_SHELL_WINDOW_ACTION_SHOW_SIDEBAR +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 +E_SHELL_WINDOW_ACTION_SWITCHER_MENU +E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH +E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS +E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_TEXT +E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_USER +E_SHELL_WINDOW_ACTION_WORK_OFFLINE +E_SHELL_WINDOW_ACTION_WORK_ONLINE +</SECTION> + +<SECTION> +<FILE>action-groups</FILE> +<TITLE>Action Groups</TITLE> +E_SHELL_WINDOW_ACTION_GROUP_SHELL +E_SHELL_WINDOW_ACTION_GROUP_SWITCHER +E_SHELL_WINDOW_ACTION_GROUP_NEW_ITEM +E_SHELL_WINDOW_ACTION_GROUP_NEW_SOURCE +E_SHELL_WINDOW_ACTION_GROUP_CUSTOM_RULES +E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW +E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_APPLICATION_HANDLERS +E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_PRINTING +E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_PRINT_SETUP +E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_SAVE_TO_DISK +</SECTION> diff --git a/doc/reference/evolution-shell/evolution-shell.types b/doc/reference/evolution-shell/evolution-shell.types new file mode 100644 index 0000000000..2bc9a71963 --- /dev/null +++ b/doc/reference/evolution-shell/evolution-shell.types @@ -0,0 +1,19 @@ +#include <shell/e-shell.h> +#include <shell/e-shell-backend.h> +#include <shell/e-shell-content.h> +#include <shell/e-shell-searchbar.h> +#include <shell/e-shell-sidebar.h> +#include <shell/e-shell-switcher.h> +#include <shell/e-shell-taskbar.h> +#include <shell/e-shell-view.h> +#include <shell/e-shell-window.h> + +e_shell_get_type +e_shell_backend_get_type +e_shell_content_get_type +e_shell_searchbar_get_type +e_shell_sidebar_get_type +e_shell_switcher_get_type +e_shell_taskbar_get_type +e_shell_view_get_type +e_shell_window_get_type diff --git a/doc/reference/evolution-shell/tmpl/e-mail-account-manager.sgml b/doc/reference/evolution-shell/tmpl/e-mail-account-manager.sgml new file mode 100644 index 0000000000..49fe04bdf2 --- /dev/null +++ b/doc/reference/evolution-shell/tmpl/e-mail-account-manager.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +e-mail-account-manager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EMailAccountManager ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### FUNCTION e_mail_account_manager_new ##### --> +<para> + +</para> + +@registry: +@Returns: + + +<!-- ##### FUNCTION e_mail_account_manager_add_account ##### --> +<para> + +</para> + +@manager: + + +<!-- ##### FUNCTION e_mail_account_manager_edit_account ##### --> +<para> + +</para> + +@manager: + + +<!-- ##### FUNCTION e_mail_account_manager_delete_account ##### --> +<para> + +</para> + +@manager: + + +<!-- ##### FUNCTION e_mail_account_manager_get_registry ##### --> +<para> + +</para> + +@manager: +@Returns: + + diff --git a/doc/reference/evolution-shell/tmpl/e-mail-account-tree-view.sgml b/doc/reference/evolution-shell/tmpl/e-mail-account-tree-view.sgml new file mode 100644 index 0000000000..eaee2f12c5 --- /dev/null +++ b/doc/reference/evolution-shell/tmpl/e-mail-account-tree-view.sgml @@ -0,0 +1,90 @@ +<!-- ##### SECTION Title ##### --> +e-mail-account-tree-view + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EMailAccountTreeView ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### FUNCTION e_mail_account_tree_view_new ##### --> +<para> + +</para> + +@registry: +@Returns: + + +<!-- ##### FUNCTION e_mail_account_tree_view_refresh ##### --> +<para> + +</para> + +@tree_view: + + +<!-- ##### FUNCTION e_mail_account_tree_view_enable_selected ##### --> +<para> + +</para> + +@tree_view: + + +<!-- ##### FUNCTION e_mail_account_tree_view_disable_selected ##### --> +<para> + +</para> + +@tree_view: + + +<!-- ##### FUNCTION e_mail_account_tree_view_get_registry ##### --> +<para> + +</para> + +@tree_view: +@Returns: + + +<!-- ##### FUNCTION e_mail_account_tree_view_get_selected_source ##### --> +<para> + +</para> + +@tree_view: +@Returns: + + +<!-- ##### FUNCTION e_mail_account_tree_view_set_selected_source ##### --> +<para> + +</para> + +@tree_view: +@source: + + diff --git a/doc/reference/evolution-shell/tmpl/e-mail-identity-combo-box.sgml b/doc/reference/evolution-shell/tmpl/e-mail-identity-combo-box.sgml new file mode 100644 index 0000000000..fec8130b21 --- /dev/null +++ b/doc/reference/evolution-shell/tmpl/e-mail-identity-combo-box.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +e-mail-identity-combo-box + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EMailIdentityComboBox ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### FUNCTION e_mail_identity_combo_box_new ##### --> +<para> + +</para> + +@registry: +@Returns: + + +<!-- ##### FUNCTION e_mail_identity_combo_box_refresh ##### --> +<para> + +</para> + +@combo_box: + + +<!-- ##### FUNCTION e_mail_identity_combo_box_get_registry ##### --> +<para> + +</para> + +@combo_box: +@Returns: + + |