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.

4 files changed, 578 insertions, 265 deletions

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
 </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-radio-action ##### -->
-<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>
 
@@ -97,7 +37,7 @@ EShellContent
 @Returns: 
 
 
-<!-- ##### FUNCTION e_shell_content_check_state ##### -->
+<!-- ##### FUNCTION e_shell_content_get_searchbar ##### -->
 <para>
 
 </para>
@@ -106,169 +46,7 @@ EShellContent
 @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 ##### -->
+<!-- ##### FUNCTION e_shell_content_check_state ##### -->
 <para>
 
 </para>
@@ -277,16 +55,7 @@ EShellContent
 @Returns: 
 
 
-<!-- ##### FUNCTION e_shell_content_set_scope_action ##### -->
-<para>
-
-</para>
-
-@shell_content: 
-@scope_action: 
-
-
-<!-- ##### FUNCTION e_shell_content_get_scope_value ##### -->
+<!-- ##### FUNCTION e_shell_content_get_shell_view ##### -->
 <para>
 
 </para>
@@ -295,16 +64,7 @@ EShellContent
 @Returns: 
 
 
-<!-- ##### FUNCTION e_shell_content_set_scope_value ##### -->
-<para>
-
-</para>
-
-@shell_content: 
-@scope_value: 
-
-
-<!-- ##### FUNCTION e_shell_content_get_scope_visible ##### -->
+<!-- ##### FUNCTION e_shell_content_get_view_id ##### -->
 <para>
 
 </para>
@@ -313,16 +73,16 @@ EShellContent
 @Returns: 
 
 
-<!-- ##### FUNCTION e_shell_content_set_scope_visible ##### -->
+<!-- ##### FUNCTION e_shell_content_set_view_id ##### -->
 <para>
 
 </para>
 
 @shell_content: 
-@scope_visible: 
+@view_id: 
 
 
-<!-- ##### FUNCTION e_shell_content_get_view_id ##### -->
+<!-- ##### FUNCTION e_shell_content_get_search_name ##### -->
 <para>
 
 </para>
@@ -331,15 +91,6 @@ EShellContent
 @Returns: 
 
 
-<!-- ##### FUNCTION e_shell_content_set_view_id ##### -->
-<para>
-
-</para>
-
-@shell_content: 
-@view_id: 
-
-
 <!-- ##### FUNCTION e_shell_content_run_advanced_search_dialog ##### -->
 <para>
 
@@ -364,12 +115,3 @@ EShellContent
 @shell_content: 
 
 
-<!-- ##### FUNCTION e_shell_content_restore_state ##### -->
-<para>
-
-</para>
-
-@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 @@
+<!-- ##### SECTION Title ##### -->
+EShellSearchbar
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT EShellSearchbar ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG EShellSearchbar:filter-combo-box ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:filter-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:scope-combo-box ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:scope-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:search-hint ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:search-option ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:search-text ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:search-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EShellSearchbar:shell-view ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION e_shell_searchbar_new ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_shell_view ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_filter_combo_box ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_filter_visible ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_set_filter_visible ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@filter_visible: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_search_hint ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_set_search_hint ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@search_hint: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_search_option ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_set_search_option ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@search_option: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_search_text ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_set_search_text ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@search_text: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_search_visible ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_set_search_visible ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@search_visible: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_scope_combo_box ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_get_scope_visible ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_set_scope_visible ##### -->
+<para>
+
+</para>
+
+@searchbar: 
+@scope_visible: 
+
+
+<!-- ##### FUNCTION e_shell_searchbar_restore_state ##### -->
+<para>
+
+</para>
+
+@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
 </para>
 
 
+<!-- ##### SIGNAL EShellView::clear-search ##### -->
+<para>
+
+</para>
+
+@eshellview: the object which received the signal.
+
+<!-- ##### SIGNAL EShellView::custom-search ##### -->
+<para>
+
+</para>
+
+@eshellview: the object which received the signal.
+@arg1: 
+
 <!-- ##### SIGNAL EShellView::execute-search ##### -->
 <para>
 
@@ -54,6 +69,11 @@ EShellView
 
 </para>
 
+<!-- ##### ARG EShellView:search-rule ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG EShellView:shell-backend ##### -->
 <para>
 
