From c6795be3a8b7b17ced9e99e17db9ac6cbed6e018 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Wed, 1 Oct 2008 03:48:51 +0000 Subject: Continue documenting the new shell API. svn path=/branches/kill-bonobo/; revision=36511 --- doc/reference/shell/eshell-docs.sgml | 10 +- doc/reference/shell/eshell-sections.txt | 130 +- doc/reference/shell/tmpl/e-shell-module.sgml | 9 + doc/reference/shell/tmpl/e-shell-view.sgml | 45 + doc/reference/shell/tmpl/e-shell-window.sgml | 10 + doc/reference/shell/tmpl/eshell-unused.sgml | 2173 +------------------------- 6 files changed, 129 insertions(+), 2248 deletions(-) (limited to 'doc/reference/shell') diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index 452a53cabf..6baba61429 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -12,22 +12,22 @@ - Shell + The Shell - - + - Actions by Group - + Actions + + diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index 86321592a6..fc9a599558 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -1,3 +1,36 @@ +
+e-shell +EShell +EShell +EShellLineStatus +e_shell_new +e_shell_list_modules +e_shell_get_canonical_name +e_shell_get_module_by_name +e_shell_get_module_by_scheme +e_shell_create_window +e_shell_handle_uri +e_shell_send_receive +e_shell_get_online_mode +e_shell_set_online_mode +e_shell_get_line_status +e_shell_set_line_status +e_shell_get_preferences_window +e_shell_is_busy +e_shell_do_quit +e_shell_quit + +E_SHELL +E_IS_SHELL +E_TYPE_SHELL +e_shell_get_type +E_SHELL_CLASS +E_IS_SHELL_CLASS +E_SHELL_GET_CLASS + +EShellPrivate +
+
e-shell-view EShellView @@ -9,12 +42,16 @@ e_shell_view_set_title e_shell_view_get_view_id e_shell_view_set_view_id e_shell_view_is_active +e_shell_view_add_activity e_shell_view_get_page_num +e_shell_view_get_size_group e_shell_view_get_shell_content e_shell_view_get_shell_sidebar e_shell_view_get_shell_taskbar e_shell_view_get_shell_window -e_shell_view_changed +e_shell_view_get_shell_module +e_shell_view_update_actions +e_shell_view_show_popup_menu E_SHELL_VIEW E_IS_SHELL_VIEW @@ -68,35 +105,6 @@ E_SHELL_SIDEBAR_GET_CLASS EShellSidebarPrivate
-
-e-activity-handler -EActivityHandler -EAH_ICON_INFO -EAH_ICON_ERROR -EActivityHandler -e_activity_handler_new -e_activity_handler_attach_task_bar -e_activity_handler_set_message -e_activity_handler_unset_message -e_activity_handler_operation_started -e_activity_handler_cancelable_operation_started -e_activity_handler_operation_progressing -e_activity_handler_operation_finished -e_activity_handler_set_logger -e_activity_handler_make_error -e_activity_handler_operation_set_error -e_activity_handler_set_error_flush_time - -E_ACTIVITY_HANDLER -E_IS_ACTIVITY_HANDLER -E_TYPE_ACTIVITY_HANDLER -e_activity_handler_get_type -E_ACTIVITY_HANDLER_CLASS -E_IS_ACTIVITY_HANDLER_CLASS - -EActivityHandlerPrivate -
-
e-shell-taskbar EShellTaskbar @@ -126,6 +134,7 @@ e_shell_module_get_data_dir e_shell_module_get_filename e_shell_module_get_searches e_shell_module_get_shell +e_shell_module_add_activity e_shell_module_is_busy e_shell_module_shutdown e_shell_module_set_info @@ -158,46 +167,13 @@ E_SHELL_CONTENT_GET_CLASS EShellContentPrivate
-
-e-shell -EShell -EShell -EShellLineStatus -e_shell_new -e_shell_list_modules -e_shell_get_canonical_name -e_shell_get_module_by_name -e_shell_get_module_by_scheme -e_shell_create_window -e_shell_handle_uri -e_shell_send_receive -e_shell_get_online_mode -e_shell_set_online_mode -e_shell_get_line_status -e_shell_set_line_status -e_shell_get_preferences_window -e_shell_is_busy -e_shell_do_quit -e_shell_quit - -E_SHELL -E_IS_SHELL -E_TYPE_SHELL -e_shell_get_type -E_SHELL_CLASS -E_IS_SHELL_CLASS -E_SHELL_GET_CLASS - -EShellPrivate -
-
e-shell-window EShellWindow EShellWindow e_shell_window_new -e_shell_window_get_view e_shell_window_get_shell +e_shell_window_get_shell_view e_shell_window_get_ui_manager e_shell_window_get_action e_shell_window_get_action_group @@ -218,6 +194,8 @@ E_IS_SHELL_WINDOW_CLASS E_SHELL_WINDOW_GET_CLASS EShellWindowPrivate +E_SHELL_WINDOW_ACTION +E_SHELL_WINDOW_ACTION_GROUP
@@ -226,18 +204,16 @@ e_shell_importer_start_import
-e-shell-window-actions -Global Actions -E_SHELL_WINDOW_ACTION -E_SHELL_WINDOW_ACTION_GROUP +shell-actions +Shell Actions 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_GAL_VIEW_MENU E_SHELL_WINDOW_ACTION_IMPORT E_SHELL_WINDOW_ACTION_NEW_WINDOW E_SHELL_WINDOW_ACTION_PAGE_SETUP @@ -248,6 +224,7 @@ 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 @@ -255,13 +232,22 @@ 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_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 -E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW +
+ +
+action-groups +Action Groups +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_SHELL -E_SHELL_WINDOW_ACTION_GROUP_SHELL_VIEW +E_SHELL_WINDOW_ACTION_GROUP_CUSTOM_RULES +E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW
diff --git a/doc/reference/shell/tmpl/e-shell-module.sgml b/doc/reference/shell/tmpl/e-shell-module.sgml index f4fe9ca069..3b9b642688 100644 --- a/doc/reference/shell/tmpl/e-shell-module.sgml +++ b/doc/reference/shell/tmpl/e-shell-module.sgml @@ -119,6 +119,15 @@ EShellModule @Returns: + + + + + +@shell_module: +@activity: + + diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml index d36370c321..b6d35b18be 100644 --- a/doc/reference/shell/tmpl/e-shell-view.sgml +++ b/doc/reference/shell/tmpl/e-shell-view.sgml @@ -140,6 +140,15 @@ EShellView @Returns: + + + + + +@shell_view: +@activity: + + @@ -149,6 +158,15 @@ EShellView @Returns: + + + + + +@shell_view: +@Returns: + + @@ -185,3 +203,30 @@ EShellView @Returns: + + + + + +@shell_view: +@Returns: + + + + + + + +@shell_view: + + + + + + + +@shell_view: +@widget_path: +@event: + + diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml index 988e2f039c..50349dae87 100644 --- a/doc/reference/shell/tmpl/e-shell-window.sgml +++ b/doc/reference/shell/tmpl/e-shell-window.sgml @@ -57,6 +57,16 @@ EShellWindow @Returns: + + + + + +@shell_window: +@view_name: +@Returns: + + diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml index 358b76071a..9360a7003c 100644 --- a/doc/reference/shell/tmpl/eshell-unused.sgml +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -1,2176 +1,7 @@ - - - - - - - - - - - - - - - - - - - - - -Evolution-DataServer - - - - - - - - - - - - - - - - - - - - - - - -e-config-upgrade - - - - - - - - - - - - - - - - - - - - - - - -e-shell-common - - - - - - - - - - - - - - - - - - - - - - - -e-shell-constants - - - - - - - - - - - - - - - - - - - - - - - -e-shell-marshal - - - - - - - - - - - - - - - - - - - - - - - -e-shell-window-private - - - - - - - - - - - - - - - - - - - - - - - -ETestShellView - - - - - - - - - - - - - - - - - - - - - - - -ESEventHook - - - - - - - - - - - - - - - - - - - - - - - -EvolutionImporterClient - - - - - - - - - - - - - - - - - - - - - - - -EvolutionImporterListener - - - - - - - - - - - - - - - - - - - - - - - -EvolutionImporter - - - - - - - - - - - - - - - - - - - - - - - -EvolutionIntelligentImporter - - - - - - - - - - - - - - - - - - - - - - - -intelligent - - - - - - - -@name: - - - - - - -@name: - - - - - - -@obj: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@target: -@id: - - - - - - -@target: - - - - - - -@target: -@state: - - - - - - -@target: -@major: -@minor: -@revision: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@eshellview: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@priv: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@obj: - - - - - - - - - - - - - - - - - - -@parent: -@priv: - - - - - - -@parent_type: -@objref: - - - - - - -@importer: -@control: -@closure: - - - - - - -@importer: -@closure: -@Returns: - - - - - - -@parent: -@priv: - - - - - - -@listener: -@result: -@more_items: -@closure: - - - - - - - - - - - - -@importer: -@filename: -@closure: -@Returns: - - - - - - - - - - - - -@importer: -@listener: -@closure: -@ev: - - - - - - -@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: - - - - - - -@importer: -@filename: -@closure: -@Returns: - - - - - - -@parent: -@priv: - - - - - - -@ii: -@closure: -@Returns: - - - - - - -@ii: -@closure: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@_obj: -@ev: -@Returns: - - - - - - -@GNOME_Evolution_DataServer_InterfaceCheck__get_interfaceVersion__imethods_index: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@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: - - - - - - - - - - - - - - - - - - -@m: -@d: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@m: - - - - - - -@_private: -@vepv: - - - - - - -@_private: - - - - - - -@servant: -@ev: - - - - - - -@servant: -@ev: - - - - - - -@_base_epv: -@GNOME_Evolution_DataServer_Config_epv: - - - - - - -@_private: -@vepv: - - - - - - -@_private: -@_get_interfaceVersion: - - - - - - -@servant: -@ev: - - - - - - -@servant: -@ev: - - - - - - -@_base_epv: -@Bonobo_Unknown_epv: -@GNOME_Evolution_DataServer_InterfaceCheck_epv: - - - - - - -@_private: -@vepv: - - - - - - -@_private: - - - - - - -@servant: -@ev: - - - - - - -@servant: -@ev: - - - - - - -@_base_epv: -@Bonobo_Unknown_epv: -@Bonobo_EventSource_epv: -@GNOME_Evolution_DataServer_Logging_epv: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@activity_hanlder: -@shell_taskbar: - - - - - - -@activity_handler: -@information: -@cancellable: -@cancel_func: -@user_data: -@Returns: - - - - - - -@activity_handler: -@error_type: -@error: -@Returns: - - - - - - -@Returns: - - - - - - -@activity_handler: -@activity_id: - - - - - - -@activity_handler: -@activity_id: -@information: -@progress: - - - - - - -@activity_handler: -@activity_id: -@error: - - - - - - -@activity_handler: -@information: -@cancellable: -@Returns: - - - - - - -@handler: -@time: - - - - - - -@handler: -@logger: - - - - - - -@activity_handler: -@message: - - - - - - -@activity_handler: - - - - - - -@major: -@minor: -@revision: -@Returns: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - - - - - - -@shell_view: - - - - - - -@shell_view: -@Returns: - - - - - - -@shell_view: -@Returns: - - - - - - -@shell_view: -@instance: - - - - - - -@shell_window: - - - - - - -@shell_window: -@Returns: - - - - - - -@shell_window: - - - - - - -@shell_window: -@Returns: - - - - - - -@shell_window: -@view_name: -@Returns: - - - - - - -@shell_window: - - - - - - -@shell_window: - - - - - - -@shell_window: - - - - - - -@shell_window: -@view_name: - - - - - - -@shell_window: -@view_name: - - - - - - -@shell_window: - - - - - - -@shell_window: - - - - - - -@shell_window: - - - - - - -@shell_window: - - - - - - - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@eme: -@Returns: - - - - - - -@eme: -@id: -@Returns: - - - - - - -@emp: -@state: -@Returns: - - - - - - -@emp: -@major: -@minor: -@revision: -@Returns: - - - - - - -@ES_EVENT_TARGET_STATE: -@ES_EVENT_TARGET_UPGRADE: -@ES_EVENT_TARGET_SHELL: -@ES_EVENT_TARGET_COMPONENT: - - - - - - -@client: -@Returns: - - - - - - -@client: -@Returns: - - - - - - -@client: -@filename: -@Returns: - - - - - - -@objref: -@Returns: - - - - - - -@id: -@Returns: - - - - - - -@client: -@listener: - - - - - - -@client: -@filename: -@Returns: - - - - - - -@callback: -@closure: -@Returns: - - - - - - -@create_control_fn: -@support_format_fn: -@load_file_fn: -@process_item_fn: -@get_error_fn: -@closure: -@Returns: - - - - - - -@can_import_fn: -@import_data_fn: -@importername: -@message: -@closure: -@Returns: - - + +@window: -- cgit