diff options
Diffstat (limited to 'doc/reference')
35 files changed, 7527 insertions, 0 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am new file mode 100644 index 0000000000..d7c539dc98 --- /dev/null +++ b/doc/reference/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = shell diff --git a/doc/reference/shell/Makefile.am b/doc/reference/shell/Makefile.am new file mode 100644 index 0000000000..ccf96afa90 --- /dev/null +++ b/doc/reference/shell/Makefile.am @@ -0,0 +1,155 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=eshell + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../../shell + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/shell/*.h +CFILE_GLOB=$(top_srcdir)/shell/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=e-shell-window-private.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +AM_CPPFLAGS= \ + -I$(top_srcdir) \ + -I$(SHELL_CFLAGS) +GTKDOC_LIBS= \ + $(top_builddir)/shell/.libs/e-shell.o \ + $(top_builddir)/shell/.libs/e-shell-backend.o \ + $(top_builddir)/shell/.libs/e-shell-content.o \ + $(top_builddir)/shell/.libs/e-shell-importer.o \ + $(top_builddir)/shell/.libs/e-shell-migrate.o \ + $(top_builddir)/shell/.libs/e-shell-nm.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 \ + $(top_builddir)/shell/.libs/e-shell-taskbar.o \ + $(top_builddir)/shell/.libs/e-shell-view.o \ + $(top_builddir)/shell/.libs/e-shell-window-actions.o \ + $(top_builddir)/shell/.libs/e-shell-window-private.o \ + $(top_builddir)/shell/.libs/e-shell-window.o \ + $(top_builddir)/shell/.libs/es-event.o \ + $(top_builddir)/e-util/.libs/e-bconf-map.o \ + $(top_builddir)/e-util/.libs/e-binding.o \ + $(top_builddir)/e-util/.libs/e-dialog-utils.o \ + $(top_builddir)/e-util/.libs/e-error.o \ + $(top_builddir)/e-util/.libs/e-event.o \ + $(top_builddir)/e-util/.libs/e-fsutils.o \ + $(top_builddir)/e-util/.libs/e-icon-factory.o \ + $(top_builddir)/e-util/.libs/e-import.o \ + $(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 \ + $(top_builddir)/e-util/.libs/e-print.o \ + $(top_builddir)/e-util/.libs/e-unicode.o \ + $(top_builddir)/e-util/.libs/e-util.o \ + $(top_builddir)/e-util/.libs/e-xml-utils.o \ + $(top_builddir)/e-util/.libs/gconf-bridge.o \ + $(top_builddir)/filter/.libs/filter-code.o \ + $(top_builddir)/filter/.libs/filter-colour.o \ + $(top_builddir)/filter/.libs/filter-datespec.o \ + $(top_builddir)/filter/.libs/filter-element.o \ + $(top_builddir)/filter/.libs/filter-file.o \ + $(top_builddir)/filter/.libs/filter-input.o \ + $(top_builddir)/filter/.libs/filter-int.o \ + $(top_builddir)/filter/.libs/filter-option.o \ + $(top_builddir)/filter/.libs/filter-part.o \ + $(top_builddir)/filter/.libs/filter-rule.o \ + $(top_builddir)/filter/.libs/rule-context.o \ + $(top_builddir)/filter/.libs/rule-editor.o \ + $(top_builddir)/smclient/.libs/eggdesktopfile.o \ + $(top_builddir)/smclient/.libs/eggsmclient.o \ + $(top_builddir)/smclient/.libs/eggsmclient-xsmp.o \ + $(top_builddir)/widgets/menus/.libs/gal-define-views-dialog.o \ + $(top_builddir)/widgets/menus/.libs/gal-view-collection.o \ + $(top_builddir)/widgets/menus/.libs/gal-view-factory.o \ + $(top_builddir)/widgets/menus/.libs/gal-view-instance.o \ + $(top_builddir)/widgets/menus/.libs/gal-view-instance-save-as-dialog.o \ + $(top_builddir)/widgets/menus/.libs/gal-view-new-dialog.o \ + $(top_builddir)/widgets/menus/.libs/gal-view.o \ + $(top_builddir)/widgets/misc/.libs/e-action-combo-box.o \ + $(top_builddir)/widgets/misc/.libs/e-activity.o \ + $(top_builddir)/widgets/misc/.libs/e-activity-proxy.o \ + $(top_builddir)/widgets/misc/.libs/e-gui-utils.o \ + $(top_builddir)/widgets/misc/.libs/e-hinted-entry.o \ + $(top_builddir)/widgets/misc/.libs/e-menu-tool-button.o \ + $(top_builddir)/widgets/misc/.libs/e-online-button.o \ + $(top_builddir)/widgets/misc/.libs/e-popup-menu.o \ + $(top_builddir)/widgets/misc/.libs/e-preferences-window.o \ + $(top_builddir)/widgets/misc/.libs/e-spinner.o \ + -ledataserver-1.2 \ + -ledataserverui-1.2 \ + $(SHELL_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml new file mode 100644 index 0000000000..3d7bdcd36e --- /dev/null +++ b/doc/reference/shell/eshell-docs.sgml @@ -0,0 +1,43 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <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://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.org/docs/eshell/</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-settings.xml"/> + <xi:include href="xml/e-shell-switcher.xml"/> + <xi:include href="xml/e-shell-importer.xml"/> + </chapter> + + <chapter> + <title>Actions</title> + <xi:include href="xml/shell-actions.xml"/> + <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> + +</book> diff --git a/doc/reference/shell/eshell-overrides.txt b/doc/reference/shell/eshell-overrides.txt new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/reference/shell/eshell-overrides.txt diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt new file mode 100644 index 0000000000..5ae8c3586b --- /dev/null +++ b/doc/reference/shell/eshell-sections.txt @@ -0,0 +1,346 @@ +<SECTION> +<FILE>e-shell</FILE> +<TITLE>EShell</TITLE> +EShell +e_shell_get_default +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_shell_settings +e_shell_get_gconf_client +e_shell_create_shell_window +e_shell_handle_uris +e_shell_watch_window +e_shell_get_watched_windows +e_shell_send_receive +e_shell_get_network_available +e_shell_set_network_available +e_shell_get_online +e_shell_set_online +e_shell_get_preferences_window +e_shell_event +e_shell_quit +e_shell_cancel_quit +E_SHELL_MIGRATE_ERROR +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 +EShellClass +e_shell_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_filename +e_shell_backend_get_shell +e_shell_backend_add_activity +e_shell_backend_start +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_check_state +e_shell_content_get_shell_view +e_shell_content_get_filter_action +e_shell_content_set_filter_action +e_shell_content_get_filter_value +e_shell_content_set_filter_value +e_shell_content_get_filter_visible +e_shell_content_set_filter_visible +e_shell_content_add_filter_separator_before +e_shell_content_add_filter_separator_after +e_shell_content_get_search_context +e_shell_content_get_search_hint +e_shell_content_set_search_hint +e_shell_content_get_search_rule +e_shell_content_set_search_rule +e_shell_content_get_search_text +e_shell_content_set_search_text +e_shell_content_get_search_visible +e_shell_content_set_search_visible +e_shell_content_get_scope_action +e_shell_content_set_scope_action +e_shell_content_get_scope_value +e_shell_content_set_scope_value +e_shell_content_get_scope_visible +e_shell_content_set_scope_visible +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 +e_shell_content_restore_state +<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-settings</FILE> +<TITLE>EShellSettings</TITLE> +EShellSettings +e_shell_settings_install_property +e_shell_settings_bind_to_gconf +e_shell_settings_enable_debug +e_shell_settings_get_boolean +e_shell_settings_set_boolean +e_shell_settings_get_int +e_shell_settings_set_int +e_shell_settings_get_string +e_shell_settings_set_string +e_shell_settings_get_object +e_shell_settings_set_object +e_shell_settings_get_pointer +e_shell_settings_set_pointer +<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_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 +<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-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_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_update_actions +e_shell_view_show_popup_menu +e_shell_view_new_view_instance +<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_get_shell_view_action +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_register_new_item_actions +e_shell_window_register_new_source_actions +<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>e-shell-importer</FILE> +e_shell_importer_start_import +</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_FAQ +E_SHELL_WINDOW_ACTION_FORGET_PASSWORDS +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_IMPORT +E_SHELL_WINDOW_ACTION_NEW_WINDOW +E_SHELL_WINDOW_ACTION_PAGE_SETUP +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_EXECUTE +E_SHELL_WINDOW_ACTION_SEARCH_OPTIONS +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_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 +E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_USER +E_SHELL_WINDOW_ACTION_SYNC_OPTIONS +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/shell/eshell.types b/doc/reference/shell/eshell.types new file mode 100644 index 0000000000..7ad399f7c9 --- /dev/null +++ b/doc/reference/shell/eshell.types @@ -0,0 +1,8 @@ +e_shell_get_type +e_shell_backend_get_type +e_shell_content_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/shell/tmpl/Evolution-DataServer.sgml b/doc/reference/shell/tmpl/Evolution-DataServer.sgml new file mode 100644 index 0000000000..181b45f301 --- /dev/null +++ b/doc/reference/shell/tmpl/Evolution-DataServer.sgml @@ -0,0 +1,1139 @@ +<!-- ##### SECTION Title ##### --> +Evolution-DataServer + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO ORBIT_IDL_SERIAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO ORBIT_DECL_GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Config__freekids ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE GNOME_Evolution_DataServer_Config__classid ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_1 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_3 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_4 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_5 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_7 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_8 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_9 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_11 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_12 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_13 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_14 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_15 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_16 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_17 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_18 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_19 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + + + +<!-- ##### MACRO ORBIT_DECL_GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck__freekids ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE GNOME_Evolution_DataServer_InterfaceCheck__classid ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_1 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_3 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_4 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_5 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_7 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_8 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_9 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_11 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_12 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_13 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_14 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_15 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_16 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_17 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_18 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_19 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + + + +<!-- ##### MACRO ORBIT_DECL_GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging__freekids ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE GNOME_Evolution_DataServer_Logging__classid ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_1 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_3 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_4 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_5 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_7 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_8 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_9 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_11 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_12 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_13 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_14 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_15 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_16 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_17 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_18 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_19 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + + + +<!-- ##### ENUM GNOME_Evolution_DataServer_Logging_Level ##### --> +<para> + +</para> + +@GNOME_Evolution_DataServer_Logging_Error: +@GNOME_Evolution_DataServer_Logging_Critical: +@GNOME_Evolution_DataServer_Logging_Warning: +@GNOME_Evolution_DataServer_Logging_Message: +@GNOME_Evolution_DataServer_Logging_Info: +@GNOME_Evolution_DataServer_Logging_Debug: + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_1 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_3 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_4 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_5 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_7 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_8 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_9 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_11 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_12 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_13 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_14 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_15 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_16 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_17 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_18 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_19 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Logging_Level ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_Logging_LogEvent ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_1 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_3 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_4 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_5 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_7 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_8 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_9 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_11 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_12 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_13 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_14 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_15 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_16 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_17 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_18 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_19 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Logging_LogEvent ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_LogEvent__alloc ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_LogEvent__freekids ##### --> +<para> + +</para> + +@m: +@d: + + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Config__epv ##### --> +<para> + +</para> + +@_private: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Config__vepv ##### --> +<para> + +</para> + +@_base_epv: +@GNOME_Evolution_DataServer_Config_epv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + +@_private: +@vepv: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Config__init ##### --> +<para> + +</para> + +@servant: +@ev: + + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Config__fini ##### --> +<para> + +</para> + +@servant: +@ev: + + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_InterfaceCheck__epv ##### --> +<para> + +</para> + +@_private: +@_get_interfaceVersion: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_InterfaceCheck__vepv ##### --> +<para> + +</para> + +@_base_epv: +@Bonobo_Unknown_epv: +@GNOME_Evolution_DataServer_InterfaceCheck_epv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + +@_private: +@vepv: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_InterfaceCheck__init ##### --> +<para> + +</para> + +@servant: +@ev: + + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_InterfaceCheck__fini ##### --> +<para> + +</para> + +@servant: +@ev: + + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Logging__epv ##### --> +<para> + +</para> + +@_private: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Logging__vepv ##### --> +<para> + +</para> + +@_base_epv: +@Bonobo_Unknown_epv: +@Bonobo_EventSource_epv: +@GNOME_Evolution_DataServer_Logging_epv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + +@_private: +@vepv: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Logging__init ##### --> +<para> + +</para> + +@servant: +@ev: + + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Logging__fini ##### --> +<para> + +</para> + +@servant: +@ev: + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_ref ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_unref ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_queryInterface ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION GNOME_Evolution_DataServer_InterfaceCheck__get_interfaceVersion ##### --> +<para> + +</para> + +@_obj: +@ev: +@Returns: + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_ref ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_unref ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_queryInterface ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_addListener ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_addListenerWithMask ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_removeListener ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_unImplemented ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_unImplemented2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Config_IMETHODS_LEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Config__imethods ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_IMETHODS_LEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_IMETHODS_LEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging__imethods ##### --> +<para> + +</para> + + + +<!-- ##### ENUM GNOME_Evolution_DataServer_InterfaceCheck__imethods_index ##### --> +<para> + +</para> + +@GNOME_Evolution_DataServer_InterfaceCheck__get_interfaceVersion__imethods_index: + +<!-- ##### MACRO ORBIT_IMETHODS_INDEX ##### --> +<para> + +</para> + +@m: + + diff --git a/doc/reference/shell/tmpl/action-groups.sgml b/doc/reference/shell/tmpl/action-groups.sgml new file mode 100644 index 0000000000..5fe62d7ebb --- /dev/null +++ b/doc/reference/shell/tmpl/action-groups.sgml @@ -0,0 +1,99 @@ +<!-- ##### SECTION Title ##### --> +Action Groups + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SHELL ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SWITCHER ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_NEW_ITEM ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_NEW_SOURCE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_CUSTOM_RULES ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_APPLICATION_HANDLERS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_PRINTING ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_PRINT_SETUP ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_SAVE_TO_DISK ##### --> +<para> + +</para> + +@window: + + diff --git a/doc/reference/shell/tmpl/e-activity-handler.sgml b/doc/reference/shell/tmpl/e-activity-handler.sgml new file mode 100644 index 0000000000..09d417213d --- /dev/null +++ b/doc/reference/shell/tmpl/e-activity-handler.sgml @@ -0,0 +1,19 @@ +<!-- ##### SECTION Title ##### --> +EActivityHandler + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + diff --git a/doc/reference/shell/tmpl/e-config-upgrade.sgml b/doc/reference/shell/tmpl/e-config-upgrade.sgml new file mode 100644 index 0000000000..0ef774b3dd --- /dev/null +++ b/doc/reference/shell/tmpl/e-config-upgrade.sgml @@ -0,0 +1,32 @@ +<!-- ##### SECTION Title ##### --> +e-config-upgrade + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_config_upgrade ##### --> +<para> + +</para> + +@major: +@minor: +@revision: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-shell-backend.sgml b/doc/reference/shell/tmpl/e-shell-backend.sgml new file mode 100644 index 0000000000..10e2845d59 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-backend.sgml @@ -0,0 +1,114 @@ +<!-- ##### SECTION Title ##### --> +EShellBackend + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellBackend ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EShellBackend::activity-added ##### --> +<para> + +</para> + +@eshellbackend: the object which received the signal. +@arg1: + +<!-- ##### ARG EShellBackend:shell ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_backend_compare ##### --> +<para> + +</para> + +@shell_backend_a: +@shell_backend_b: +@Returns: + + +<!-- ##### FUNCTION e_shell_backend_get_config_dir ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + + +<!-- ##### FUNCTION e_shell_backend_get_data_dir ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + + +<!-- ##### FUNCTION e_shell_backend_get_filename ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + + +<!-- ##### FUNCTION e_shell_backend_get_shell ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + + +<!-- ##### FUNCTION e_shell_backend_add_activity ##### --> +<para> + +</para> + +@shell_backend: +@activity: + + +<!-- ##### FUNCTION e_shell_backend_start ##### --> +<para> + +</para> + +@shell_backend: + + +<!-- ##### FUNCTION e_shell_backend_migrate ##### --> +<para> + +</para> + +@shell_backend: +@major: +@minor: +@micro: +@error: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-shell-common.sgml b/doc/reference/shell/tmpl/e-shell-common.sgml new file mode 100644 index 0000000000..1932480643 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-common.sgml @@ -0,0 +1,21 @@ +<!-- ##### SECTION Title ##### --> +e-shell-common + +<!-- ##### 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-constants.sgml b/doc/reference/shell/tmpl/e-shell-constants.sgml new file mode 100644 index 0000000000..74b95024a8 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-constants.sgml @@ -0,0 +1,140 @@ +<!-- ##### SECTION Title ##### --> +e-shell-constants + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO E_SHELL_URI_PREFIX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_URI_PREFIX_LEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_DEFAULTURI_PREFIX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_DEFAULTURI_PREFIX_LEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_MINI_ICON_SUFFIX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_MINI_ICON_SUFFIX_LEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_ICON_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SHELL_MINI_ICON_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_PATH_SEPARATOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_PATH_SEPARATOR_S ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_LOCAL_STORAGE_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SUMMARY_STORAGE_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_SUMMARY_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_LOCAL_INBOX_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_LOCAL_CONTACTS_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_LOCAL_CALENDAR_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_LOCAL_TASKS_URI ##### --> +<para> + +</para> + + + diff --git a/doc/reference/shell/tmpl/e-shell-content.sgml b/doc/reference/shell/tmpl/e-shell-content.sgml new file mode 100644 index 0000000000..2ffe528e98 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-content.sgml @@ -0,0 +1,370 @@ +<!-- ##### SECTION Title ##### --> +EShellContent + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellContent ##### --> +<para> + +</para> + + +<!-- ##### ARG EShellContent:filter-action ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:filter-value ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:filter-visible ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:scope-action ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:scope-value ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:scope-visible ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:search-context ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:search-hint ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:search-rule ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:search-text ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:search-visible ##### --> +<para> + +</para> + +<!-- ##### ARG EShellContent:shell-view ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_content_new ##### --> +<para> + +</para> + +@shell_view: +@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_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_before ##### --> +<para> + +</para> + +@shell_content: +@action_value: + + +<!-- ##### 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_hint ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_search_hint ##### --> +<para> + +</para> + +@shell_content: +@search_hint: + + +<!-- ##### 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_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: + + +<!-- ##### FUNCTION e_shell_content_restore_state ##### --> +<para> + +</para> + +@shell_content: +@group_name: + + diff --git a/doc/reference/shell/tmpl/e-shell-importer.sgml b/doc/reference/shell/tmpl/e-shell-importer.sgml new file mode 100644 index 0000000000..0b3aa44506 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-importer.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +e-shell-importer + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_shell_importer_start_import ##### --> +<para> + +</para> + +@shell_window: + + diff --git a/doc/reference/shell/tmpl/e-shell-marshal.sgml b/doc/reference/shell/tmpl/e-shell-marshal.sgml new file mode 100644 index 0000000000..27f0c92196 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-marshal.sgml @@ -0,0 +1,41 @@ +<!-- ##### SECTION Title ##### --> +e-shell-marshal + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_shell_marshal_BOOLEAN__STRING ##### --> +<para> + +</para> + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + +<!-- ##### MACRO e_shell_marshal_BOOL__STRING ##### --> +<para> + +</para> + + + diff --git a/doc/reference/shell/tmpl/e-shell-module.sgml b/doc/reference/shell/tmpl/e-shell-module.sgml new file mode 100644 index 0000000000..f74773c9da --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-module.sgml @@ -0,0 +1,180 @@ +<!-- ##### SECTION Title ##### --> +EShellModule + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### 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: + +<!-- ##### FUNCTION e_shell_module_new ##### --> +<para> + +</para> + +@shell: +@filename: +@Returns: + + +<!-- ##### 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_add_activity ##### --> +<para> + +</para> + +@shell_module: +@activity: + + +<!-- ##### FUNCTION e_shell_module_start ##### --> +<para> + +</para> + +@shell_module: + + +<!-- ##### FUNCTION e_shell_module_is_busy ##### --> +<para> + +</para> + +@shell_module: +@Returns: + + +<!-- ##### FUNCTION e_shell_module_shutdown ##### --> +<para> + +</para> + +@shell_module: +@Returns: + + +<!-- ##### FUNCTION e_shell_module_migrate ##### --> +<para> + +</para> + +@shell_module: +@major: +@minor: +@micro: +@error: +@Returns: + + +<!-- ##### FUNCTION e_shell_module_set_info ##### --> +<para> + +</para> + +@shell_module: +@info: +@shell_view_type: + + diff --git a/doc/reference/shell/tmpl/e-shell-settings.sgml b/doc/reference/shell/tmpl/e-shell-settings.sgml new file mode 100644 index 0000000000..edc6af5b32 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-settings.sgml @@ -0,0 +1,151 @@ +<!-- ##### SECTION Title ##### --> +EShellSettings + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellSettings ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION e_shell_settings_install_property ##### --> +<para> + +</para> + +@pspec: + + +<!-- ##### FUNCTION e_shell_settings_bind_to_gconf ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@gconf_key: + + +<!-- ##### FUNCTION e_shell_settings_enable_debug ##### --> +<para> + +</para> + +@shell_settings: + + +<!-- ##### FUNCTION e_shell_settings_get_boolean ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_settings_set_boolean ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@v_boolean: + + +<!-- ##### FUNCTION e_shell_settings_get_int ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_settings_set_int ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@v_int: + + +<!-- ##### FUNCTION e_shell_settings_get_string ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_settings_set_string ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@v_string: + + +<!-- ##### FUNCTION e_shell_settings_get_object ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_settings_set_object ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@v_object: + + +<!-- ##### FUNCTION e_shell_settings_get_pointer ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_settings_set_pointer ##### --> +<para> + +</para> + +@shell_settings: +@property_name: +@v_pointer: + + diff --git a/doc/reference/shell/tmpl/e-shell-sidebar.sgml b/doc/reference/shell/tmpl/e-shell-sidebar.sgml new file mode 100644 index 0000000000..45a55b127b --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-sidebar.sgml @@ -0,0 +1,126 @@ +<!-- ##### SECTION Title ##### --> +EShellSidebar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellSidebar ##### --> +<para> + +</para> + + +<!-- ##### ARG EShellSidebar:icon-name ##### --> +<para> + +</para> + +<!-- ##### ARG EShellSidebar:primary-text ##### --> +<para> + +</para> + +<!-- ##### ARG EShellSidebar:secondary-text ##### --> +<para> + +</para> + +<!-- ##### ARG EShellSidebar:shell-view ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_sidebar_new ##### --> +<para> + +</para> + +@shell_view: +@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_icon_name ##### --> +<para> + +</para> + +@shell_sidebar: +@Returns: + + +<!-- ##### FUNCTION e_shell_sidebar_set_icon_name ##### --> +<para> + +</para> + +@shell_sidebar: +@icon_name: + + +<!-- ##### 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: + + diff --git a/doc/reference/shell/tmpl/e-shell-switcher.sgml b/doc/reference/shell/tmpl/e-shell-switcher.sgml new file mode 100644 index 0000000000..f656b65988 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-switcher.sgml @@ -0,0 +1,104 @@ +<!-- ##### SECTION Title ##### --> +EShellSwitcher + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellSwitcher ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EShellSwitcher::style-changed ##### --> +<para> + +</para> + +@eshellswitcher: the object which received the signal. +@arg1: + +<!-- ##### ARG EShellSwitcher:toolbar-style ##### --> +<para> + +</para> + +<!-- ##### ARG EShellSwitcher:toolbar-visible ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_switcher_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_shell_switcher_add_action ##### --> +<para> + +</para> + +@switcher: +@action: + + +<!-- ##### FUNCTION e_shell_switcher_get_style ##### --> +<para> + +</para> + +@switcher: +@Returns: + + +<!-- ##### FUNCTION e_shell_switcher_set_style ##### --> +<para> + +</para> + +@switcher: +@style: + + +<!-- ##### FUNCTION e_shell_switcher_unset_style ##### --> +<para> + +</para> + +@switcher: + + +<!-- ##### FUNCTION e_shell_switcher_get_visible ##### --> +<para> + +</para> + +@switcher: +@Returns: + + +<!-- ##### FUNCTION e_shell_switcher_set_visible ##### --> +<para> + +</para> + +@switcher: +@visible: + + diff --git a/doc/reference/shell/tmpl/e-shell-taskbar.sgml b/doc/reference/shell/tmpl/e-shell-taskbar.sgml new file mode 100644 index 0000000000..6aa90f1c72 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-taskbar.sgml @@ -0,0 +1,79 @@ +<!-- ##### SECTION Title ##### --> +EShellTaskbar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellTaskbar ##### --> +<para> + +</para> + + +<!-- ##### ARG EShellTaskbar:message ##### --> +<para> + +</para> + +<!-- ##### ARG EShellTaskbar:shell-view ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_taskbar_new ##### --> +<para> + +</para> + +@shell_view: +@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: + + diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml new file mode 100644 index 0000000000..408e869528 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-view.sgml @@ -0,0 +1,284 @@ +<!-- ##### SECTION Title ##### --> +EShellView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellView ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EShellView::toggled ##### --> +<para> + +</para> + +@eshellview: the object which received the signal. + +<!-- ##### SIGNAL EShellView::update-actions ##### --> +<para> + +</para> + +@eshellview: the object which received the signal. + +<!-- ##### ARG EShellView:action ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:page-num ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:shell-backend ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:shell-content ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:shell-sidebar ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:shell-taskbar ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:shell-window ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:title ##### --> +<para> + +</para> + +<!-- ##### ARG EShellView:view-id ##### --> +<para> + +</para> + +<!-- ##### STRUCT EShellViewClass ##### --> +<para> + +</para> + +@parent_class: +@label: +@icon_name: +@ui_definition: +@ui_manager_id: +@search_options: +@search_rules: +@view_collection: +@shell_backend: +@new_shell_content: +@new_shell_sidebar: +@new_shell_taskbar: +@toggled: +@update_actions: + +<!-- ##### FUNCTION e_shell_view_get_name ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_action ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_title ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_set_title ##### --> +<para> + +</para> + +@shell_view: +@title: + + +<!-- ##### FUNCTION e_shell_view_get_view_id ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_set_view_id ##### --> +<para> + +</para> + +@shell_view: +@view_id: + + +<!-- ##### FUNCTION e_shell_view_is_active ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_page_num ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_set_page_num ##### --> +<para> + +</para> + +@shell_view: +@page_num: + + +<!-- ##### FUNCTION e_shell_view_get_size_group ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_shell_backend ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_shell_content ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_shell_sidebar ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_shell_taskbar ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_shell_window ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_get_state_key_file ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_set_state_dirty ##### --> +<para> + +</para> + +@shell_view: + + +<!-- ##### FUNCTION e_shell_view_update_actions ##### --> +<para> + +</para> + +@shell_view: + + +<!-- ##### FUNCTION e_shell_view_show_popup_menu ##### --> +<para> + +</para> + +@shell_view: +@widget_path: +@event: + + +<!-- ##### FUNCTION e_shell_view_new_view_instance ##### --> +<para> + +</para> + +@shell_view: +@instance_id: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-shell-window-actions.sgml b/doc/reference/shell/tmpl/e-shell-window-actions.sgml new file mode 100644 index 0000000000..48e6f44203 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-window-actions.sgml @@ -0,0 +1,309 @@ +<!-- ##### SECTION Title ##### --> +Global Actions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION ##### --> +<para> + +</para> + +@window: +@name: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP ##### --> +<para> + +</para> + +@window: +@name: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_ABOUT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_CLOSE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_FAQ ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_FORGET_PASSWORDS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_CUSTOM_VIEW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_DEFINE_VIEWS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_SAVE_CUSTOM_VIEW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_VIEW_MENU ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_IMPORT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_NEW_WINDOW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_PAGE_SETUP ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_PREFERENCES ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_QUICK_REFERENCE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_QUIT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_ADVANCED ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_CLEAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_EDIT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_EXECUTE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_SAVE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEND_RECEIVE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SIDEBAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SWITCHER ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SUBMIT_BUG ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SYNC_OPTIONS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_WORK_OFFLINE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_WORK_ONLINE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_NEW_ITEM ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_NEW_SOURCE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SHELL ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SHELL_VIEW ##### --> +<para> + +</para> + +@window: + + diff --git a/doc/reference/shell/tmpl/e-shell-window-private.sgml b/doc/reference/shell/tmpl/e-shell-window-private.sgml new file mode 100644 index 0000000000..6c1c6d0e72 --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-window-private.sgml @@ -0,0 +1,25 @@ +<!-- ##### SECTION Title ##### --> +e-shell-window-private + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellWindowPrivate ##### --> +<para> + +</para> + + diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml new file mode 100644 index 0000000000..9571632bae --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-window.sgml @@ -0,0 +1,190 @@ +<!-- ##### SECTION Title ##### --> +EShellWindow + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShellWindow ##### --> +<para> + +</para> + + +<!-- ##### ARG EShellWindow:active-view ##### --> +<para> + +</para> + +<!-- ##### ARG EShellWindow:safe-mode ##### --> +<para> + +</para> + +<!-- ##### ARG EShellWindow:shell ##### --> +<para> + +</para> + +<!-- ##### ARG EShellWindow:ui-manager ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_window_new ##### --> +<para> + +</para> + +@shell: +@safe_mode: +@Returns: + + +<!-- ##### FUNCTION e_shell_window_get_shell ##### --> +<para> + +</para> + +@shell_window: +@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_add_action_group ##### --> +<para> + +</para> + +@shell_window: +@group_name: + + +<!-- ##### FUNCTION e_shell_window_register_new_item_actions ##### --> +<para> + +</para> + +@shell_window: +@backend_name: +@entries: +@n_entries: + + +<!-- ##### FUNCTION e_shell_window_register_new_source_actions ##### --> +<para> + +</para> + +@shell_window: +@backend_name: +@entries: +@n_entries: + + diff --git a/doc/reference/shell/tmpl/e-shell.sgml b/doc/reference/shell/tmpl/e-shell.sgml new file mode 100644 index 0000000000..a34a083b7c --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell.sgml @@ -0,0 +1,310 @@ +<!-- ##### SECTION Title ##### --> +EShell + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EShell ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EShell::event ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@Param2: + +<!-- ##### SIGNAL EShell::handle-uri ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: +@Returns: + +<!-- ##### SIGNAL EShell::prepare-for-offline ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EShell::prepare-for-online ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EShell::prepare-for-quit ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EShell::quit-requested ##### --> +<para> + +</para> + +@eshell: the object which received the signal. + +<!-- ##### SIGNAL EShell::send-receive ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EShell::window-created ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EShell::window-destroyed ##### --> +<para> + +</para> + +@eshell: the object which received the signal. + +<!-- ##### ARG EShell:network-available ##### --> +<para> + +</para> + +<!-- ##### ARG EShell:online ##### --> +<para> + +</para> + +<!-- ##### ARG EShell:shell-settings ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_shell_get_default ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_shell_get_shell_backends ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_get_canonical_name ##### --> +<para> + +</para> + +@shell: +@name: +@Returns: + + +<!-- ##### FUNCTION e_shell_get_backend_by_name ##### --> +<para> + +</para> + +@shell: +@name: +@Returns: + + +<!-- ##### FUNCTION e_shell_get_backend_by_scheme ##### --> +<para> + +</para> + +@shell: +@scheme: +@Returns: + + +<!-- ##### FUNCTION e_shell_get_shell_settings ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_get_gconf_client ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_create_shell_window ##### --> +<para> + +</para> + +@shell: +@view_name: +@Returns: + + +<!-- ##### FUNCTION e_shell_handle_uris ##### --> +<para> + +</para> + +@shell: +@uris: +@Returns: + + +<!-- ##### FUNCTION e_shell_watch_window ##### --> +<para> + +</para> + +@shell: +@window: + + +<!-- ##### FUNCTION e_shell_get_watched_windows ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_send_receive ##### --> +<para> + +</para> + +@shell: +@parent: + + +<!-- ##### FUNCTION e_shell_get_network_available ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_set_network_available ##### --> +<para> + +</para> + +@shell: +@network_available: + + +<!-- ##### FUNCTION e_shell_get_online ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_set_online ##### --> +<para> + +</para> + +@shell: +@online: + + +<!-- ##### FUNCTION e_shell_get_preferences_window ##### --> +<para> + +</para> + +@shell: +@Returns: + + +<!-- ##### FUNCTION e_shell_event ##### --> +<para> + +</para> + +@shell: +@event_name: +@event_data: + + +<!-- ##### FUNCTION e_shell_quit ##### --> +<para> + +</para> + +@shell: + + +<!-- ##### FUNCTION e_shell_cancel_quit ##### --> +<para> + +</para> + +@shell: + + +<!-- ##### MACRO E_SHELL_MIGRATE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION e_shell_migrate_attempt ##### --> +<para> + +</para> + +@shell: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-test-shell-view.sgml b/doc/reference/shell/tmpl/e-test-shell-view.sgml new file mode 100644 index 0000000000..2c9c912c20 --- /dev/null +++ b/doc/reference/shell/tmpl/e-test-shell-view.sgml @@ -0,0 +1,41 @@ +<!-- ##### SECTION Title ##### --> +ETestShellView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### VARIABLE e_test_shell_view_type ##### --> +<para> + +</para> + + +<!-- ##### STRUCT ETestShellViewPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT ETestShellView ##### --> +<para> + +</para> + +@parent: +@priv: + diff --git a/doc/reference/shell/tmpl/es-event.sgml b/doc/reference/shell/tmpl/es-event.sgml new file mode 100644 index 0000000000..8821e92ad5 --- /dev/null +++ b/doc/reference/shell/tmpl/es-event.sgml @@ -0,0 +1,147 @@ +<!-- ##### SECTION Title ##### --> +ESEventHook + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### ENUM es_event_target_t ##### --> +<para> + +</para> + +@ES_EVENT_TARGET_STATE: +@ES_EVENT_TARGET_UPGRADE: +@ES_EVENT_TARGET_SHELL: +@ES_EVENT_TARGET_COMPONENT: + +<!-- ##### STRUCT ESEventTargetState ##### --> +<para> + +</para> + +@target: +@state: + +<!-- ##### STRUCT ESEventTargetUpgrade ##### --> +<para> + +</para> + +@target: +@major: +@minor: +@revision: + +<!-- ##### STRUCT ESEventTargetShell ##### --> +<para> + +</para> + +@target: + +<!-- ##### STRUCT ESEventTargetComponent ##### --> +<para> + +</para> + +@target: +@id: + +<!-- ##### TYPEDEF ESEventItem ##### --> +<para> + +</para> + + +<!-- ##### STRUCT ESEvent ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION es_event_get_type ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION es_event_peek ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION es_event_target_new ##### --> +<para> + +</para> + +@eme: +@Returns: + + +<!-- ##### FUNCTION es_event_target_new_state ##### --> +<para> + +</para> + +@emp: +@state: +@Returns: + + +<!-- ##### FUNCTION es_event_target_new_upgrade ##### --> +<para> + +</para> + +@emp: +@major: +@minor: +@revision: +@Returns: + + +<!-- ##### FUNCTION es_event_target_new_component ##### --> +<para> + +</para> + +@eme: +@id: +@Returns: + + +<!-- ##### STRUCT ESEventHook ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION es_event_hook_get_type ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml new file mode 100644 index 0000000000..58ddf1024e --- /dev/null +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -0,0 +1,2375 @@ +<!-- ##### SECTION ./tmpl/Evolution-DataServer.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/Evolution-DataServer.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/Evolution-DataServer.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/Evolution-DataServer.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/Evolution-DataServer.sgml:Title ##### --> +Evolution-DataServer + + +<!-- ##### SECTION ./tmpl/e-activity-handler.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-activity-handler.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-activity-handler.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-activity-handler.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-activity-handler.sgml:Title ##### --> +EActivityHandler + + +<!-- ##### SECTION ./tmpl/e-config-upgrade.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-config-upgrade.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-config-upgrade.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-config-upgrade.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-config-upgrade.sgml:Title ##### --> +e-config-upgrade + + +<!-- ##### SECTION ./tmpl/e-shell-common.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-common.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-common.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-common.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-common.sgml:Title ##### --> +e-shell-common + + +<!-- ##### SECTION ./tmpl/e-shell-constants.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-constants.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-constants.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-constants.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-constants.sgml:Title ##### --> +e-shell-constants + + +<!-- ##### SECTION ./tmpl/e-shell-marshal.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-marshal.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-marshal.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-marshal.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-marshal.sgml:Title ##### --> +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-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> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-window-actions.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-window-actions.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-window-actions.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-window-actions.sgml:Title ##### --> +Global Actions + + +<!-- ##### SECTION ./tmpl/e-shell-window-private.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-window-private.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-shell-window-private.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-window-private.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-shell-window-private.sgml:Title ##### --> +e-shell-window-private + + +<!-- ##### SECTION ./tmpl/e-test-shell-view.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-test-shell-view.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/e-test-shell-view.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/e-test-shell-view.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/e-test-shell-view.sgml:Title ##### --> +ETestShellView + + +<!-- ##### SECTION ./tmpl/es-event.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/es-event.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/es-event.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/es-event.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/es-event.sgml:Title ##### --> +ESEventHook + + +<!-- ##### SECTION ./tmpl/evolution-importer-client.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-importer-client.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-importer-client.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-importer-client.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-importer-client.sgml:Title ##### --> +EvolutionImporterClient + + +<!-- ##### SECTION ./tmpl/evolution-importer-listener.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-importer-listener.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-importer-listener.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-importer-listener.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-importer-listener.sgml:Title ##### --> +EvolutionImporterListener + + +<!-- ##### SECTION ./tmpl/evolution-importer.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-importer.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-importer.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-importer.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-importer.sgml:Title ##### --> +EvolutionImporter + + +<!-- ##### SECTION ./tmpl/evolution-intelligent-importer.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-intelligent-importer.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/evolution-intelligent-importer.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-intelligent-importer.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/evolution-intelligent-importer.sgml:Title ##### --> +EvolutionIntelligentImporter + + +<!-- ##### SECTION ./tmpl/intelligent.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/intelligent.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/intelligent.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/intelligent.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/intelligent.sgml:Title ##### --> +intelligent + + +<!-- ##### STRUCT ESEvent ##### --> +<para> + +</para> + + +<!-- ##### STRUCT ESEventHook ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF ESEventItem ##### --> +<para> + +</para> + + +<!-- ##### STRUCT ESEventTargetComponent ##### --> +<para> + +</para> + +@target: +@id: + +<!-- ##### STRUCT ESEventTargetShell ##### --> +<para> + +</para> + +@target: + +<!-- ##### STRUCT ESEventTargetState ##### --> +<para> + +</para> + +@target: +@state: + +<!-- ##### STRUCT ESEventTargetUpgrade ##### --> +<para> + +</para> + +@target: +@major: +@minor: +@revision: + +<!-- ##### SIGNAL EShell::prepare-for-shutdown ##### --> +<para> + +</para> + +@eshell: the object which received the signal. +@arg1: + +<!-- ##### ARG EShell:online-mode ##### --> +<para> + +</para> + + +<!-- ##### ARG EShell:settings ##### --> +<para> + +</para> + + +<!-- ##### ARG EShellContent:search-value ##### --> +<para> + +</para> + + +<!-- ##### ENUM EShellLineStatus ##### --> +<para> + +</para> + +@E_SHELL_LINE_STATUS_ONLINE: +@E_SHELL_LINE_STATUS_GOING_OFFLINE: +@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: + +<!-- ##### SIGNAL EShellView::capture-state ##### --> +<para> + +</para> + +@eshellview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EShellView::restore-state ##### --> +<para> + +</para> + +@eshellview: the object which received the signal. +@arg1: + +<!-- ##### ARG EShellView:shell-module ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EShellWindowPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT ETestShellView ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### STRUCT ETestShellViewPrivate ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_LOCAL_CALENDAR_URI ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_LOCAL_CONTACTS_URI ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_LOCAL_INBOX_URI ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_LOCAL_STORAGE_NAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_LOCAL_TASKS_URI ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_PATH_SEPARATOR ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_PATH_SEPARATOR_S ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_DEFAULTURI_PREFIX ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_DEFAULTURI_PREFIX_LEN ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_ICON_SIZE ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_MINI_ICON_SIZE ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_MINI_ICON_SUFFIX ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_MINI_ICON_SUFFIX_LEN ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_UPGRADE_ERROR ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_URI_PREFIX ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_URI_PREFIX_LEN ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION ##### --> +<para> + +</para> + +@window: +@name: + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_VIEW_MENU ##### --> +<para> + +</para> + +@window: + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP ##### --> +<para> + +</para> + +@window: +@name: + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GROUP_SHELL_VIEW ##### --> +<para> + +</para> + +@window: + +<!-- ##### MACRO E_SUMMARY_STORAGE_NAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO E_SUMMARY_URI ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EvolutionImporter ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### STRUCT EvolutionImporterClient ##### --> +<para> + +</para> + +@parent_type: +@objref: + +<!-- ##### USER_FUNCTION EvolutionImporterCreateControlFn ##### --> +<para> + +</para> + +@importer: +@control: +@closure: + +<!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### --> +<para> + +</para> + +@importer: +@closure: +@Returns: + +<!-- ##### STRUCT EvolutionImporterListener ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### USER_FUNCTION EvolutionImporterListenerCallback ##### --> +<para> + +</para> + +@listener: +@result: +@more_items: +@closure: + +<!-- ##### STRUCT EvolutionImporterListenerPrivate ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### --> +<para> + +</para> + +@importer: +@filename: +@closure: +@Returns: + +<!-- ##### STRUCT EvolutionImporterPrivate ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### --> +<para> + +</para> + +@importer: +@listener: +@closure: +@ev: + +<!-- ##### ENUM EvolutionImporterResult ##### --> +<para> + +</para> + +@EVOLUTION_IMPORTER_OK: +@EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION: +@EVOLUTION_IMPORTER_INTERRUPTED: +@EVOLUTION_IMPORTER_BUSY: +@EVOLUTION_IMPORTER_NOT_READY: +@EVOLUTION_IMPORTER_UNKNOWN_DATA: +@EVOLUTION_IMPORTER_BAD_DATA: +@EVOLUTION_IMPORTER_BAD_FILE: +@EVOLUTION_IMPORTER_UNKNOWN_ERROR: + +<!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### --> +<para> + +</para> + +@importer: +@filename: +@closure: +@Returns: + +<!-- ##### STRUCT EvolutionIntelligentImporter ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### USER_FUNCTION EvolutionIntelligentImporterCanImportFn ##### --> +<para> + +</para> + +@ii: +@closure: +@Returns: + +<!-- ##### USER_FUNCTION EvolutionIntelligentImporterImportDataFn ##### --> +<para> + +</para> + +@ii: +@closure: + +<!-- ##### STRUCT EvolutionIntelligentImporterPrivate ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Config_IMETHODS_LEN ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE GNOME_Evolution_DataServer_Config__classid ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Config__freekids ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Config__imethods ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_IMETHODS_LEN ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE GNOME_Evolution_DataServer_InterfaceCheck__classid ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck__freekids ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION GNOME_Evolution_DataServer_InterfaceCheck__get_interfaceVersion ##### --> +<para> + +</para> + +@_obj: +@ev: +@Returns: + +<!-- ##### ENUM GNOME_Evolution_DataServer_InterfaceCheck__imethods_index ##### --> +<para> + +</para> + +@GNOME_Evolution_DataServer_InterfaceCheck__get_interfaceVersion__imethods_index: + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_queryInterface ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_ref ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_InterfaceCheck_unref ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_IMETHODS_LEN ##### --> +<para> + +</para> + + +<!-- ##### ENUM GNOME_Evolution_DataServer_Logging_Level ##### --> +<para> + +</para> + +@GNOME_Evolution_DataServer_Logging_Error: +@GNOME_Evolution_DataServer_Logging_Critical: +@GNOME_Evolution_DataServer_Logging_Warning: +@GNOME_Evolution_DataServer_Logging_Message: +@GNOME_Evolution_DataServer_Logging_Info: +@GNOME_Evolution_DataServer_Logging_Debug: + +<!-- ##### TYPEDEF GNOME_Evolution_DataServer_Logging_LogEvent ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_LogEvent__alloc ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_LogEvent__freekids ##### --> +<para> + +</para> + +@m: +@d: + +<!-- ##### VARIABLE GNOME_Evolution_DataServer_Logging__classid ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging__freekids ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging__imethods ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_addListener ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_addListenerWithMask ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_queryInterface ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_ref ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_removeListener ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_unImplemented ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_unImplemented2 ##### --> +<para> + +</para> + + +<!-- ##### MACRO GNOME_Evolution_DataServer_Logging_unref ##### --> +<para> + +</para> + + +<!-- ##### MACRO ORBIT_DECL_GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + + +<!-- ##### MACRO ORBIT_DECL_GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + + +<!-- ##### MACRO ORBIT_DECL_GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + + +<!-- ##### MACRO ORBIT_IDL_SERIAL ##### --> +<para> + +</para> + + +<!-- ##### MACRO ORBIT_IMETHODS_INDEX ##### --> +<para> + +</para> + +@m: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + +@_private: +@vepv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Config__epv ##### --> +<para> + +</para> + +@_private: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Config__fini ##### --> +<para> + +</para> + +@servant: +@ev: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Config__init ##### --> +<para> + +</para> + +@servant: +@ev: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Config__vepv ##### --> +<para> + +</para> + +@_base_epv: +@GNOME_Evolution_DataServer_Config_epv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + +@_private: +@vepv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_InterfaceCheck__epv ##### --> +<para> + +</para> + +@_private: +@_get_interfaceVersion: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_InterfaceCheck__fini ##### --> +<para> + +</para> + +@servant: +@ev: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_InterfaceCheck__init ##### --> +<para> + +</para> + +@servant: +@ev: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_InterfaceCheck__vepv ##### --> +<para> + +</para> + +@_base_epv: +@Bonobo_Unknown_epv: +@GNOME_Evolution_DataServer_InterfaceCheck_epv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + +@_private: +@vepv: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Logging__epv ##### --> +<para> + +</para> + +@_private: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Logging__fini ##### --> +<para> + +</para> + +@servant: +@ev: + +<!-- ##### FUNCTION POA_GNOME_Evolution_DataServer_Logging__init ##### --> +<para> + +</para> + +@servant: +@ev: + +<!-- ##### STRUCT POA_GNOME_Evolution_DataServer_Logging__vepv ##### --> +<para> + +</para> + +@_base_epv: +@Bonobo_Unknown_epv: +@Bonobo_EventSource_epv: +@GNOME_Evolution_DataServer_Logging_epv: + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Config ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_InterfaceCheck ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Logging ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Logging_Level ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_GNOME_Evolution_DataServer_Logging_LogEvent ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_0 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_1 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_10 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_11 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_12 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_13 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_14 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_15 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_16 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_17 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_18 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_19 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_2 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_3 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_4 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_5 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_6 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_7 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_8 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Config_9 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_0 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_1 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_10 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_11 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_12 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_13 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_14 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_15 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_16 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_17 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_18 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_19 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_2 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_3 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_4 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_5 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_6 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_7 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_8 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_InterfaceCheck_9 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_0 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_1 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_10 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_11 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_12 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_13 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_14 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_15 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_16 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_17 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_18 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_19 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_2 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_3 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_4 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_5 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_6 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_7 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_8 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_9 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_0 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_1 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_10 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_11 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_12 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_13 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_14 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_15 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_16 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_17 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_18 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_19 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_2 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_3 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_4 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_5 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_6 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_7 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_8 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_Level_9 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_0 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_1 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_10 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_11 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_12 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_13 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_14 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_15 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_16 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_17 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_18 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_19 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_2 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_3 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_4 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_5 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_6 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_7 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_8 ##### --> +<para> + +</para> + + +<!-- ##### MACRO TC_IMPL_TC_GNOME_Evolution_DataServer_Logging_LogEvent_9 ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION e_config_upgrade ##### --> +<para> + +</para> + +@major: +@minor: +@revision: +@Returns: + +<!-- ##### FUNCTION e_shell_backend_is_busy ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + +<!-- ##### FUNCTION e_shell_backend_shutdown ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + +<!-- ##### FUNCTION e_shell_content_get_context ##### --> +<para> + +</para> + +@shell_content: +@Returns: + +<!-- ##### FUNCTION e_shell_content_get_search_value ##### --> +<para> + +</para> + +@shell_content: +@Returns: + +<!-- ##### FUNCTION e_shell_content_set_context ##### --> +<para> + +</para> + +@shell_content: +@context: + +<!-- ##### FUNCTION e_shell_content_set_search_value ##### --> +<para> + +</para> + +@shell_content: +@search_value: + +<!-- ##### FUNCTION e_shell_create_window ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_do_quit ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_get_focused_window ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_get_line_status ##### --> +<para> + +</para> + +@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> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_get_settings ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_get_shell_modules ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_get_shell_windows ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_handle_uri ##### --> +<para> + +</para> + +@shell: +@uri: +@Returns: + +<!-- ##### FUNCTION e_shell_is_busy ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_list_modules ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_list_shell_modules ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_list_shell_windows ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_marshal_BOOLEAN__STRING ##### --> +<para> + +</para> + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + +<!-- ##### MACRO e_shell_marshal_BOOL__STRING ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION e_shell_migrate_error_quark ##### --> +<para> + +</para> + +@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> + +</para> + +@shell_module: +@major: +@minor: +@micro: +@error: +@Returns: + +<!-- ##### FUNCTION e_shell_new ##### --> +<para> + +</para> + +@online: +@Returns: + +<!-- ##### FUNCTION e_shell_set_line_status ##### --> +<para> + +</para> + +@shell: +@status: + +<!-- ##### FUNCTION e_shell_set_online_mode ##### --> +<para> + +</para> + +@shell: +@online_mode: + +<!-- ##### FUNCTION e_shell_upgrade_attempt ##### --> +<para> + +</para> + +@shell: +@Returns: + +<!-- ##### FUNCTION e_shell_view_get_shell_module ##### --> +<para> + +</para> + +@shell_view: +@Returns: + +<!-- ##### VARIABLE e_test_shell_view_type ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION es_event_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION es_event_hook_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION es_event_peek ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION es_event_target_new ##### --> +<para> + +</para> + +@eme: +@Returns: + +<!-- ##### FUNCTION es_event_target_new_component ##### --> +<para> + +</para> + +@eme: +@id: +@Returns: + +<!-- ##### FUNCTION es_event_target_new_state ##### --> +<para> + +</para> + +@emp: +@state: +@Returns: + +<!-- ##### FUNCTION es_event_target_new_upgrade ##### --> +<para> + +</para> + +@emp: +@major: +@minor: +@revision: +@Returns: + +<!-- ##### ENUM es_event_target_t ##### --> +<para> + +</para> + +@ES_EVENT_TARGET_STATE: +@ES_EVENT_TARGET_UPGRADE: +@ES_EVENT_TARGET_SHELL: +@ES_EVENT_TARGET_COMPONENT: + +<!-- ##### FUNCTION evolution_importer_client_create_control ##### --> +<para> + +</para> + +@client: +@Returns: + +<!-- ##### FUNCTION evolution_importer_client_get_error ##### --> +<para> + +</para> + +@client: +@Returns: + +<!-- ##### FUNCTION evolution_importer_client_load_file ##### --> +<para> + +</para> + +@client: +@filename: +@Returns: + +<!-- ##### FUNCTION evolution_importer_client_new ##### --> +<para> + +</para> + +@objref: +@Returns: + +<!-- ##### FUNCTION evolution_importer_client_new_from_id ##### --> +<para> + +</para> + +@id: +@Returns: + +<!-- ##### FUNCTION evolution_importer_client_process_item ##### --> +<para> + +</para> + +@client: +@listener: + +<!-- ##### FUNCTION evolution_importer_client_support_format ##### --> +<para> + +</para> + +@client: +@filename: +@Returns: + +<!-- ##### FUNCTION evolution_importer_listener_new ##### --> +<para> + +</para> + +@callback: +@closure: +@Returns: + +<!-- ##### FUNCTION evolution_importer_new ##### --> +<para> + +</para> + +@create_control_fn: +@support_format_fn: +@load_file_fn: +@process_item_fn: +@get_error_fn: +@closure: +@Returns: + +<!-- ##### FUNCTION evolution_intelligent_importer_new ##### --> +<para> + +</para> + +@can_import_fn: +@import_data_fn: +@importername: +@message: +@closure: +@Returns: + +<!-- ##### FUNCTION intelligent_importer_init ##### --> +<para> + +</para> + + diff --git a/doc/reference/shell/tmpl/evolution-importer-client.sgml b/doc/reference/shell/tmpl/evolution-importer-client.sgml new file mode 100644 index 0000000000..db2acb621a --- /dev/null +++ b/doc/reference/shell/tmpl/evolution-importer-client.sgml @@ -0,0 +1,94 @@ +<!-- ##### SECTION Title ##### --> +EvolutionImporterClient + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EvolutionImporterClient ##### --> +<para> + +</para> + +@parent_type: +@objref: + +<!-- ##### FUNCTION evolution_importer_client_new ##### --> +<para> + +</para> + +@objref: +@Returns: + + +<!-- ##### FUNCTION evolution_importer_client_new_from_id ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION evolution_importer_client_create_control ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION evolution_importer_client_support_format ##### --> +<para> + +</para> + +@client: +@filename: +@Returns: + + +<!-- ##### FUNCTION evolution_importer_client_load_file ##### --> +<para> + +</para> + +@client: +@filename: +@Returns: + + +<!-- ##### FUNCTION evolution_importer_client_process_item ##### --> +<para> + +</para> + +@client: +@listener: + + +<!-- ##### FUNCTION evolution_importer_client_get_error ##### --> +<para> + +</para> + +@client: +@Returns: + + diff --git a/doc/reference/shell/tmpl/evolution-importer-listener.sgml b/doc/reference/shell/tmpl/evolution-importer-listener.sgml new file mode 100644 index 0000000000..7b0b3ab488 --- /dev/null +++ b/doc/reference/shell/tmpl/evolution-importer-listener.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +EvolutionImporterListener + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EvolutionImporterListenerPrivate ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION EvolutionImporterListenerCallback ##### --> +<para> + +</para> + +@listener: +@result: +@more_items: +@closure: + + +<!-- ##### STRUCT EvolutionImporterListener ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### FUNCTION evolution_importer_listener_new ##### --> +<para> + +</para> + +@callback: +@closure: +@Returns: + + diff --git a/doc/reference/shell/tmpl/evolution-importer.sgml b/doc/reference/shell/tmpl/evolution-importer.sgml new file mode 100644 index 0000000000..c092138c60 --- /dev/null +++ b/doc/reference/shell/tmpl/evolution-importer.sgml @@ -0,0 +1,117 @@ +<!-- ##### SECTION Title ##### --> +EvolutionImporter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EvolutionImporterPrivate ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION EvolutionImporterCreateControlFn ##### --> +<para> + +</para> + +@importer: +@control: +@closure: + + +<!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### --> +<para> + +</para> + +@importer: +@filename: +@closure: +@Returns: + + +<!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### --> +<para> + +</para> + +@importer: +@filename: +@closure: +@Returns: + + +<!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### --> +<para> + +</para> + +@importer: +@listener: +@closure: +@ev: + + +<!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### --> +<para> + +</para> + +@importer: +@closure: +@Returns: + + +<!-- ##### ENUM EvolutionImporterResult ##### --> +<para> + +</para> + +@EVOLUTION_IMPORTER_OK: +@EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION: +@EVOLUTION_IMPORTER_INTERRUPTED: +@EVOLUTION_IMPORTER_BUSY: +@EVOLUTION_IMPORTER_NOT_READY: +@EVOLUTION_IMPORTER_UNKNOWN_DATA: +@EVOLUTION_IMPORTER_BAD_DATA: +@EVOLUTION_IMPORTER_BAD_FILE: +@EVOLUTION_IMPORTER_UNKNOWN_ERROR: + +<!-- ##### STRUCT EvolutionImporter ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### FUNCTION evolution_importer_new ##### --> +<para> + +</para> + +@create_control_fn: +@support_format_fn: +@load_file_fn: +@process_item_fn: +@get_error_fn: +@closure: +@Returns: + + diff --git a/doc/reference/shell/tmpl/evolution-intelligent-importer.sgml b/doc/reference/shell/tmpl/evolution-intelligent-importer.sgml new file mode 100644 index 0000000000..4dfdb70203 --- /dev/null +++ b/doc/reference/shell/tmpl/evolution-intelligent-importer.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +EvolutionIntelligentImporter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EvolutionIntelligentImporterPrivate ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION EvolutionIntelligentImporterCanImportFn ##### --> +<para> + +</para> + +@ii: +@closure: +@Returns: + + +<!-- ##### USER_FUNCTION EvolutionIntelligentImporterImportDataFn ##### --> +<para> + +</para> + +@ii: +@closure: + + +<!-- ##### STRUCT EvolutionIntelligentImporter ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### FUNCTION evolution_intelligent_importer_new ##### --> +<para> + +</para> + +@can_import_fn: +@import_data_fn: +@importername: +@message: +@closure: +@Returns: + + diff --git a/doc/reference/shell/tmpl/intelligent.sgml b/doc/reference/shell/tmpl/intelligent.sgml new file mode 100644 index 0000000000..1c50af5c7b --- /dev/null +++ b/doc/reference/shell/tmpl/intelligent.sgml @@ -0,0 +1,26 @@ +<!-- ##### SECTION Title ##### --> +intelligent + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION intelligent_importer_init ##### --> +<para> + +</para> + + + diff --git a/doc/reference/shell/tmpl/shell-actions.sgml b/doc/reference/shell/tmpl/shell-actions.sgml new file mode 100644 index 0000000000..60001d61bb --- /dev/null +++ b/doc/reference/shell/tmpl/shell-actions.sgml @@ -0,0 +1,291 @@ +<!-- ##### SECTION Title ##### --> +Shell Actions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_ABOUT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_CLOSE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_CONTENTS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_FAQ ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_FORGET_PASSWORDS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_CUSTOM_VIEW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_DEFINE_VIEWS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_GAL_SAVE_CUSTOM_VIEW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_IMPORT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_NEW_WINDOW ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_PAGE_SETUP ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_PREFERENCES ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_QUICK_REFERENCE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_QUIT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_ADVANCED ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_CLEAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_EDIT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_EXECUTE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_OPTIONS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEARCH_SAVE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SEND_RECEIVE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SIDEBAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_SWITCHER ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SUBMIT_BUG ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_TEXT ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_USER ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_SYNC_OPTIONS ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_WORK_OFFLINE ##### --> +<para> + +</para> + +@window: + + +<!-- ##### MACRO E_SHELL_WINDOW_ACTION_WORK_ONLINE ##### --> +<para> + +</para> + +@window: + + |