From 4cbbdedf522a6ac10df93a128bbf25f67173d66e Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Fri, 18 Dec 2009 18:23:48 -0500 Subject: Refactor the EShell search API. Move the search interface to a new widget: EShellSearchbar The current search rule is now stored in EShellView, and the search context in EShellViewClass similar to GalViewCollection (since it's class-specific, not instance-specific). Also add a couple new signals to EShellView: "clear-search" and "custom-search" ("custom" refers to an advanced search or a saved search -- something more complex than a quick search). Still working out a few kinks. The search entry is clearly trying to be too many things. We need a different way of indicating that you're looking at search results. Perhaps a search results banner similar to Nautilus. --- doc/reference/shell/eshell-docs.sgml | 1 + doc/reference/shell/eshell-sections.txt | 71 ++++--- doc/reference/shell/eshell.types | 1 + doc/reference/shell/tmpl/e-shell-content.sgml | 272 +----------------------- doc/reference/shell/tmpl/e-shell-searchbar.sgml | 223 +++++++++++++++++++ doc/reference/shell/tmpl/e-shell-view.sgml | 84 ++++++++ doc/reference/shell/tmpl/eshell-unused.sgml | 264 +++++++++++++++++++++++ 7 files changed, 623 insertions(+), 293 deletions(-) create mode 100644 doc/reference/shell/tmpl/e-shell-searchbar.sgml (limited to 'doc/reference') diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index 9c4e875992..b744d9c78a 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -20,6 +20,7 @@ url="http://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.o + diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index 0b67e41ef7..7dc8df9e72 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -69,37 +69,15 @@ EShellBackendPrivate EShellContent EShellContent e_shell_content_new +e_shell_content_get_searchbar 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_get_search_name 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 E_SHELL_CONTENT E_IS_SHELL_CONTENT @@ -113,6 +91,40 @@ e_shell_content_get_type EShellContentPrivate +
+e-shell-searchbar +EShellSearchbar +EShellSearchbar +e_shell_searchbar_new +e_shell_searchbar_get_shell_view +e_shell_searchbar_get_filter_combo_box +e_shell_searchbar_get_filter_visible +e_shell_searchbar_set_filter_visible +e_shell_searchbar_get_search_hint +e_shell_searchbar_set_search_hint +e_shell_searchbar_get_search_option +e_shell_searchbar_set_search_option +e_shell_searchbar_get_search_text +e_shell_searchbar_set_search_text +e_shell_searchbar_get_search_visible +e_shell_searchbar_set_search_visible +e_shell_searchbar_get_scope_combo_box +e_shell_searchbar_get_scope_visible +e_shell_searchbar_set_scope_visible +e_shell_searchbar_restore_state + +E_SHELL_SEARCHBAR +E_IS_SHELL_SEARCHBAR +E_TYPE_SHELL_SEARCHBAR +E_SHELL_SEARCHBAR_CLASS +E_IS_SHELL_SEARCHBAR_CLASS +E_SHELL_SEARCHBAR_GET_CLASS +EShellSearchbarClass +e_shell_searchbar_get_type + +EShellSearchbarPrivate +
+
e-shell-settings EShellSettings @@ -240,6 +252,9 @@ 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_search_rule +e_shell_view_set_search_rule +e_shell_view_get_search_query e_shell_view_get_size_group e_shell_view_get_shell_backend e_shell_view_get_shell_content @@ -248,7 +263,11 @@ e_shell_view_get_shell_taskbar e_shell_view_get_shell_window e_shell_view_get_state_key_file e_shell_view_set_state_dirty +e_shell_view_clear_search +e_shell_view_custom_search e_shell_view_execute_search +e_shell_view_block_execute_search +e_shell_view_unblock_execute_search e_shell_view_update_actions e_shell_view_show_popup_menu e_shell_view_new_view_instance @@ -330,10 +349,6 @@ E_ALERT_NO_SAVE_FILE E_ALERT_NO_LOAD_FILE EAlert e_alert_new -e_alert_newv -e_alert_free -e_alert_new_dialog -e_alert_new_dialog_for_args e_alert_run_dialog e_alert_run_dialog_for_args e_alert_dialog_count_buttons diff --git a/doc/reference/shell/eshell.types b/doc/reference/shell/eshell.types index e03302f8d5..ae84ef0905 100644 --- a/doc/reference/shell/eshell.types +++ b/doc/reference/shell/eshell.types @@ -6,6 +6,7 @@ e_signature_list_get_type e_shell_get_type e_shell_backend_get_type e_shell_content_get_type +e_shell_searchbar_get_type e_shell_sidebar_get_type e_shell_switcher_get_type e_shell_taskbar_get_type diff --git a/doc/reference/shell/tmpl/e-shell-content.sgml b/doc/reference/shell/tmpl/e-shell-content.sgml index fb17dd86bf..b4803b93b0 100644 --- a/doc/reference/shell/tmpl/e-shell-content.sgml +++ b/doc/reference/shell/tmpl/e-shell-content.sgml @@ -23,66 +23,6 @@ EShellContent - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -97,7 +37,7 @@ EShellContent @Returns: - + @@ -106,169 +46,7 @@ EShellContent @Returns: - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@filter_action: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@filter_value: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@filter_visible: - - - - - - - -@shell_content: -@action_value: - - - - - - - -@shell_content: -@action_value: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@search_hint: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@search_rule: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@search_text: - - - - - - - -@shell_content: -@Returns: - - - - - - - -@shell_content: -@search_visible: - - - + @@ -277,16 +55,7 @@ EShellContent @Returns: - - - - - -@shell_content: -@scope_action: - - - + @@ -295,16 +64,7 @@ EShellContent @Returns: - - - - - -@shell_content: -@scope_value: - - - + @@ -313,16 +73,16 @@ EShellContent @Returns: - + @shell_content: -@scope_visible: +@view_id: - + @@ -331,15 +91,6 @@ EShellContent @Returns: - - - - - -@shell_content: -@view_id: - - @@ -364,12 +115,3 @@ EShellContent @shell_content: - - - - - -@shell_content: -@group_name: - - diff --git a/doc/reference/shell/tmpl/e-shell-searchbar.sgml b/doc/reference/shell/tmpl/e-shell-searchbar.sgml new file mode 100644 index 0000000000..a491daf40a --- /dev/null +++ b/doc/reference/shell/tmpl/e-shell-searchbar.sgml @@ -0,0 +1,223 @@ + +EShellSearchbar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@shell_view: +@Returns: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@filter_visible: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@search_hint: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@search_option: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@search_text: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@search_visible: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@Returns: + + + + + + + +@searchbar: +@scope_visible: + + + + + + + +@searchbar: +@group_name: + + diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml index 0508608faf..03d8830fdb 100644 --- a/doc/reference/shell/tmpl/e-shell-view.sgml +++ b/doc/reference/shell/tmpl/e-shell-view.sgml @@ -23,6 +23,21 @@ EShellView + + + + + +@eshellview: the object which received the signal. + + + + + + +@eshellview: the object which received the signal. +@arg1: + @@ -54,6 +69,11 @@ EShellView + + + + + @@ -104,6 +124,8 @@ EShellView @icon_name: @ui_definition: @ui_manager_id: +@search_context_type: +@search_context: @search_options: @search_rules: @view_collection: @@ -112,6 +134,8 @@ EShellView @new_shell_sidebar: @new_shell_taskbar: @toggled: +@clear_search: +@custom_search: @execute_search: @update_actions: @@ -196,6 +220,33 @@ EShellView @page_num: + + + + + +@shell_view: +@Returns: + + + + + + + +@shell_view: +@search_rule: + + + + + + + +@shell_view: +@Returns: + + @@ -267,6 +318,23 @@ EShellView @shell_view: + + + + + +@shell_view: + + + + + + + +@shell_view: +@custom_rule: + + @@ -275,6 +343,22 @@ EShellView @shell_view: + + + + + +@shell_view: + + + + + + + +@shell_view: + + diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml index 359f603599..f0e339d5ab 100644 --- a/doc/reference/shell/tmpl/eshell-unused.sgml +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -509,12 +509,84 @@ intelligent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2068,6 +2140,22 @@ intelligent @shell_backend: @Returns: + + + + + +@shell_content: +@action_value: + + + + + + +@shell_content: +@action_value: + @@ -2076,6 +2164,86 @@ intelligent @shell_content: @Returns: + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@Returns: + @@ -2084,6 +2252,22 @@ intelligent @shell_content: @Returns: + + + + + +@shell_content: +@Returns: + + + + + + +@shell_content: +@group_name: + @@ -2092,6 +2276,78 @@ intelligent @shell_content: @context: + + + + + +@shell_content: +@filter_action: + + + + + + +@shell_content: +@filter_value: + + + + + + +@shell_content: +@filter_visible: + + + + + + +@shell_content: +@scope_action: + + + + + + +@shell_content: +@scope_value: + + + + + + +@shell_content: +@scope_visible: + + + + + + +@shell_content: +@search_hint: + + + + + + +@shell_content: +@search_rule: + + + + + + +@shell_content: +@search_text: + @@ -2100,6 +2356,14 @@ intelligent @shell_content: @search_value: + + + + + +@shell_content: +@search_visible: + -- cgit v1.2.3