@@ -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: 
 
 
+<!-- ##### FUNCTION e_shell_view_get_search_rule ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION e_shell_view_set_search_rule ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+@search_rule: 
+
+
+<!-- ##### FUNCTION e_shell_view_get_search_query ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+@Returns: 
+
+
 <!-- ##### FUNCTION e_shell_view_get_size_group ##### -->
 <para>
 
@@ -267,6 +318,23 @@ EShellView
 @shell_view: 
 
 
+<!-- ##### FUNCTION e_shell_view_clear_search ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+
+
+<!-- ##### FUNCTION e_shell_view_custom_search ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+@custom_rule: 
+
+
 <!-- ##### FUNCTION e_shell_view_execute_search ##### -->
 <para>
 
@@ -275,6 +343,22 @@ EShellView
 @shell_view: 
 
 
+<!-- ##### FUNCTION e_shell_view_block_execute_search ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+
+
+<!-- ##### FUNCTION e_shell_view_unblock_execute_search ##### -->
+<para>
+
+</para>
+
+@shell_view: 
+
+
 <!-- ##### FUNCTION e_shell_view_update_actions ##### -->
 <para>
 
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
 </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-radio-action ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG EShellContent:search-rule ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG EShellContent:search-text ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### ARG EShellContent:search-value ##### -->
 <para>
 
 </para>
 
 
+<!-- ##### ARG EShellContent:search-visible ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### ENUM EShellLineStatus ##### -->
 <para>
 
@@ -2068,6 +2140,22 @@ intelligent
 @shell_backend: 
 @Returns: 
 
+<!-- ##### FUNCTION e_shell_content_add_filter_separator_after ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@action_value: 
+
+<!-- ##### FUNCTION e_shell_content_add_filter_separator_before ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@action_value: 
+
 <!-- ##### FUNCTION e_shell_content_get_context ##### -->
 <para>
 
@@ -2076,6 +2164,86 @@ intelligent
 @shell_content: 
 @Returns: 
 
+<!-- ##### FUNCTION e_shell_content_get_filter_action ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_get_filter_value ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_get_filter_visible ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_get_scope_action ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_get_scope_value ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_get_scope_visible ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### 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_get_search_rule ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_get_search_text ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
 <!-- ##### FUNCTION e_shell_content_get_search_value ##### -->
 <para>
 
@@ -2084,6 +2252,22 @@ intelligent
 @shell_content: 
 @Returns: 
 
+<!-- ##### FUNCTION e_shell_content_get_search_visible ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@Returns: 
+
+<!-- ##### FUNCTION e_shell_content_restore_state ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@group_name: 
+
 <!-- ##### FUNCTION e_shell_content_set_context ##### -->
 <para>
 
@@ -2092,6 +2276,78 @@ intelligent
 @shell_content: 
 @context: 
 
+<!-- ##### FUNCTION e_shell_content_set_filter_action ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@filter_action: 
+
+<!-- ##### FUNCTION e_shell_content_set_filter_value ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@filter_value: 
+
+<!-- ##### FUNCTION e_shell_content_set_filter_visible ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@filter_visible: 
+
+<!-- ##### FUNCTION e_shell_content_set_scope_action ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@scope_action: 
+
+<!-- ##### FUNCTION e_shell_content_set_scope_value ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@scope_value: 
+
+<!-- ##### FUNCTION e_shell_content_set_scope_visible ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@scope_visible: 
+
+<!-- ##### FUNCTION e_shell_content_set_search_hint ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@search_hint: 
+
+<!-- ##### FUNCTION e_shell_content_set_search_rule ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@search_rule: 
+
+<!-- ##### FUNCTION e_shell_content_set_search_text ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@search_text: 
+
 <!-- ##### FUNCTION e_shell_content_set_search_value ##### -->
 <para>
 
@@ -2100,6 +2356,14 @@ intelligent
 @shell_content: 
 @search_value: 
 
+<!-- ##### FUNCTION e_shell_content_set_search_visible ##### -->
+<para>
+
+</para>
+
+@shell_content: 
+@search_visible: 
+
 <!-- ##### FUNCTION e_shell_create_window ##### -->
 <para>