Hydrogenaudio Knowledgebase - User contributions [en]

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2024-06-18T08:23:59Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:Foobar2000 Legacy Default UI components|Legacy Default UI components]]
[[Category:Foobar2000 Legacy Columns UI components|Legacy Columns UI components]]
{{infobox foobar2000 component
| name = Quick Search Toolbar
| screenshot = [[Image:QuickSearch3.png|256px]]
| caption = Quick Search View
| module_name = foo_quicksearch
| developer = NEMO7538
| repository =
| released =
| released_ref =
| stable_release = 3.6
| stable_release_date = 2015-10-13
| preview_release =
| preview_release_date =
| foobar2000_minimum = 1.3
| foobar2000_maximum =
| foobar2000_ui_module = Default UI, Columns UI
| use =
| license =
}}

=General=
'''foo_quicksearch''' is derived from [https://hydrogenaud.io/index.php/topic,44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [https://hydrogenaud.io/index.php/topic,80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

In addition, Ctrl+Backspace will delete a "word" in the search box.

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist and highlight the results within the playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg highlighting the current playlist items according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.9''' [2024-06-18]
** Fixed a crash that happens when foo_multisource is also installed.
* '''V3.8''' [2024-05-15]
** Fix the quicksearch window on-close breaking foobar fonts
** Make the preferences page have a dark mode
* '''V3.7''' [2024-05-08]
** Updated to the foobar2000 SDK 2023-09-23 with an x86_64 component build now available.
** Fixed a bug that caused the "Set focus to search results" to activate when the text hasn't changed.
** Added a handler for Ctrl+Backspace to delete a "word" in the search box
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2024-05-17T17:34:14Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:Foobar2000 Legacy Default UI components|Legacy Default UI components]]
[[Category:Foobar2000 Legacy Columns UI components|Legacy Columns UI components]]
{{infobox foobar2000 component
| name = Quick Search Toolbar
| screenshot = [[Image:QuickSearch3.png|256px]]
| caption = Quick Search View
| module_name = foo_quicksearch
| developer = NEMO7538
| repository =
| released =
| released_ref =
| stable_release = 3.6
| stable_release_date = 2015-10-13
| preview_release =
| preview_release_date =
| foobar2000_minimum = 1.3
| foobar2000_maximum =
| foobar2000_ui_module = Default UI, Columns UI
| use =
| license =
}}

=General=
'''foo_quicksearch''' is derived from [https://hydrogenaud.io/index.php/topic,44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [https://hydrogenaud.io/index.php/topic,80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

In addition, Ctrl+Backspace will delete a "word" in the search box.

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist and highlight the results within the playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg highlighting the current playlist items according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.8''' [2024-05-15]
** Fix the quicksearch window on-close breaking foobar fonts
** Make the preferences page have a dark mode
* '''V3.7''' [2024-05-08]
** Updated to the foobar2000 SDK 2023-09-23 with an x86_64 component build now available.
** Fixed a bug that caused the "Set focus to search results" to activate when the text hasn't changed.
** Added a handler for Ctrl+Backspace to delete a "word" in the search box
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components

2024-05-08T08:21:24Z

NEMO7538:

{{fb2k}}
This page contains most [[foobar2000]] components available at time of history last update.

{{panel|This Page will show only components which are built for at least x86 64-bit versions of Foobar2000. Components which exist in 32-bit version '''only''', are now to be found on [[foobar2000:Legacy_components|Legacy Components]] page. Transition of wiki categories will take some time. Read more, here: [[foobar2000:Version_2.0_Release_Notes|Release Notes Version 2.0]]|color=green}}

==Official components==
The following components are created and maintained by the foobar2000 development team. Support for them should be asked for in the [https://hydrogenaud.io/index.php/board,29.0.html Support forum].

===Included in the installer===
====Required components====
The following components are required for installation, in addition to foobar2000 Core module. These components are installed when type of installation is Minimal.

* [[Foobar2000:Components/Default user interface (foo ui std)|Default user interface (foo_ui_std)]] · Allows complex layout using building blocks that are called UI Elements, many of them already present after the installation. Additional Components, which are incorporated in Default user interface, are: Album List, Decoding Speed Test and File Integrity Verifier.
* Standard DSP Array (foo_dsp_std) · Equalizer, resampler, advanced limiter, hard limiter, stereo to 4 channel upmixer and a couple other effects.
* Standard Input Array (foo_input_std), which includes additional Components: CD Audio Decoder, FFmpeg Decoders and Monkey's Audio Decoder.

====Optional components====
[[Image:Optional_features.png|thumb|The Optional Features screen of the foobar2000 installer]]
In addition to foobar2000's core functionality, following components can be installed as needed, through choice of Type of install.

If selected "Normal", following components will be included, cumulative to Minimal:
* [[Foobar2000:Converter|Converter (foo_converter)]] · Converts files to WAV or any other formats using command line encoders.
* [[Foobar2000:Equalizer DSP|Equalizer DSP (foo_dsp_eq)]] · Equalizer DSP (foo_dsp_eq) · An 18-band graphic equalizer based on SuperEQ library.

If selected "Full", following additional components will be included, cumulative to Normal and Minimal:
* [[Foobar2000:Archive Reader (foo_unpack)|Archive Reader (foo_unpack)]] · Adds support for playing files directly from ZIP RAR and GZIP archives.
* [[Foobar2000:Components/Freedb_Tagger_(foo_freedb2)|Freedb Tagger (foo_freedb2)]] · Tag retrieving support from freedb service for any set of files (mp3,mpc,flac,...-not only CDDA tracks).
* [[Foobar2000:File Operations (foo_fileops)|File Operations (foo_fileops)]] · Renames, moves, or copies files according to specified patterns.

===Additional components===
These components are provided as separate downloads, found on the [http://www.foobar2000.org/components/author/Peter Official Components page].
*[[Foobar2000:Components/ABX Comparator (foo abx)|ABX comparator (foo_abx)]] · Performs a double-blind listening test between two tracks.
*[[Foobar2000:Components/AdPlug (foo_adplug)|AdPlug (foo_adplug)]] Decoding support for all Adlib FM chip formats supported by the AdPlug library.
*[[Foobar2000:Components/ASIO Output (foo_out_asio)|ASIO Output (foo_out_asio)]] · Provides ASIO output support.
*[[Foobar2000:Components/Audio CD Writer (foo_burninate)|Audio CD Writer (foo_burninate)]] · CD burning support.
*[[Foobar2000:Components/Classical User Interface (foo_ui_classic)|Classical User Interface (foo_ui_classic)]] · The Default User Interface from early foobar2000 versions.
*[[Foobar2000:Components/Command-Line Decoder Wrapper (foo_input_exe)|Command-Line Decoder Wrapper (foo_input_exe)]] · Allows to play or convert any audio format with a standalone command-line decoder available.
*[[Foobar2000:Components/DEAF Module Decoder (foo_deaf)|DEAF Module Decoder (foo_deaf)]] · Plays module files: MOD, S3M, XM, IT, 669, PTM, PSM, MTM and UMX.
*[[Foobar2000:Components/FFmpeg Decoder Wrapper (foo_input_ffmpeg)|FFmpeg Decoder Wrapper (foo_input_ffmpeg)]] · Allows foobar2000 to read arbitrary file formats via user-supplied ffmpeg.exe and ffprobe.exe.
* [[Foobar2000:Components/Game Music Emu Decoder (foo_input_gme)|Game Music Emu Decoder (foo_input_gme)]]· plays several emulation formats, based on the "Game_Music_Emu" audio library by Shay Green
*[[Foobar2000:Components/Masstagger (foo_masstag)|Masstagger (foo_masstag)]] · Automates various tag editing operations.
* [[Foobar2000:Components/Monkey's Audio Decoder (foo_input_monkey)|Monkey's Audio Decoder (foo_input_monkey)]] Adds decoding support for Monkey's Audio files (.[[APE]]) as well as APE Link files (.[[APL]]).
*[[Foobar2000:Components/OpenMPT Module Decoder (foo_openmpt54)|OpenMPT Module Decoder (foo_openmpt54)]] · This component decodes modules, or music files combining both samples and sequence data and effects, using libopenmpt.
*[[Foobar2000:Components/Playback Statistics v3.x (foo playcount)|Playback Statistics (foo playcount)]] Collects playback statistics for your Media Library content.
*[[Foobar2000:Components/Quick Tagger (foo_quicktag)|Quick Tagger (foo_quicktag)]] · Adds customizable context menu commands for quickly setting tag fields to preconfigured values.
*[[Foobar2000:Components/Text Tools (foo texttools)|Text Tools (foo_texttools)]] · Adds customizable context menu commands for copying information about the selected tracks to Windows Clipboard.
*[[Foobar2000:Components/Utility DSP Array (foo_dsp_utility)|Utility DSP Array (foo_dsp_utility)]] · Contains the following utility DSP modules: Add Noise, DC Offset, Sample Offset, Scale, Upmix, Stereo Balance.
*[[Foobar2000:Components/UPnP MediaRenderer Output (foo_out_upnp)|UPnP MediaRenderer Output (foo_out_upnp)]] · Presents any UPnP MediaRenderer devices present on your home network as foobar2000 output devices.
*[[Foobar2000:Components/VST 2.x/3.x Adapter (foo_dsp_vst3)|VST 2.x/3.x Adapter (foo_dsp_vst3)]] · Allows VST effects to be used as DSPs in foobar2000.

==3rd party components==
The following components are created and maintained by 3rd-party authors, using foobar2000's [http://www.foobar2000.org/SDK.html SDK]. Support for these components should be asked for in the [https://hydrogenaud.io/index.php/board,33.0.html 3rd Party Plugins forum]. Asking for help directly in the component's thread is usually preferred.
=== User Interface Modules ===

==== Columns UI ====
[[Foobar2000:Components/Columns UI (foo_ui_columns)|Columns UI (foo_ui_columns)]] · Very popular alternate interface for foobar2000 based on a columns and panel layout.

Columns UI introduced components with [[#Panels|panel]] capability which extend the user interface.

=== User interface add-ons ===
==== UI elements ====
The [[Foobar2000:Components/Default user interface (foo_ui_std)|default user interface (foo_ui_std)]] · Included in the standard installation package, can be extended with the following component(s):
* [[Foobar2000:Components/Coverflow (foo coverflow)|Coverflow (foo_coverflow)]] · Interactive 3D Coverflow.
* [[Foobar2000:Components/Floating window (foo_flowin)|Floating window (foo_flowin)]] · a component that host Default UI elements.
* [[Foobar2000:Components/JScript Panel 3 (foo_jscript_panel3)|JScript Panel 3 (foo_jscript_panel3)]] · a component which allows creation of customisable panels that can be written with JavaScript rather than the C++ required by the foobar2000 SDK.
* [[Foobar2000:Components/Waveform Minibar (mod) (foo_wave_minibar_mod)|Waveform Minibar (mod) (foo_wave_minibar_mod)]] · Element for DUI with seekbar functionality on top of the waveform of the playing song.

==== Panels ====
Panels extend the functionality of Columns UI components.
* [[Foobar2000:Components/Album List Panel (foo_uie_albumlist)|Album List Panel (foo_uie_albumlist)]] · Displays the database in a treeview using customizable sorting methods (by genre, artist, directory, etc.)
* [[Foobar2000:Components/Console_(foo_uie_console)|Console (foo_uie_console)]] · Panel version of console. Displays diagnostic messages. Requires Columns UI 0.1.3 beta 1 or newer.
* [[Foobar2000:Components/JScript Panel 3 (foo_jscript_panel3)|JScript Panel 3 (foo_jscript_panel3)]] · a component which allows creation of customisable panels that can be written with JavaScript rather than the C++ required by the foobar2000 SDK.
* [[Foobar2000:Components/Popup Panels (foo_popup_panels)|Popup Panels (foo_popup_panels)]] · This component allows displaying ColumnsUI panels in a popup window.
* [[Foobar2000:Components/Waveform Minibar (mod) (foo_wave_minibar_mod)|Waveform Minibar (mod) (foo_wave_minibar_mod)]] · Waveform Minibar (mod) is a seekbar that shows the waveform of the track.

===DSP===
====Converters====
* [[Foobar2000:Components/SRC Resampler DSP (foo_dsp_src_resampler)|SRC Resampler DSP (foo_dsp_src_resampler)]] · Secret Rabbit Code resampler.

====Effects====
* [[Foobar2000:Components/Crossmix DSP (foo_dsp_crossmix)|Crossmix DSP (foo_dsp_crossmix)]] · Mixes the beginning of the next track over the ending of the previous track without any fading.
* [[Foobar2000:Components/Effect DSP (foo_dsp_effect)|Effect DSP (foo_dsp_effect)]] · Adds miscellaneous effects.
* [[Foobar2000:Components/Fade In-Out DSP (foo_dsp_fadeinout)|Fade In/Out DSP (foo_dsp_fadeinout)]] · Allows adding linear, sine, cosine, or logarithmic shaped fade-in and fade-out effects.
* [[Foobar2000:Components/Vocal Exciter DSP (foo_dsp_vocal_exciter)|Vocal Exciter DSP (foo_dsp_vocal_exciter)]] · Adds harmonically related distortion to high frequencies to give more presence.

====Headphones====
* [[Foobar2000:Components/MathAudio Headphone EQ (foo_headphone_eq)|MathAudio Headphone EQ (foo_headphone_eq)]] · Helps to detect and compensate for the unwanted resonances in high-quality headphones and earphones.

====Multichannel audio====
* [[Foobar2000:Components/Downmixer DSP (foo_dsp_downmixer)|Downmixer DSP (foo_dsp_downmixer)]] · Downmixes source to the selected output format.
* [[Foobar2000:Components/Trifield LR-LRC Decoder DSP (foo_dsp_trifield)|Trifield LR→LRC Decoder DSP (foo_dsp_trifield)]] · Implementation of Michael Gerzon's Trifield decoder.

====Multi-purpose====
* [[Foobar2000:Components/MathAudio Room EQ (foo_room_eq)|MathAudio Room EQ (foo_room_eq)]] · Corrects deficiencies of room acoustics (multipoint compensation).
* [[Foobar2000:Components/mda Dither DSP (foo_dsp_mdadither)|mda Dither DSP (foo_dsp_mdadither)]] · Range of dither types for word-length reduction.
* [[Foobar2000:Components/Stereo Convolver (foo_dsp_stereoconv)|Stereo Convolver (foo_dsp_stereoconv)]] · Take stereo audio and convolve each channel with two impulse responses.

====Utilities====
* [[Foobar2000:Components/Post-track Silence (foo_dsp_silence)|Affix silence (foo_dsp_silence)]] Inserts a configurable amount of silence after each track to help external devices like MiniDisc players to sync track changes.
* [[Foobar2000:Components/Amplifier DSP (foo_dsp_amp)|Amplifier DSP (foo_dsp_amp)]] · A simple volume adjustment DSP allowing the signal amplitude to be both boosted and lowered.
* [[Foobar2000:Components/EBU R128 Normalizer (foo_r128norm)|EBU R128 Normalizer (foo_r128norm)]] · This component provides a simple DSP for normalizing audio tracks using a running windowed calculation of the EBU R-128 standard.
* [[Foobar2000:Components/Fake Gapless DSP (foo_dsp_fakegapless)|Fake Gapless DSP (foo_dsp_fakegapless)]] · Briefly fades track changes to silence to avoid glitches with gapless tracks when encoded with lossy codecs.
* [[Foobar2000:Components/GAP Killer (foo_dsp_nogaps)|Gap Killer DSP (foo_dsp_nogaps)]] · Removes silence from track transitions.
* [[Foobar2000:Components/Hard Clip DSP (foo_dsp_hardclip)|Hard Clip DSP (foo_dsp_hardclip)]] · Clips peaks forcing foobar2000 output to match players that don't support floating point output.
* [[foobar2000:Components/Noise Sharpening (foo_dsp_delta)|Noise Sharpening (foo_dsp_delta)]] · This component boosts high frequencies.
* [[Foobar2000:Components/Pregap DSP (foo_dsp_pregap)|Pregap DSP (foo_dsp_pregap)]] · Inserts silence before real playback begins.
* [[Foobar2000:Components/ReplayGain DSP (foo_dsp_replaygain)|ReplayGain DSP (foo_dsp_replaygain)]] · Alternative ReplayGain implementation with support for smarter automatic mode selection.
* [[Foobar2000:Components/Skip Silence DSP (foo_dsp_skip_silence)|Skip Silence DSP (foo_dsp_skip_silence)]] · Automatically fast forwards over extended periods of silence.
* [[Foobar2000:Components/Smart Dither DSP (foo_dsp_dither)|Smart Dither DSP (foo_dsp_dither)]] · TPDF dither DSP that leaves digital silence untouched.

===Input===
====Music decoders====
* [[Foobar2000:Components/DVD Audio Decoder (foo_input_dvda)|DVD Audio Decoder (foo_input_dvda)]] · Decodes DVD Audio ([[DVD Audio]]) Disks.
* [[Foobar2000:Components/OptimFROG Decoder_(foo_input_ofr)|OptimFROG Decoder (foo_input_ofr)]] · Decodes OptimFROG audio format.
* [[foobar2000:Components/QOA Audio Decoder (foo_qoa)|QOA Audio Decoder (foo_qoa)]] · Decodes the Quite OK Audio (QOA) format.
* [[Foobar2000:Components/TAK Decoder (foo_input_tak)|TAK Decoder (foo_input_tak)]] · Adds support for decoding and tagging [[TAK]] files as well as reading embedded album art.
* [[Foobar2000:Components/TTA Audio Decoder (foo_input_tta)|TTA Audio Decoder (foo_input_tta)]] · Decodes True Audio ([[TTA]]) audio format.

====Other decoders====
* [[Foobar2000:Components/Another Slight Atari Player (foo_asap)|Another Slight Atari Player (foo_asap)]]· adds playback of Atari 8-bit chiptunes to foobar2000.
* [[Foobar2000:Components/MIDI Player (foo_midi)|MIDI Player (foo_midi)]] · adds playback of MIDI files to foobar2000.
* [[Foobar2000:Components/sidplay (foo_sid)|SID Player (foo_sid)]] · adds playback of SID and MUS files to foobar2000.
* [[Foobar2000:Components/V2M Decoder (foo_input_v2m)|V2M Decoder (foo_input_v2m)]] · Farbrausch V2 module (V2M) decoder.
* [[Fobar2000:Components/vgmstream decoder (foo_input_vgmstrean)|vgmstream decoder]] (foo_input_vgmstrean) · allows playback of hundreds of streamed (prerecorded) audio formats used in video games.

===Visualisation===
* [[Foobar2000:Components/ProjectM Visualisation (foo_vis_projectM)|ProjectM Visualisation (foo_vis_projectM)]] Based on the ProjectM project, which is a reimplementation of Milkdrop under OpenGL.
* [[Foobar2000:Components/Enhanced Spectrum Analyzer (foo enhanced spectrum analyzer)|Enhanced Spectrum Analyzer (foo_enhanced_spectrum_analyzer)]] Displays a detailed FFT spectrum in a logarithmic frequency scale.
* [[Foobar2000:Components/Loudness Peakmeter (foo loudness peakmeter)|Loudness Peakmeter (foo_loudness_peakmeter)]] Displays a loudness meter and graph in real-time.
* [[Foobar2000:Components/Spectrum Analyzer (foo vis spectrum analyzer)|Spectrum Analyzer (foo_vis_spectrum_analyzer)]] Display an audio spectrum visualization. Currently a remake of [[foobar2000:Components/Musical Spectrum (foo_musical_spectrum)|Musical Spectrum]] component for foobar2000 64-bit versions
* [[foobar2000:Components/MIDI Visualizer (foo_vis_midi)|MIDI Visualizer (foo_vis_midi)]] Visualize MIDI events.

===Other===
====General====
* [[Foobar2000:Components/Cover Info (foo_cover_info)|Cover Info (foo_cover_info)]] · This component scans a selection of files for embedded album art and stores the results in a database.
* [[Foobar2000:Components/Cover Resizer (foo_cover_resizer)|Cover Resizer (foo_cover_resizer)]] · Utilities for manipulating embedded art of files from within of foobar 2000.
* [[Foobar2000:Components/Loop (foo_loop)|Loop (foo_loop)]] · This component offers looping in a track.
* [[Foobar2000:Components/Metronome (foo_metronome)|Metronome (foo_metronome)]] · a simple console metronome.
* [[Foobar2000:Components/No Display Standby (foo_nds)|No Display Standby (foo_nds)]] · This component disables monitor power saving feature while music is playing.
* [[Foobar2000:Components/No Sleep (foo_nosleep)|No Sleep (foo_nosleep)]] · Prevents system from entering standby mode while foobar2000 is running.
* [[Foobar2000:Components/Preview (foo_preview)|Preview (foo_preview)]] · Plays first seconds of consecutive tracks.
* [[Foobar2000:Components/QSearch (foo_qsearch|QSearch (foo_qsearch)]] · Provides 6 context menu items to create playlists or open a search window from the selected track's metadata.
* [[Foobar2000:Components/Quicksearch UI Element (foo quicksearch)|Quicksearch UI Element (foo_quicksearch)]] Search toolbar that sends results to a playlist.
* [[Foobar2000:Components/Replaygain Override (foo rg trn)|Replaygain Override (foo rg trn)]] · Provides a way to specify which replaygain modes to use for each playback order.
* [[Foobar2000:Components/Renamer (foo_renamer)|Renamer (foo_renamer)]] · An alternative file renamer for people who wish to configure reserved character replacement rules manually.
* [[Foobar2000:Components 0.9/Run (foo_run)|Run Services (foo_run)]] · Allows you to run a external program with the foobar syntax.
* [[Foobar2000:Components/Run Main (foo_run_main)|Run Main (foo_run_main)]] · This component has full support for dynamically generated menu commands.
* [[Foobar2000:Components/Scheduler Mod (foo_scheduler_mod)|Scheduler Mod (foo_scheduler_mod)]] Plugin for scheduling actions like play, stop, system shutdown/wake up and many more.
* [[Foobar2000:Components/Seekbox (foo_seek_box)|Seekbox (foo_seek_box)]] · Main menu item that pops up a box for seeking to a particular hh:mm:ss time in the current track.
* [[Foobar2000:Components/Seek to Time (foo_seek_to_time)|Seek to Time (foo_seek_to_time)]] · This component allows defining timestamps to directly seek to with keyboard shortcuts.
* [[Foobar2000:Components/Stop after Album (foo_stopafteralbum)|Stop after Album (foo_stopafteralbum)]] · This component allows stop playing according to defined tags.
* [[Foobar2000:Components/SQL Tree (foo_uie_sql_tree)|SQL Tree (foo_uie_sql_tree)]] · This component makes possible viewing the media library in a tree structure using SQL queries.
* [[Foobar2000:Components/SQLite Utilities (foo_sqlite)|SQLite Utilities (foo_sqlite)]] · This component allows viewing and changing the contents of the media library and the playlists by using SQL statements.
* [[Foobar2000:Components/SVG services (foo_svg_services)|SVG services (foo_svg_services)]] · This component provides an SVG renderer, for use by other foobar2000 components.
* [[Foobar2000:Components/Timebomb (foo_timebomb)|Timebomb (foo_timebomb)]] · Stop playback / exit program after a specified time.
* [[Foobar2000:Components/Timebomb2 (foo_timebomb2)|Timebomb2 (foo_timebomb2)]] · Stop playing after predefined time.
* [[Foobar2000:Components/PGGB-RT (foo pggb rt)|PGGB-RT (foo_pggt_rt)]] Real-time implementation of Remastero's PGGB resampling algorithm implemented as foobar2000 component. Only available as 64-bit component.
* [[Foobar2000:Components/Vital_Bookmarks_(foo_vbookmark)|Vital Bookmarks (foo_vbookmark)]] · Provides playback bookmark functionality.

====Lyrics====
* [[Foobar2000:Components/ESlyric (foo_uie_eslyric)|ESlyrics (foo_uie_eslyric)]] · Alternative lyric show component.
* [[Foobar2000:Components/Lyrics Show Panel 3 (foo_uie_lyrics3)|Lyrics Show Panel 3 (foo_uie_lyrics3)]] · Component which can download and display both timestamped and text only lyrics.
* [[foobar2000:Components/OpenLyrics (foo_openlyrics)|OpenLyrics (foo_openlyrics)]] · Modern replacement for Lyric Show Panel 3.

====Notifier====
* [[Foobar2000:Components/Taskbar Playback Progress Bar (foo_taskbar_playback_progress_bar)|Taskbar Playback Progress Bar (foo_taskbar_playback_progress_bar)]] · Recompile of foo_taskbar_playback_progress_bar by Alexey V. Grishin. Fixed potential divide by zero crash and added 64-bit support.

====Online database====
* [[Foobar2000:Components 0.9/Audioscrobbler (foo_audioscrobbler)|Audioscrobbler (foo_audioscrobbler)]] · Audioscrobbler will send the name of every song you play on your computer to [https://www.last.fm/ Last.fm].
* [[Foobar2000:Components/Last.fm. Playcount Sync (foo_lastfm_playcount_sync)|Last.fm. Playcount Sync (foo_lastfm_playcount_sync)]] · This component fetches [https://www.last.fm/ Last.fm] playcounts and first played/last played dates as you listen.
* [[Foobar2000:Components/Scrobble (foo_scrobble)|Scrobble (foo_scrobble)]] · This is component for scrobbling to [https://www.last.fm/ Last.fm]

====Online radio/video ====
* [[Foobar2000:Components/Youtube (foo_youtube)|Youtube (foo_youtube)]] · This component adds possibility to play Youtube, Vimeo and Dailymotion clips directly by their URL.

====Playlist tools====
* [[Foobar2000:Components/Cue Fix (foo_cue_fix)|Cue Fix (foo_cue_fix)]] · Component for foobar2000 to fix CUE/FLAC,APE,WAVE problems.
* [[Foobar2000:Components/Cuesheet_Creator_(foo_cuesheet_creator)|Cuesheet Creator(foo_cuesheet_creator)]] · Component for generating cuesheet from playlist.
* [[Foobar2000:Components/Play Next (foo_play_next)|Play Next (foo_play_next)]] · Adds the selected track to the beginning of the playback queue to be played next.
* [[Foobar2000:Components/Play Track (foo_play_track)|Play Track (foo_play_track)]] · Adds a Play Track submenu to the main Playback menu.
* [[Foobar2000:Components/Playlist Attributes (foo_playlist_attributes)|Playlist Attributes (foo_playlist_attributes)]] · This component uses allows assigning various attributes to a playlist.
* [[Foobar2000:Components/Playlist Fix (foo_playlist_fix)|Playlist Fix (foo_playlist_fix)]] · This component uses title formatting to match dead playlist items against library items and updates the playlist entries.
* [[Foobar2000:Components/Playlist_Tour_(foo_playlisttour)|Playlist Tour (foo_playlisttour)]] · Recently activated playlists prev/next history navigation.
* [[Foobar2000:Components/Random Pools (foo_random_pools)|Random Pools (foo_random_pools)]] · is component for creating random playlist entries selected and grouped by various pool definitions.
* [[Foobar2000:Components/Inactive Tracks (foo_skip)|Skip Track (foo_skip)]] · Skips tracks that are marked via a tag as inactive.

====Playback statistics====
* [[Foobar2000:Components/foo enhanced playcount|Enhanced Playback Statistics (foo_enhanced_playcount)]] · This component collects and maintains enhanced statistics for played songs.
* [[Foobar2000:Components/Statistics (foo_statistics)|Statistics (foo_statistics)]] · Collects all kind of foobar2000 statistics and prints them to console.

====Remote control====

* [[Foobar2000:Components/Beefweb Remote Control (foo_beefweb)|Beefweb Remote Control (foo_beefweb)]] · Provides web interface and REST-like API for controlling player remotely.
* [[Foobar2000:Components/HTTP Remote Control (foo_httpcontrol)|HTTP Remote Control (foo_httpcontrol)]] · is a remote control component for the foobar2000 player.

====Tagging====
* [[Foobar2000:Components/BPM Analyser (foo_bpm)|BPM Analyser (foo_bpm)]] Automatically calculate the BPM of songs. Manual BPM calculation also available.
* [[Foobar2000:Components/Discogger_(foo_discogger)|Discogger (foo_discogger)]] · Retrieve info and album art from Discogs.com database.
* [[Foobar2000:Components/External Tags (foo_external_tags)|External Tags (foo_external_tags)]] · This component adds tagging support for non-taggable file formats.
* [[Foobar2000:Components/MusicBrainz Tagger_(foo_musicbrainz)|MusicBrainz Tagger_(foo_musicbrainz)]] · Musicbrainz tagger.
* [[Foobar2000:Components/MusicBrainz64_(foo_musicbrainz64)|MusicBrainz64 (foo_musicbrainz64)]] · Musicbrainz tagger (alternative).
* [[Foobar2000:Components 1.0/TagBox component (foo_tagbox)|TagBox (foo_tagbox))]] · Tag editing UI element (no pop-up dialog needed) and standalone window.
* [[Foobar2000:Components/Tag Normalizer (foo_tag_normalizer)|Tag Normalizer (foo_tag_normalizer)]] · This component Normalizes Unicode characters in tags.

====Utilities====
* [[Foobar2000:Components/Audio MD5 (foo_audiomd5)|Audio MD5 (foo_audiomd5)]] · Component for generating and verifying MD5 checksum of audio data.
* [[Foobar2000:Components/Feature Watcher (foo_whatsnew)|Feature Watcher (foo_whatsnew)]] · This Component watches available features and reports changes.
* [[Foobar2000:Components/Recorder (foo_record)|Recorder (foo_record)]] · Record audio from selected sound card input.

===Output===
====Interfaces====
* [[Foobar2000:Components/WASAPI shared output (foo_out_wasapis)|WASAPI shared output (foo_out_wasapis)]] · Shared mode WASAPI output for Vista and newer Windows versions.
* [[Foobar2000:Components/WASAPI shared output (debug) (foo_out_wasapis_debug)|WASAPI shared output (foo_out_wasapis_debug)]] · Shared mode WASAPI output for Vista and newer Windows versions, with additional debugging capabilities.

==External links==
* {{foobar2000|http://www.foobar2000.org/components|Components Repository}}

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2024-05-08T05:02:14Z

NEMO7538: /* Special Keys */

{{fb2k}}
[[Category:Foobar2000 Legacy Default UI components|Legacy Default UI components]]
[[Category:Foobar2000 Legacy Columns UI components|Legacy Columns UI components]]
{{infobox foobar2000 component
| name = Quick Search Toolbar
| screenshot = [[Image:QuickSearch3.png|256px]]
| caption = Quick Search View
| module_name = foo_quicksearch
| developer = NEMO7538
| repository =
| released =
| released_ref =
| stable_release = 3.6
| stable_release_date = 2015-10-13
| preview_release =
| preview_release_date =
| foobar2000_minimum = 1.3
| foobar2000_maximum =
| foobar2000_ui_module = Default UI, Columns UI
| use =
| license =
}}

=General=
'''foo_quicksearch''' is derived from [https://hydrogenaud.io/index.php/topic,44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [https://hydrogenaud.io/index.php/topic,80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

In addition, Ctrl+Backspace will delete a "word" in the search box.

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist and highlight the results within the playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg highlighting the current playlist items according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.7''' [2024-05-08]
** Updated to the foobar2000 SDK 2023-09-23 with an x86_64 component build now available.
** Fixed a bug that caused the "Set focus to search results" to activate when the text hasn't changed.
** Added a handler for Ctrl+Backspace to delete a "word" in the search box
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2024-05-08T05:01:06Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:Foobar2000 Legacy Default UI components|Legacy Default UI components]]
[[Category:Foobar2000 Legacy Columns UI components|Legacy Columns UI components]]
{{infobox foobar2000 component
| name = Quick Search Toolbar
| screenshot = [[Image:QuickSearch3.png|256px]]
| caption = Quick Search View
| module_name = foo_quicksearch
| developer = NEMO7538
| repository =
| released =
| released_ref =
| stable_release = 3.6
| stable_release_date = 2015-10-13
| preview_release =
| preview_release_date =
| foobar2000_minimum = 1.3
| foobar2000_maximum =
| foobar2000_ui_module = Default UI, Columns UI
| use =
| license =
}}

=General=
'''foo_quicksearch''' is derived from [https://hydrogenaud.io/index.php/topic,44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [https://hydrogenaud.io/index.php/topic,80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist and highlight the results within the playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg highlighting the current playlist items according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.7''' [2024-05-08]
** Updated to the foobar2000 SDK 2023-09-23 with an x86_64 component build now available.
** Fixed a bug that caused the "Set focus to search results" to activate when the text hasn't changed.
** Added a handler for Ctrl+Backspace to delete a "word" in the search box
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2024-05-04T06:16:35Z

NEMO7538: /* Toolbar Menu */

{{fb2k}}
[[Category:Foobar2000 Legacy Default UI components|Legacy Default UI components]]
[[Category:Foobar2000 Legacy Columns UI components|Legacy Columns UI components]]
{{infobox foobar2000 component
| name = Quick Search Toolbar
| screenshot = [[Image:QuickSearch3.png|256px]]
| caption = Quick Search View
| module_name = foo_quicksearch
| developer = NEMO7538
| repository =
| released =
| released_ref =
| stable_release = 3.6
| stable_release_date = 2015-10-13
| preview_release =
| preview_release_date =
| foobar2000_minimum = 1.3
| foobar2000_maximum =
| foobar2000_ui_module = Default UI, Columns UI
| use =
| license =
}}

=General=
'''foo_quicksearch''' is derived from [https://hydrogenaud.io/index.php/topic,44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [https://hydrogenaud.io/index.php/topic,80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist and highlight the results within the playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg highlighting the current playlist items according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2024-05-04T06:15:10Z

NEMO7538: /* Toolbar Icon Status */

{{fb2k}}
[[Category:Foobar2000 Legacy Default UI components|Legacy Default UI components]]
[[Category:Foobar2000 Legacy Columns UI components|Legacy Columns UI components]]
{{infobox foobar2000 component
| name = Quick Search Toolbar
| screenshot = [[Image:QuickSearch3.png|256px]]
| caption = Quick Search View
| module_name = foo_quicksearch
| developer = NEMO7538
| repository =
| released =
| released_ref =
| stable_release = 3.6
| stable_release_date = 2015-10-13
| preview_release =
| preview_release_date =
| foobar2000_minimum = 1.3
| foobar2000_maximum =
| foobar2000_ui_module = Default UI, Columns UI
| use =
| license =
}}

=General=
'''foo_quicksearch''' is derived from [https://hydrogenaud.io/index.php/topic,44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [https://hydrogenaud.io/index.php/topic,80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg highlighting the current playlist items according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Playlist Organizer (foo plorg)

2015-10-13T07:43:59Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Playlist Organizer (foo plorg)]]
[[Image:Foo_plorg.png|thumb|right|480px|Playlist Organizer Main view]]

=General=
'''foo_plorg''' is a simple component that will let your organize your playlists in a treeview fashion. It is available as either a Column UI panel or an UI element for the default UI. It enables your to create folders, hierarchies and move around folders and playlists by dragging and dropping them wherever you want in the panel.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_plorg here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1).

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705 this thread] to provide feedback or report any bug.

===Requirements===
As of version 1.9.1 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Install the toolbar as an UI element (Default UI) or a column UI panel. The commands are available with a right click on the panel.
Folders and Playlists be can selected by a left click, then moved and dropped around.

=Usage=
==Basic Usage==
The component implements a treeview control, basically made of playlist and folders.
When the component is used for the first time, a "Default" folder will be created and all playlists placed in this folder.

The basic usage is to create folders (right click anywhere on the panel to access this function) and move your playlists within those newly created folders.
Folders can be nested.
Playlists and folders can be moved (e.g. Drag & Dropped) to their desired location within the hierarchy.
[[Image:Foo_plorg_vis.png|thumb|right|260px|Playlist Organizer Visual status of playlists]]
==Visual Indication for playlists==

Based on the general or customized color scheme, foo_playlist_organizer will give an indication of Selected, Active and Playing playlists, as well as the source of Drag & Drop operations.

Please note that Selected and Active playlists will be kept equal (except for instance when selecting folders) when the "Activate on single click" option is chosen.

==Windows Management==
Using foo_plorg as a standalone (popup) window may lead to losing part of your playlists organization if some changes (addition, deletion, reordering, ...) are applied with other playlist managers while the window is closed. The window startup tries to recognize such situations but it is by nature limited. It is recommended that you use it as a "permanent" panel or UI element rather.

The last known tree configuration is however memorized and will be recalled when a new panel or UI element instance is created, so that the tree can be somehow rebuilt.

=Drag & Drop=
==Basic Drag & Drop==
Basic drag & drop is triggered by selecting an item and keeping the left button presssed. A visual indication (dotted line around the item, small square below the mouse pointer) will be given that dragging has taken place.
The selected item can be moved to the desired location and a visual indication (Colored insertion mark or rectangle for folders) of the drop target. Releasing the mouse button will move the dragged item in the requested location.
===Note:===
* During a Drag & Drop operation, folders will expand after a short delay to expand their contents
* Automatic scrolling of the treeview is triggered when the mouse approaches the top or bottom of the treeview.
* Folders cannot be dropped into their childrens
* Drag & Drop can take place across foobar windows (for instance in the playlist view), and also to other applications or windows (See ''Exporting playlists or contents'' below)
* The contents of a playlist can be added to another playlist, when selected as the target of a drop operation. A '''+''' sign will appear under the mouse cursor to indicate that this mode is active. Please note that when the target playlist is locked for some reason (e.g. autoplaylists), no content can be added. A visual indication (small circle) is provided in this case below the mouse cursor.

==Exporting playlists==
Playlists selected as the source of a drag & drop operations can be exported to windows folder (or potentially other applications). Export uses the .fpl format to create playlists in the dropped location.
Playlist contents (i.e. tracks) can be exported as well but only when the Ctrl key is pressed ''at the start'' of the dragging operation, in which case the files will be copied to the target location.

==Importing playlists or content==
Similarly, foo_playlist_organizer can act as the target of a drag & drop operation initiated in other foobar windows, windows explorer or other applications. The behavior in this case is similar to the basic drag & drop and a visual indication of the target location will be given, together with an indication in the status bar that content is being imported.
===Note===
* The .fpl format is recognized as a valid source and playlists names will be preserved in this case.For other sources (e.g. other playlists formats, tracks, ...) a new playlist will be generated with some ''intelligent'' name generation based on similar fields (e.g. artist, album, genre, ...) found in the tracks being imported.

=Context Menu=
[[Image:Foo_plorg_contextmenu.png|thumb|left|240px|Playlist Organizer Context Menu]]
A context menu is available from everywhere in the treeview, from a mouse right click or using the '''Alt+Keydown''' short cut.
Options are the following :

===Activate===
Will activate the chosen playlist. Note that activation happens automatically when "Activate on single click" is chosen in the preferences page. This option is also available using the '''Enter''' key.

===Rename===
Will rename the selected playlist or folder. This option is also available using the '''F2''' key.

===Remove===
Will remove (delete) the selected playlist or folder. This option is also available using the '''Del''' key.
Note that folders cannot be removed while they still contain playlists or other folders.

===Sort===

Will sort the content of the selected folder alphabetically.

===Autoplaylist (or lock) properties===

Will give access to the properties of an autoplaylist (when selected) or whatever is provided for other playlist locks.

===Contents===

Will give access to the standard context menu, based on the content of the selected playlist.

===Options===

Enables the customization of the Treeview appearance (Playlist information to show on the right side, Framestyle and Colors).

The '''Show Playlist''' entry enables to select between Number of items, Duration, Size or Nothing.

Please note that customizable colors are limited to Text, Background, Background (selected) and Active playlist, in order to remain consistent with the standard DUI color scheme. For CUI, the Active playlist colors defaults to the custom item frame color (See CUI standard color preferences).

A "Reset" option is available to revert to the standard colors, frame style and item count.

===Preferences===

Will link to the general preferences page.

===Restore===

This entry will present the list of previously deleted playlists and enable to restore them. A menu entry ("Clear History") is available at the bottom of the list and will permanently delete the playlists. Note that the history is not remembered across session and deleted playlists will be permanently lost if foobar is closed.

===Create Playlist, Create Folder===

These options will create new playlist and folders. Note that the newly created playlist or folder will be positioned after a currently selected playlist or as the first child of a currently selected folder.

==Note==
* When activated with the the '''Alt+Keydown''' shortcut, regular shortcuts are available for each of the menu entries (underlined letter, see picture for details).

=Preferences=
[[Image:Foo_plorg_preferences.png|right|thumb|484px|Playlist Organizer Preferences]]
The preferences page is available from the preferences dialog (General->Playlist Organizer) and provides with the following options.
==Behavior==
* '''Activate on single click''' will activate (e.g. make visible on the playlist renderer) the selected playlist on a single click. Please note that when this option is selected and a playlist is activated by other means (for example the standard playlist switcher), it will be automatically selected and thus made visible as a result of the standard treeview behavior.
* '''Play on double click''' will play the next item (according to the currently selected playback order) in the selected playlist.
* '''Make playing playlist visible on activation''' will ensure that the playing playlist is visible when activated (for instance when double clicking on the status bar). This option only make sense when "Activate on single click" is unchecked.
==Nodes==
* '''Title formatting''' enables the customization of how playlists and folders are displayed in the treeview. The formatting of nodes uses foobar [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Titleformat_Reference formatting language] and the following variables are available :
**''%node_name%'' is the name of the node, either a playlist or a folder.
**''%is_folder%'' is a boolean value for use in ''$if( ...)'' expressions and is true when the node is a folder.
**''%count%'' will provide the number of children (folders or playlists) for each folder or the number of items for playlists.
**''%playlist_duration%'' will provide the duration of playlists.
**''%playlist_size%'' will provide the size of playlists (in kB, MB or GB).

The default formatting string is ''%node_name%$if(%is_folder%,' ['%count%']',)'' and will give an indication of the number of children (folders or playlists) for each folder in the tree.

Another popular string is ''%node_name%$if($and(%is_folder%,$strcmp(%count%,0)),' []')'' which will not show the children count but just provide an indication of empty folders.

=Change Log=
* '''Upcoming - tbc'''
** Fixed improper behavior during copy/paste operations by core uie mgt.
* '''V2.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V2.4''' [2011-05-05]
** Changed shared selection type as caller_playlist_manager and revisited shared selection management
* '''V2.3''' [2011-05-03]
** Fixed small cursor glitch after folder expansion
** Fixed some menu entries skipped (standard "contents" menu)during their execution
** Checked behavior for nicer "Library Viewer Selection" playlist management (with Facets)
* '''V2.2''' [2011-04-26]
** Fixed [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=753430 this bug]
* '''V2.1''' [2011-04-25]
** Re-engineering of drag&drop operations, Various bugfix
* '''V2.0''' [2011-04-23]''' Do Not use'''
** Ctrl-key is no longer needed to add tracks to a playlist and it's behavior has been merged with the standard one, depending on the mouse position.
* '''V1.9.1''' [2011-04-16]
** Recompiled with /MD run time library option.
* '''V1.9''' [2011-04-15]
** Compiled with the latest SDK [2011-03-11] & VS2010
* '''V1.8''' [2010-10-21]
** Selected playlist is now unchanged after dropping files into a playlist from external source or other panel
** Fixed Alt+F4 Key behavior
* '''V1.7''' [2010-10-19]
** Fixed Alt Key behavior
** Implemented shared selection management
* '''V1.6''' [2010-10-03]
** Provide real lock name instead of "Lock Properties"
** Fixed keyboard shortcuts not working in CUI when poo_plorg had focus
* '''V1.5''' [2010-10-01]
** New option in contexte menu to show playlist Duration and Size
** New variables in node titleformatting to show playlist Duration and Size
** Replaced %children_count% with %count% (available for playlists and folders) in node titleformatting
** Included 'Show Playlist' reset to default (item count) in Options->Reset menu
** Fixed erratic behavior of selection after a playlist is removed
* '''V1.4''' [2010-09-26]
** Simple Recompilation
* '''V1.3''' [2010-08-21]
** Fixed preferences appearing in so called "Broken Components" section (in Foobar V1.1)
** Updated to latest SDK version [2010-05-21]
* '''V1.2''' [2010-05-22]
** Fixed bug in standard context menu activation
** Removed selection of target playlist when copying content
* '''V1.1''' [2010-05-20]
** Fixed bug in playing playlist detection
** Hack to replace "Filter Results" playlist (CUI) next to "Filter Results (Playback)" playlist
* '''V1.0''' [2010-05-15]
** '''1.0.1''' Fixed minor bug in colors of active playlist not refreshed after activation when clicking on the status bar.
** Reworked Drag & drop and introduce content copy from one playlist to another (with Ctrl Key), or copy inside a playlist when Drag & Drop is from "external" source
** Introduced titleformatting script for nodes (See Preferences page)
** Memorized last known tree configuration for recall when new instance is initialized
** Eliminated flickering during single click and resize (to be confirmed on Vista/Seven)
** Implemented options to restore deleted playlists
** Fixed Reset function not working in preferences
** Forced playlist activation (after double click) when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Added indication of external drop operations in status bar
** Autonamed newly created playlists and folders
** Ensured active playlist is selected at initialization
** Fixed dialog not getting focus when using Tab key
** Reworked tree display (rectangles mgt.)
** Fixed bug in framestyle setting
** Fixed bug (with potential crash) in accented characters display
** Miscellaneous bug fixes and improvements
* '''V0.9'''
** Implemented external drag & drop support (Thanks kerpondile !)
** Fixed preferences page activated from 1st item of standard context menu
** Fixed improper colors on selection (drop highlight) rectangle
* '''V0.8'''
** '''0.8.3''' Fixed glitch in active item display. Applied theme. Introduced a new option to make playing playlist visible upon activation. Fixed background color of preferences page.
** '''0.8.2''' Fixed crash in debug mode due to resize called before window activation (OnInit).
** '''0.8.1''' CUI colors when not restored properly after unselecting custom background color
** Fixed playback continuation (after double click) happening in same playlist when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Fixed improper display of playlists or folders containing "&"
** Improved look for Vista/seven (Custom Draw for all items, No lines)
** Added visual indication of playing playlist
* '''V0.6'''
** Fixed DUI context menu not appearing in edit mode
** Neutralized selection of first playlist if clicking on an empty region
** Double click now jumps to next track when "Play on double click" option is selected
* '''V0.5'''
** Fixed unwanted column ui context menu
** Neutralized keyboard shortcuts while editing an item
** Various changes on click/double click handling
* '''V0.4'''
** Added options to hide item count (Context Menu-> Options)
** Tentatively introduced Vista / Seven style (to be confirmed)
** Implemented "Preferences" entry in context menu
** Implemented "Activate on single click" option (Preferences)
** Implemented "Play on double click" option (Preferences)
** Fix glitch with drophightlight rectangle (dotted rectangle sometimes breaks and takes on strange colors)
** Re engineered visual appearance + drag & drop operations, fixed some glitches
** Implemented minimum width/height
** Fixed active playlist not appearing at startup
** Fixed "active playlist" status/color lost after move
** Fixed glitch during window scrolling (drag& drop)
** New border drawing to integrate nicely with DUI
* '''V0.3'''
** Fixed item count not refreshing instantaneously
** Fixed double click not working outside of playlist name
* '''V0.2'''
** Link to this page from the preferences page (Help button)
** Fixed bug in managing (Enter/Delete) keys for label editing
** Make the matching (at startup) of tree content vs. actual playlists more intelligent (usefull for utilization of the popup window)
** Fixed panel appearing twice in column UI layout
* '''V0.1''' [2010-05-03]
** Initial release

=To Do=
* Check panel always made visible inside tabs
* Implement copy/paste settings across instances
* Synchronize playlist order with tree (on request and maybe automatically)
* Generate super set of contained playlists when activating a folder (maybe)
* Add capability to copy a playlist (create a new one) whith Ctrl Key (for internal drop source)
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=752994 bug]
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=734630 bug]
* Provide option to focus on target playlist after D&D (maybe)
* Provide Lockname as a variable
* Improve placement of restored playlist
* Make external dropsource return asynchronous (maybe)
* Eliminate drawing of drophighlighted item (source) on click without dragging (maybe)
* Prevent the panel from appearing in the toolbar menu (CUI)

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2015-10-13T07:42:28Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match any''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.6''' [2015-10-13]
** Recompiled with the latest SDK (2015-08-03)
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Playlist Organizer (foo plorg)

2012-11-21T20:50:25Z

NEMO7538: /* To Do */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Playlist Organizer (foo plorg)]]
[[Image:Foo_plorg.png|thumb|right|480px|Playlist Organizer Main view]]

=General=
'''foo_plorg''' is a simple component that will let your organize your playlists in a treeview fashion. It is available as either a Column UI panel or an UI element for the default UI. It enables your to create folders, hierarchies and move around folders and playlists by dragging and dropping them wherever you want in the panel.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_plorg here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1).

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705 this thread] to provide feedback or report any bug.

===Requirements===
As of version 1.9.1 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Install the toolbar as an UI element (Default UI) or a column UI panel. The commands are available with a right click on the panel.
Folders and Playlists be can selected by a left click, then moved and dropped around.

=Usage=
==Basic Usage==
The component implements a treeview control, basically made of playlist and folders.
When the component is used for the first time, a "Default" folder will be created and all playlists placed in this folder.

The basic usage is to create folders (right click anywhere on the panel to access this function) and move your playlists within those newly created folders.
Folders can be nested.
Playlists and folders can be moved (e.g. Drag & Dropped) to their desired location within the hierarchy.
[[Image:Foo_plorg_vis.png|thumb|right|260px|Playlist Organizer Visual status of playlists]]
==Visual Indication for playlists==

Based on the general or customized color scheme, foo_playlist_organizer will give an indication of Selected, Active and Playing playlists, as well as the source of Drag & Drop operations.

Please note that Selected and Active playlists will be kept equal (except for instance when selecting folders) when the "Activate on single click" option is chosen.

==Windows Management==
Using foo_plorg as a standalone (popup) window may lead to loosing part of your playlists organization if some changes (addition, deletion, reordering, ...) are applied with other playlist managers while the window is closed. The window startup tries to recognize such situations but it is by nature limited. It is recommended that you use it as a "permanent" panel or UI element rather.

The last known tree configuration is howered memorized and will be recalled when a new panel or UI element instance is created, so that the tree can be somehow rebuilt.

=Drag & Drop=
==Basic Drag & Drop==
Basic drag & drop is triggered by selecting an item and keeping the left button presssed. A visual indication (dotted line around the item, small square below the mouse pointer) will be given that dragging has taken place.
The selected item can be moved to the desired location and a visual indication (Colored insertion mark or rectangle for folders) of the drop target. Releasing the mouse button will move the dragged item in the requested location.
===Note:===
* During a Drag & Drop operation, folders will expand after a short delay to expand their contents
* Automatic scrolling of the treeview is triggered when the mouse approaches the top or bottom of the treeview.
* Folders cannot be dropped into their childrens
* Drag & Drop can take place across foobar windows (for instance in the playlist view), and also to other applications or windows (See ''Exporting playlists or contents'' below)
* The contents of a playlist can be added to another playlist, when selected as the target of a drop operation. A '''+''' sign will appear under the mouse cursor to indicate that this mode is active. Please note that when the target playlist is locked for some reason (e.g. autoplaylists), no content can be added. A visual indication (small circle) is provided in this case below the mouse cursor.

==Exporting playlists==
Playlists selected as the source of a drag & drop operations can be exported to windows folder (or potentially other applications). Export uses the .fpl format to create playlists in the dropped location.
Playlist contents (i.e. tracks) can be exported as well but only when the Ctrl key is pressed ''at the start'' of the dragging operation, in which case the files will be copied to the target location.

==Importing playlists or content==
Similarly, foo_playlist_organizer can act as the target of a drag & drop operation initiated in other foobar windows, windows explorer or other applications. The behavior in this case is similar to the basic drag & drop and a visual indication of the target location will be given, together with an indication in the status bar that content is being imported.
===Note===
* The .fpl format is recognized as a valid source and playlists names will be preserved in this case.For other sources (e.g. other playlists formats, tracks, ...) a new playlist will be generated with some ''intelligent'' name generation based on similar fields (e.g. artist, album, genre, ...) found in the tracks being imported.

=Context Menu=
[[Image:Foo_plorg_contextmenu.png|thumb|left|240px|Playlist Organizer Context Menu]]
A context menu is available from everywhere in the treeview, from a mouse right click or using the '''Alt+Keydown''' short cut.
Options are the following :

===Activate===
Will activate the chosen playlist. Note that activation happens automatically when "Activate on single click" is chosen in the preferences page. This option is also available using the '''Enter''' key.

===Rename===
Will rename the selected playlist or folder. This option is also available using the '''F2''' key.

===Remove===
Will remove (delete) the selected playlist or folder. This option is also available using the '''Del''' key.
Note that folders cannot be removed while they still contain playlists or other folders.

===Sort===

Will sort the content of the selected folder alphabetically.

===Autoplaylist (or lock) properties===

Will give access to the properties of an autoplaylist (when selected) or whatever is provided for other playlist locks.

===Contents===

Will give access to the standard context menu, based on the content of the selected playlist.

===Options===

Enables the customization of the Treeview appearance (Playlist information to show on the right side, Framestyle and Colors).

The '''Show Playlist''' entry enables to select between Number of items, Duration, Size or Nothing.

Please note that customizable colors are limited to Text, Background, Background (selected) and Active playlist, in order to remain consistent with the standard DUI color scheme. For CUI, the Active playlist colors defaults to the custom item frame color (See CUI standard color preferences).

A "Reset" option is available to revert to the standard colors, frame style and item count.

===Preferences===

Will link to the general preferences page.

===Restore===

This entry will present the list of previously deleted playlists and enable to restore them. A menu entry ("Clear History") is available at the bottom of the list and will permanently delete the playlists. Note that the history is not remembered across session and deleted playlists will be permanently lost if foobar is closed.

===Create Playlist, Create Folder===

These options will create new playlist and folders. Note that the newly created playlist or folder will be positioned after a currently selected playlist or as the first child of a currently selected folder.

==Note==
* When activated with the the '''Alt+Keydown''' shortcut, regular shortcuts are available for each of the menu entries (underlined letter, see picture for details).

=Preferences=
[[Image:Foo_plorg_preferences.png|right|thumb|484px|Playlist Organizer Preferences]]
The preferences page is available from the preferences dialog (General->Playlist Organizer) and provides with the following options.
==Behavior==
* '''Activate on single click''' will activate (e.g. make visible on the playlist renderer) the selected playlist on a single click. Please note that when this option is selected and a playlist is activated by other means (for example the standard playlist switcher), it will be automatically selected and thus made visible as a result of the standard treeview behavior.
* '''Play on double click''' will play the next item (according to the currently selected playback order) in the selected playlist.
* '''Make playing playlist visible on activation''' will ensure that the playing playlist is visible when activated (for instance when double clicking on the status bar). This option only make sense when "Activate on single click" is unchecked.
==Nodes==
* '''Title formatting''' enables the customization of how playlists and folders are displayed in the treeview. The formatting of nodes uses foobar [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Titleformat_Reference formatting language] and the following variables are available :
**''%node_name%'' is the name of the node, either a playlist or a folder.
**''%is_folder%'' is a boolean value for use in ''$if( ...)'' expressions and is true when the node is a folder.
**''%count%'' will provide the number of children (folders or playlists) for each folder or the number of items for playlists.
**''%playlist_duration%'' will provide the duration of playlists.
**''%playlist_size%'' will provide the size of playlists (in kB, MB or GB).

The default formatting string is ''%node_name%$if(%is_folder%,' ['%count%']',)'' and will give an indication of the number of children (folders or playlists) for each folder in the tree.

Another popular string is ''%node_name%$if($and(%is_folder%,$strcmp(%count%,0)),' []')'' which will not show the children count but just provide an indication of empty folders.

=Change Log=
* '''Upcoming'''
** Fixed improper behavior during copy/paste operations by core uie mgt.
* '''V2.4''' [2011-05-05]
** Changed shared selection type as caller_playlist_manager and revisited shared selection management
* '''V2.3''' [2011-05-03]
** Fixed small cursor glitch after folder expansion
** Fixed some menu entries skipped (standard "contents" menu)during their execution
** Checked behavior for nicer "Library Viewer Selection" playlist management (with Facets)
* '''V2.2''' [2011-04-26]
** Fixed [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=753430 this bug]
* '''V2.1''' [2011-04-25]
** Re-engineering of drag&drop operations, Various bugfix
* '''V2.0''' [2011-04-23]''' Do Not use'''
** Ctrl-key is no longer needed to add tracks to a playlist and it's behavior has been merged with the standard one, depending on the mouse position.
* '''V1.9.1''' [2011-04-16]
** Recompiled with /MD run time library option.
* '''V1.9''' [2011-04-15]
** Compiled with the latest SDK [2011-03-11] & VS2010
* '''V1.8''' [2010-10-21]
** Selected playlist is now unchanged after dropping files into a playlist from external source or other panel
** Fixed Alt+F4 Key behavior
* '''V1.7''' [2010-10-19]
** Fixed Alt Key behavior
** Implemented shared selection management
* '''V1.6''' [2010-10-03]
** Provide real lock name instead of "Lock Properties"
** Fixed keyboard shortcuts not working in CUI when poo_plorg had focus
* '''V1.5''' [2010-10-01]
** New option in contexte menu to show playlist Duration and Size
** New variables in node titleformatting to show playlist Duration and Size
** Replaced %children_count% with %count% (available for playlists and folders) in node titleformatting
** Included 'Show Playlist' reset to default (item count) in Options->Reset menu
** Fixed erratic behavior of selection after a playlist is removed
* '''V1.4''' [2010-09-26]
** Simple Recompilation
* '''V1.3''' [2010-08-21]
** Fixed preferences appearing in so called "Broken Components" section (in Foobar V1.1)
** Updated to latest SDK version [2010-05-21]
* '''V1.2''' [2010-05-22]
** Fixed bug in standard context menu activation
** Removed selection of target playlist when copying content
* '''V1.1''' [2010-05-20]
** Fixed bug in playing playlist detection
** Hack to replace "Filter Results" playlist (CUI) next to "Filter Results (Playback)" playlist
* '''V1.0''' [2010-05-15]
** '''1.0.1''' Fixed minor bug in colors of active playlist not refreshed after activation when clicking on the status bar.
** Reworked Drag & drop and introduce content copy from one playlist to another (with Ctrl Key), or copy inside a playlist when Drag & Drop is from "external" source
** Introduced titleformatting script for nodes (See Preferences page)
** Memorized last known tree configuration for recall when new instance is initialized
** Eliminated flickering during single click and resize (to be confirmed on Vista/Seven)
** Implemented options to restore deleted playlists
** Fixed Reset function not working in preferences
** Forced playlist activation (after double click) when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Added indication of external drop operations in status bar
** Autonamed newly created playlists and folders
** Ensured active playlist is selected at initialization
** Fixed dialog not getting focus when using Tab key
** Reworked tree display (rectangles mgt.)
** Fixed bug in framestyle setting
** Fixed bug (with potential crash) in accented characters display
** Miscellaneous bug fixes and improvements
* '''V0.9'''
** Implemented external drag & drop support (Thanks kerpondile !)
** Fixed preferences page activated from 1st item of standard context menu
** Fixed improper colors on selection (drop highlight) rectangle
* '''V0.8'''
** '''0.8.3''' Fixed glitch in active item display. Applied theme. Introduced a new option to make playing playlist visible upon activation. Fixed background color of preferences page.
** '''0.8.2''' Fixed crash in debug mode due to resize called before window activation (OnInit).
** '''0.8.1''' CUI colors when not restored properly after unselecting custom background color
** Fixed playback continuation (after double click) happening in same playlist when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Fixed improper display of playlists or folders containing "&"
** Improved look for Vista/seven (Custom Draw for all items, No lines)
** Added visual indication of playing playlist
* '''V0.6'''
** Fixed DUI context menu not appearing in edit mode
** Neutralized selection of first playlist if clicking on an empty region
** Double click now jumps to next track when "Play on double click" option is selected
* '''V0.5'''
** Fixed unwanted column ui context menu
** Neutralized keyboard shortcuts while editing an item
** Various changes on click/double click handling
* '''V0.4'''
** Added options to hide item count (Context Menu-> Options)
** Tentatively introduced Vista / Seven style (to be confirmed)
** Implemented "Preferences" entry in context menu
** Implemented "Activate on single click" option (Preferences)
** Implemented "Play on double click" option (Preferences)
** Fix glitch with drophightlight rectangle (dotted rectangle sometimes breaks and takes on strange colors)
** Re engineered visual appearance + drag & drop operations, fixed some glitches
** Implemented minimum width/height
** Fixed active playlist not appearing at startup
** Fixed "active playlist" status/color lost after move
** Fixed glitch during window scrolling (drag& drop)
** New border drawing to integrate nicely with DUI
* '''V0.3'''
** Fixed item count not refreshing instantaneously
** Fixed double click not working outside of playlist name
* '''V0.2'''
** Link to this page from the preferences page (Help button)
** Fixed bug in managing (Enter/Delete) keys for label editing
** Make the matching (at startup) of tree content vs. actual playlists more intelligent (usefull for utilization of the popup window)
** Fixed panel appearing twice in column UI layout
* '''V0.1''' [2010-05-03]
** Initial release

=To Do=
* Check panel always made visible inside tabs
* Implement copy/paste settings across instances
* Synchronize playlist order with tree (on request and maybe automatically)
* Generate super set of contained playlists when activating a folder (maybe)
* Add capability to copy a playlist (create a new one) whith Ctrl Key (for internal drop source)
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=752994 bug]
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=734630 bug]
* Provide option to focus on target playlist after D&D (maybe)
* Provide Lockname as a variable
* Improve placement of restored playlist
* Make external dropsource return asynchronous (maybe)
* Eliminate drawing of drophighlighted item (source) on click without dragging (maybe)
* Prevent the panel from appearing in the toolbar menu (CUI)

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-29T16:50:59Z

NEMO7538: /* To do */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-29T16:50:46Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.4''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height) <-- for CUI (Done for DUI)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-29T16:50:36Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.3''' [2012-10-29]
** Adjusted panel height to account for selected font (CUI)
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font (DUI)
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height) <-- for CUI (Done for DUI)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-29T06:54:59Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font
:'''Requires a restart or changes to the layout to take effect in CUI when fonts are changed'''
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height) <-- for CUI (Done for DUI)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-29T06:53:43Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font
'''Requires a restart or changes to the layout to take effect in CUI when fonts are changed'''
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height) <-- for CUI (Done for DUI)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-28T20:48:42Z

NEMO7538: /* To do */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font '''(Requires restart in CUI)'''
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height) <-- for CUI (Done for DUI)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-28T20:48:04Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.3''' [2012-10-28]
** Adjusted panel height to account for selected font '''(Requires restart in CUI)'''
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-10-13T07:51:39Z

NEMO7538: /* To do */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Fix vertical resizing issue (account for container windows height)
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2012-08-06T13:18:14Z

NEMO7538:

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using current playlist, with the "inline" option (eg restricting the current playlist content according to the search criteria)
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-06-19T16:27:25Z

NEMO7538: /* Requirements */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0. The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-06-19T16:27:12Z

NEMO7538: /* Requirements */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP '''SP3''' or higher and in .NET 3.0.The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-06-19T16:26:52Z

NEMO7538: /* Requirements */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the ''Windows Imaging Component'' which is included in Windows XP SP[b]3[/b] or higher and in .NET 3.0.The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-06-19T16:26:28Z

NEMO7538: /* Requirements */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the [i]Windows Imaging Component[/i] which is included in Windows XP SP[b]3[/b] or higher and in .NET 3.0.The WIC can also be downloaded [http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-06-19T16:26:13Z

NEMO7538: /* Requirements */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* Quicksearch utilizes the [i]Windows Imaging Component[/i] which is included in Windows XP SP[b]3[/b] or higher and in .NET 3.0.The WIC can also be downloaded
[http://www.microsoft.com/downloads/en/details.aspx?FamilyId=8E011506-6307-445B-B950-215DEF45DDD8&displaylang=en here] separately.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-29T08:35:16Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows initialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-29T08:34:56Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
** Fixed bug in text selection (only showing last 16 chars) during windows intialization
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-29T07:26:28Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [2011-05-29]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-28T13:48:10Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [Not yet released]
** Added font alignment with default font for DUI and Common (list items) for CUI
** Fixed bug in feeding history when same entry already present
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-26T15:49:39Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [Not yet released]
** Added font alignement with default font for DUI and Common (list items) for CUI
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-25T12:04:30Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.2''' [Not yet released]
** Added font alignement with default font for DUI
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-23T21:44:58Z

NEMO7538: /* Search configuration */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option. Please note that wildcards (e.g. '*' or '?') can be used in this mode.
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-23T21:40:20Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.1''' [2011-05-23]
** Fixed crash happening in rare circumstances
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T21:09:49Z

NEMO7538: /* Requirements */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T21:02:14Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T20:54:42Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [Not yet released]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T20:46:13Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [2011-05-22]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T20:40:13Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [Not yet released]
** Reworked history recall features, now overrides current search parameters
** Reworked autoplaylist client, now more robust
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T20:38:47Z

NEMO7538: /* History and Favorites */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will re-execute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history (or favorites)and will be recalled together with the search criteria, overriding current parameters

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for re-execution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [Not yet released]
** Reworked history recall features, now overrides current search parameters
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T20:37:30Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [Not yet released]
** Reworked history recall features, now overrides current search parameters
** Changed icon for search in all playlists
** Visual configuration is now saved independently for each autoplaylist client
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

File:QsIcon-AllPlaylists.png

2011-05-22T20:26:00Z

NEMO7538: uploaded a new version of "File:QsIcon-AllPlaylists.png"

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-22T20:04:57Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V3.0''' [Not yet released]
** Reworked history recall features, now overrides current search parameters
** Changed icon for search in all playlists
** Various bugs fixed
** General code restructuring
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-20T19:32:10Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-20T19:31:43Z

NEMO7538: /* Basic usage */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created ,according to the corresponding toolbar menu options or depending on the special keys used to trigger the search.

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history<
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-20T19:30:43Z

NEMO7538: /* Toolbar Icon Status */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created (according to the corresponding toolbar menu options or depending on the special keys used to trigger the search).

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon provides an indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history<
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Playlist Organizer (foo plorg)

2011-05-19T06:57:06Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Playlist Organizer (foo plorg)]]
[[Image:Foo_plorg.png|thumb|right|480px|Playlist Organizer Main view]]

=General=
'''foo_plorg''' is a simple component that will let your organize your playlists in a treeview fashion. It is available as either a Column UI panel or an UI element for the default UI. It enables your to create folders, hierarchies and move around folders and playlists by dragging and dropping them wherever you want in the panel.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_plorg here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1).

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705 this thread] to provide feedback or report any bug.

===Requirements===
As of version 1.9.1 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Install the toolbar as an UI element (Default UI) or a column UI panel. The commands are available with a right click on the panel.
Folders and Playlists be can selected by a left click, then moved and dropped around.

=Usage=
==Basic Usage==
The component implements a treeview control, basically made of playlist and folders.
When the component is used for the first time, a "Default" folder will be created and all playlists placed in this folder.

The basic usage is to create folders (right click anywhere on the panel to access this function) and move your playlists within those newly created folders.
Folders can be nested.
Playlists and folders can be moved (e.g. Drag & Dropped) to their desired location within the hierarchy.
[[Image:Foo_plorg_vis.png|thumb|right|260px|Playlist Organizer Visual status of playlists]]
==Visual Indication for playlists==

Based on the general or customized color scheme, foo_playlist_organizer will give an indication of Selected, Active and Playing playlists, as well as the source of Drag & Drop operations.

Please note that Selected and Active playlists will be kept equal (except for instance when selecting folders) when the "Activate on single click" option is chosen.

==Windows Management==
Using foo_plorg as a standalone (popup) window may lead to loosing part of your playlists organization if some changes (addition, deletion, reordering, ...) are applied with other playlist managers while the window is closed. The window startup tries to recognize such situations but it is by nature limited. It is recommended that you use it as a "permanent" panel or UI element rather.

The last known tree configuration is howered memorized and will be recalled when a new panel or UI element instance is created, so that the tree can be somehow rebuilt.

=Drag & Drop=
==Basic Drag & Drop==
Basic drag & drop is triggered by selecting an item and keeping the left button presssed. A visual indication (dotted line around the item, small square below the mouse pointer) will be given that dragging has taken place.
The selected item can be moved to the desired location and a visual indication (Colored insertion mark or rectangle for folders) of the drop target. Releasing the mouse button will move the dragged item in the requested location.
===Note:===
* During a Drag & Drop operation, folders will expand after a short delay to expand their contents
* Automatic scrolling of the treeview is triggered when the mouse approaches the top or bottom of the treeview.
* Folders cannot be dropped into their childrens
* Drag & Drop can take place across foobar windows (for instance in the playlist view), and also to other applications or windows (See ''Exporting playlists or contents'' below)
* The contents of a playlist can be added to another playlist, when selected as the target of a drop operation. A '''+''' sign will appear under the mouse cursor to indicate that this mode is active. Please note that when the target playlist is locked for some reason (e.g. autoplaylists), no content can be added. A visual indication (small circle) is provided in this case below the mouse cursor.

==Exporting playlists==
Playlists selected as the source of a drag & drop operations can be exported to windows folder (or potentially other applications). Export uses the .fpl format to create playlists in the dropped location.
Playlist contents (i.e. tracks) can be exported as well but only when the Ctrl key is pressed ''at the start'' of the dragging operation, in which case the files will be copied to the target location.

==Importing playlists or content==
Similarly, foo_playlist_organizer can act as the target of a drag & drop operation initiated in other foobar windows, windows explorer or other applications. The behavior in this case is similar to the basic drag & drop and a visual indication of the target location will be given, together with an indication in the status bar that content is being imported.
===Note===
* The .fpl format is recognized as a valid source and playlists names will be preserved in this case.For other sources (e.g. other playlists formats, tracks, ...) a new playlist will be generated with some ''intelligent'' name generation based on similar fields (e.g. artist, album, genre, ...) found in the tracks being imported.

=Context Menu=
[[Image:Foo_plorg_contextmenu.png|thumb|left|240px|Playlist Organizer Context Menu]]
A context menu is available from everywhere in the treeview, from a mouse right click or using the '''Alt+Keydown''' short cut.
Options are the following :

===Activate===
Will activate the chosen playlist. Note that activation happens automatically when "Activate on single click" is chosen in the preferences page. This option is also available using the '''Enter''' key.

===Rename===
Will rename the selected playlist or folder. This option is also available using the '''F2''' key.

===Remove===
Will remove (delete) the selected playlist or folder. This option is also available using the '''Del''' key.
Note that folders cannot be removed while they still contain playlists or other folders.

===Sort===

Will sort the content of the selected folder alphabetically.

===Autoplaylist (or lock) properties===

Will give access to the properties of an autoplaylist (when selected) or whatever is provided for other playlist locks.

===Contents===

Will give access to the standard context menu, based on the content of the selected playlist.

===Options===

Enables the customization of the Treeview appearance (Playlist information to show on the right side, Framestyle and Colors).

The '''Show Playlist''' entry enables to select between Number of items, Duration, Size or Nothing.

Please note that customizable colors are limited to Text, Background, Background (selected) and Active playlist, in order to remain consistent with the standard DUI color scheme. For CUI, the Active playlist colors defaults to the custom item frame color (See CUI standard color preferences).

A "Reset" option is available to revert to the standard colors, frame style and item count.

===Preferences===

Will link to the general preferences page.

===Restore===

This entry will present the list of previously deleted playlists and enable to restore them. A menu entry ("Clear History") is available at the bottom of the list and will permanently delete the playlists. Note that the history is not remembered across session and deleted playlists will be permanently lost if foobar is closed.

===Create Playlist, Create Folder===

These options will create new playlist and folders. Note that the newly created playlist or folder will be positioned after a currently selected playlist or as the first child of a currently selected folder.

==Note==
* When activated with the the '''Alt+Keydown''' shortcut, regular shortcuts are available for each of the menu entries (underlined letter, see picture for details).

=Preferences=
[[Image:Foo_plorg_preferences.png|right|thumb|484px|Playlist Organizer Preferences]]
The preferences page is available from the preferences dialog (General->Playlist Organizer) and provides with the following options.
==Behavior==
* '''Activate on single click''' will activate (e.g. make visible on the playlist renderer) the selected playlist on a single click. Please note that when this option is selected and a playlist is activated by other means (for example the standard playlist switcher), it will be automatically selected and thus made visible as a result of the standard treeview behavior.
* '''Play on double click''' will play the next item (according to the currently selected playback order) in the selected playlist.
* '''Make playing playlist visible on activation''' will ensure that the playing playlist is visible when activated (for instance when double clicking on the status bar). This option only make sense when "Activate on single click" is unchecked.
==Nodes==
* '''Title formatting''' enables the customization of how playlists and folders are displayed in the treeview. The formatting of nodes uses foobar [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Titleformat_Reference formatting language] and the following variables are available :
**''%node_name%'' is the name of the node, either a playlist or a folder.
**''%is_folder%'' is a boolean value for use in ''$if( ...)'' expressions and is true when the node is a folder.
**''%count%'' will provide the number of children (folders or playlists) for each folder or the number of items for playlists.
**''%playlist_duration%'' will provide the duration of playlists.
**''%playlist_size%'' will provide the size of playlists (in kB, MB or GB).

The default formatting string is ''%node_name%$if(%is_folder%,' ['%count%']',)'' and will give an indication of the number of children (folders or playlists) for each folder in the tree.

Another popular string is ''%node_name%$if($and(%is_folder%,$strcmp(%count%,0)),' []')'' which will not show the children count but just provide an indication of empty folders.

=Change Log=
* '''Upcoming'''
** Fixed improper behavior during copy/paste operations by core uie mgt.
* '''V2.4''' [2011-05-05]
** Changed shared selection type as caller_playlist_manager and revisited shared selection management
* '''V2.3''' [2011-05-03]
** Fixed small cursor glitch after folder expansion
** Fixed some menu entries skipped (standard "contents" menu)during their execution
** Checked behavior for nicer "Library Viewer Selection" playlist management (with Facets)
* '''V2.2''' [2011-04-26]
** Fixed [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=753430 this bug]
* '''V2.1''' [2011-04-25]
** Re-engineering of drag&drop operations, Various bugfix
* '''V2.0''' [2011-04-23]''' Do Not use'''
** Ctrl-key is no longer needed to add tracks to a playlist and it's behavior has been merged with the standard one, depending on the mouse position.
* '''V1.9.1''' [2011-04-16]
** Recompiled with /MD run time library option.
* '''V1.9''' [2011-04-15]
** Compiled with the latest SDK [2011-03-11] & VS2010
* '''V1.8''' [2010-10-21]
** Selected playlist is now unchanged after dropping files into a playlist from external source or other panel
** Fixed Alt+F4 Key behavior
* '''V1.7''' [2010-10-19]
** Fixed Alt Key behavior
** Implemented shared selection management
* '''V1.6''' [2010-10-03]
** Provide real lock name instead of "Lock Properties"
** Fixed keyboard shortcuts not working in CUI when poo_plorg had focus
* '''V1.5''' [2010-10-01]
** New option in contexte menu to show playlist Duration and Size
** New variables in node titleformatting to show playlist Duration and Size
** Replaced %children_count% with %count% (available for playlists and folders) in node titleformatting
** Included 'Show Playlist' reset to default (item count) in Options->Reset menu
** Fixed erratic behavior of selection after a playlist is removed
* '''V1.4''' [2010-09-26]
** Simple Recompilation
* '''V1.3''' [2010-08-21]
** Fixed preferences appearing in so called "Broken Components" section (in Foobar V1.1)
** Updated to latest SDK version [2010-05-21]
* '''V1.2''' [2010-05-22]
** Fixed bug in standard context menu activation
** Removed selection of target playlist when copying content
* '''V1.1''' [2010-05-20]
** Fixed bug in playing playlist detection
** Hack to replace "Filter Results" playlist (CUI) next to "Filter Results (Playback)" playlist
* '''V1.0''' [2010-05-15]
** '''1.0.1''' Fixed minor bug in colors of active playlist not refreshed after activation when clicking on the status bar.
** Reworked Drag & drop and introduce content copy from one playlist to another (with Ctrl Key), or copy inside a playlist when Drag & Drop is from "external" source
** Introduced titleformatting script for nodes (See Preferences page)
** Memorized last known tree configuration for recall when new instance is initialized
** Eliminated flickering during single click and resize (to be confirmed on Vista/Seven)
** Implemented options to restore deleted playlists
** Fixed Reset function not working in preferences
** Forced playlist activation (after double click) when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Added indication of external drop operations in status bar
** Autonamed newly created playlists and folders
** Ensured active playlist is selected at initialization
** Fixed dialog not getting focus when using Tab key
** Reworked tree display (rectangles mgt.)
** Fixed bug in framestyle setting
** Fixed bug (with potential crash) in accented characters display
** Miscellaneous bug fixes and improvements
* '''V0.9'''
** Implemented external drag & drop support (Thanks kerpondile !)
** Fixed preferences page activated from 1st item of standard context menu
** Fixed improper colors on selection (drop highlight) rectangle
* '''V0.8'''
** '''0.8.3''' Fixed glitch in active item display. Applied theme. Introduced a new option to make playing playlist visible upon activation. Fixed background color of preferences page.
** '''0.8.2''' Fixed crash in debug mode due to resize called before window activation (OnInit).
** '''0.8.1''' CUI colors when not restored properly after unselecting custom background color
** Fixed playback continuation (after double click) happening in same playlist when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Fixed improper display of playlists or folders containing "&"
** Improved look for Vista/seven (Custom Draw for all items, No lines)
** Added visual indication of playing playlist
* '''V0.6'''
** Fixed DUI context menu not appearing in edit mode
** Neutralized selection of first playlist if clicking on an empty region
** Double click now jumps to next track when "Play on double click" option is selected
* '''V0.5'''
** Fixed unwanted column ui context menu
** Neutralized keyboard shortcuts while editing an item
** Various changes on click/double click handling
* '''V0.4'''
** Added options to hide item count (Context Menu-> Options)
** Tentatively introduced Vista / Seven style (to be confirmed)
** Implemented "Preferences" entry in context menu
** Implemented "Activate on single click" option (Preferences)
** Implemented "Play on double click" option (Preferences)
** Fix glitch with drophightlight rectangle (dotted rectangle sometimes breaks and takes on strange colors)
** Re engineered visual appearance + drag & drop operations, fixed some glitches
** Implemented minimum width/height
** Fixed active playlist not appearing at startup
** Fixed "active playlist" status/color lost after move
** Fixed glitch during window scrolling (drag& drop)
** New border drawing to integrate nicely with DUI
* '''V0.3'''
** Fixed item count not refreshing instantaneously
** Fixed double click not working outside of playlist name
* '''V0.2'''
** Link to this page from the preferences page (Help button)
** Fixed bug in managing (Enter/Delete) keys for label editing
** Make the matching (at startup) of tree content vs. actual playlists more intelligent (usefull for utilization of the popup window)
** Fixed panel appearing twice in column UI layout
* '''V0.1''' [2010-05-03]
** Initial release

=To Do=
* Implement copy/paste settings across instances
* Synchronize playlist order with tree (on request and maybe automatically)
* Generate super set of contained playlists when activating a folder (maybe)
* Add capability to copy a playlist (create a new one) whith Ctrl Key (for internal drop source)
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=752994 bug]
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=734630 bug]
* Provide option to focus on target playlist after D&D (maybe)
* Provide Lockname as a variable
* Improve placement of restored playlist
* Make external dropsource return asynchronous (maybe)
* Eliminate drawing of drophighlighted item (source) on click without dragging (maybe)
* Prevent the panel from appearing in the toolbar menu (CUI)

Foobar2000:Components/Playlist Organizer (foo plorg)

2011-05-19T06:56:44Z

NEMO7538: /* To Do */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Playlist Organizer (foo plorg)]]
[[Image:Foo_plorg.png|thumb|right|480px|Playlist Organizer Main view]]

=General=
'''foo_plorg''' is a simple component that will let your organize your playlists in a treeview fashion. It is available as either a Column UI panel or an UI element for the default UI. It enables your to create folders, hierarchies and move around folders and playlists by dragging and dropping them wherever you want in the panel.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_plorg here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1).

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705 this thread] to provide feedback or report any bug.

===Requirements===
As of version 1.9.1 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Install the toolbar as an UI element (Default UI) or a column UI panel. The commands are available with a right click on the panel.
Folders and Playlists be can selected by a left click, then moved and dropped around.

=Usage=
==Basic Usage==
The component implements a treeview control, basically made of playlist and folders.
When the component is used for the first time, a "Default" folder will be created and all playlists placed in this folder.

The basic usage is to create folders (right click anywhere on the panel to access this function) and move your playlists within those newly created folders.
Folders can be nested.
Playlists and folders can be moved (e.g. Drag & Dropped) to their desired location within the hierarchy.
[[Image:Foo_plorg_vis.png|thumb|right|260px|Playlist Organizer Visual status of playlists]]
==Visual Indication for playlists==

Based on the general or customized color scheme, foo_playlist_organizer will give an indication of Selected, Active and Playing playlists, as well as the source of Drag & Drop operations.

Please note that Selected and Active playlists will be kept equal (except for instance when selecting folders) when the "Activate on single click" option is chosen.

==Windows Management==
Using foo_plorg as a standalone (popup) window may lead to loosing part of your playlists organization if some changes (addition, deletion, reordering, ...) are applied with other playlist managers while the window is closed. The window startup tries to recognize such situations but it is by nature limited. It is recommended that you use it as a "permanent" panel or UI element rather.

The last known tree configuration is howered memorized and will be recalled when a new panel or UI element instance is created, so that the tree can be somehow rebuilt.

=Drag & Drop=
==Basic Drag & Drop==
Basic drag & drop is triggered by selecting an item and keeping the left button presssed. A visual indication (dotted line around the item, small square below the mouse pointer) will be given that dragging has taken place.
The selected item can be moved to the desired location and a visual indication (Colored insertion mark or rectangle for folders) of the drop target. Releasing the mouse button will move the dragged item in the requested location.
===Note:===
* During a Drag & Drop operation, folders will expand after a short delay to expand their contents
* Automatic scrolling of the treeview is triggered when the mouse approaches the top or bottom of the treeview.
* Folders cannot be dropped into their childrens
* Drag & Drop can take place across foobar windows (for instance in the playlist view), and also to other applications or windows (See ''Exporting playlists or contents'' below)
* The contents of a playlist can be added to another playlist, when selected as the target of a drop operation. A '''+''' sign will appear under the mouse cursor to indicate that this mode is active. Please note that when the target playlist is locked for some reason (e.g. autoplaylists), no content can be added. A visual indication (small circle) is provided in this case below the mouse cursor.

==Exporting playlists==
Playlists selected as the source of a drag & drop operations can be exported to windows folder (or potentially other applications). Export uses the .fpl format to create playlists in the dropped location.
Playlist contents (i.e. tracks) can be exported as well but only when the Ctrl key is pressed ''at the start'' of the dragging operation, in which case the files will be copied to the target location.

==Importing playlists or content==
Similarly, foo_playlist_organizer can act as the target of a drag & drop operation initiated in other foobar windows, windows explorer or other applications. The behavior in this case is similar to the basic drag & drop and a visual indication of the target location will be given, together with an indication in the status bar that content is being imported.
===Note===
* The .fpl format is recognized as a valid source and playlists names will be preserved in this case.For other sources (e.g. other playlists formats, tracks, ...) a new playlist will be generated with some ''intelligent'' name generation based on similar fields (e.g. artist, album, genre, ...) found in the tracks being imported.

=Context Menu=
[[Image:Foo_plorg_contextmenu.png|thumb|left|240px|Playlist Organizer Context Menu]]
A context menu is available from everywhere in the treeview, from a mouse right click or using the '''Alt+Keydown''' short cut.
Options are the following :

===Activate===
Will activate the chosen playlist. Note that activation happens automatically when "Activate on single click" is chosen in the preferences page. This option is also available using the '''Enter''' key.

===Rename===
Will rename the selected playlist or folder. This option is also available using the '''F2''' key.

===Remove===
Will remove (delete) the selected playlist or folder. This option is also available using the '''Del''' key.
Note that folders cannot be removed while they still contain playlists or other folders.

===Sort===

Will sort the content of the selected folder alphabetically.

===Autoplaylist (or lock) properties===

Will give access to the properties of an autoplaylist (when selected) or whatever is provided for other playlist locks.

===Contents===

Will give access to the standard context menu, based on the content of the selected playlist.

===Options===

Enables the customization of the Treeview appearance (Playlist information to show on the right side, Framestyle and Colors).

The '''Show Playlist''' entry enables to select between Number of items, Duration, Size or Nothing.

Please note that customizable colors are limited to Text, Background, Background (selected) and Active playlist, in order to remain consistent with the standard DUI color scheme. For CUI, the Active playlist colors defaults to the custom item frame color (See CUI standard color preferences).

A "Reset" option is available to revert to the standard colors, frame style and item count.

===Preferences===

Will link to the general preferences page.

===Restore===

This entry will present the list of previously deleted playlists and enable to restore them. A menu entry ("Clear History") is available at the bottom of the list and will permanently delete the playlists. Note that the history is not remembered across session and deleted playlists will be permanently lost if foobar is closed.

===Create Playlist, Create Folder===

These options will create new playlist and folders. Note that the newly created playlist or folder will be positioned after a currently selected playlist or as the first child of a currently selected folder.

==Note==
* When activated with the the '''Alt+Keydown''' shortcut, regular shortcuts are available for each of the menu entries (underlined letter, see picture for details).

=Preferences=
[[Image:Foo_plorg_preferences.png|right|thumb|484px|Playlist Organizer Preferences]]
The preferences page is available from the preferences dialog (General->Playlist Organizer) and provides with the following options.
==Behavior==
* '''Activate on single click''' will activate (e.g. make visible on the playlist renderer) the selected playlist on a single click. Please note that when this option is selected and a playlist is activated by other means (for example the standard playlist switcher), it will be automatically selected and thus made visible as a result of the standard treeview behavior.
* '''Play on double click''' will play the next item (according to the currently selected playback order) in the selected playlist.
* '''Make playing playlist visible on activation''' will ensure that the playing playlist is visible when activated (for instance when double clicking on the status bar). This option only make sense when "Activate on single click" is unchecked.
==Nodes==
* '''Title formatting''' enables the customization of how playlists and folders are displayed in the treeview. The formatting of nodes uses foobar [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Titleformat_Reference formatting language] and the following variables are available :
**''%node_name%'' is the name of the node, either a playlist or a folder.
**''%is_folder%'' is a boolean value for use in ''$if( ...)'' expressions and is true when the node is a folder.
**''%count%'' will provide the number of children (folders or playlists) for each folder or the number of items for playlists.
**''%playlist_duration%'' will provide the duration of playlists.
**''%playlist_size%'' will provide the size of playlists (in kB, MB or GB).

The default formatting string is ''%node_name%$if(%is_folder%,' ['%count%']',)'' and will give an indication of the number of children (folders or playlists) for each folder in the tree.

Another popular string is ''%node_name%$if($and(%is_folder%,$strcmp(%count%,0)),' []')'' which will not show the children count but just provide an indication of empty folders.

=Change Log=
* '''Upcoming'''
** Fixed behavior during copy/paste operations by core uie mgt.
* '''V2.4''' [2011-05-05]
** Changed shared selection type as caller_playlist_manager and revisited shared selection management
* '''V2.3''' [2011-05-03]
** Fixed small cursor glitch after folder expansion
** Fixed some menu entries skipped (standard "contents" menu)during their execution
** Checked behavior for nicer "Library Viewer Selection" playlist management (with Facets)
* '''V2.2''' [2011-04-26]
** Fixed [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=753430 this bug]
* '''V2.1''' [2011-04-25]
** Re-engineering of drag&drop operations, Various bugfix
* '''V2.0''' [2011-04-23]''' Do Not use'''
** Ctrl-key is no longer needed to add tracks to a playlist and it's behavior has been merged with the standard one, depending on the mouse position.
* '''V1.9.1''' [2011-04-16]
** Recompiled with /MD run time library option.
* '''V1.9''' [2011-04-15]
** Compiled with the latest SDK [2011-03-11] & VS2010
* '''V1.8''' [2010-10-21]
** Selected playlist is now unchanged after dropping files into a playlist from external source or other panel
** Fixed Alt+F4 Key behavior
* '''V1.7''' [2010-10-19]
** Fixed Alt Key behavior
** Implemented shared selection management
* '''V1.6''' [2010-10-03]
** Provide real lock name instead of "Lock Properties"
** Fixed keyboard shortcuts not working in CUI when poo_plorg had focus
* '''V1.5''' [2010-10-01]
** New option in contexte menu to show playlist Duration and Size
** New variables in node titleformatting to show playlist Duration and Size
** Replaced %children_count% with %count% (available for playlists and folders) in node titleformatting
** Included 'Show Playlist' reset to default (item count) in Options->Reset menu
** Fixed erratic behavior of selection after a playlist is removed
* '''V1.4''' [2010-09-26]
** Simple Recompilation
* '''V1.3''' [2010-08-21]
** Fixed preferences appearing in so called "Broken Components" section (in Foobar V1.1)
** Updated to latest SDK version [2010-05-21]
* '''V1.2''' [2010-05-22]
** Fixed bug in standard context menu activation
** Removed selection of target playlist when copying content
* '''V1.1''' [2010-05-20]
** Fixed bug in playing playlist detection
** Hack to replace "Filter Results" playlist (CUI) next to "Filter Results (Playback)" playlist
* '''V1.0''' [2010-05-15]
** '''1.0.1''' Fixed minor bug in colors of active playlist not refreshed after activation when clicking on the status bar.
** Reworked Drag & drop and introduce content copy from one playlist to another (with Ctrl Key), or copy inside a playlist when Drag & Drop is from "external" source
** Introduced titleformatting script for nodes (See Preferences page)
** Memorized last known tree configuration for recall when new instance is initialized
** Eliminated flickering during single click and resize (to be confirmed on Vista/Seven)
** Implemented options to restore deleted playlists
** Fixed Reset function not working in preferences
** Forced playlist activation (after double click) when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Added indication of external drop operations in status bar
** Autonamed newly created playlists and folders
** Ensured active playlist is selected at initialization
** Fixed dialog not getting focus when using Tab key
** Reworked tree display (rectangles mgt.)
** Fixed bug in framestyle setting
** Fixed bug (with potential crash) in accented characters display
** Miscellaneous bug fixes and improvements
* '''V0.9'''
** Implemented external drag & drop support (Thanks kerpondile !)
** Fixed preferences page activated from 1st item of standard context menu
** Fixed improper colors on selection (drop highlight) rectangle
* '''V0.8'''
** '''0.8.3''' Fixed glitch in active item display. Applied theme. Introduced a new option to make playing playlist visible upon activation. Fixed background color of preferences page.
** '''0.8.2''' Fixed crash in debug mode due to resize called before window activation (OnInit).
** '''0.8.1''' CUI colors when not restored properly after unselecting custom background color
** Fixed playback continuation (after double click) happening in same playlist when "Play on double click" option is selected and "Playback follow cursor" is not selected
** Fixed improper display of playlists or folders containing "&"
** Improved look for Vista/seven (Custom Draw for all items, No lines)
** Added visual indication of playing playlist
* '''V0.6'''
** Fixed DUI context menu not appearing in edit mode
** Neutralized selection of first playlist if clicking on an empty region
** Double click now jumps to next track when "Play on double click" option is selected
* '''V0.5'''
** Fixed unwanted column ui context menu
** Neutralized keyboard shortcuts while editing an item
** Various changes on click/double click handling
* '''V0.4'''
** Added options to hide item count (Context Menu-> Options)
** Tentatively introduced Vista / Seven style (to be confirmed)
** Implemented "Preferences" entry in context menu
** Implemented "Activate on single click" option (Preferences)
** Implemented "Play on double click" option (Preferences)
** Fix glitch with drophightlight rectangle (dotted rectangle sometimes breaks and takes on strange colors)
** Re engineered visual appearance + drag & drop operations, fixed some glitches
** Implemented minimum width/height
** Fixed active playlist not appearing at startup
** Fixed "active playlist" status/color lost after move
** Fixed glitch during window scrolling (drag& drop)
** New border drawing to integrate nicely with DUI
* '''V0.3'''
** Fixed item count not refreshing instantaneously
** Fixed double click not working outside of playlist name
* '''V0.2'''
** Link to this page from the preferences page (Help button)
** Fixed bug in managing (Enter/Delete) keys for label editing
** Make the matching (at startup) of tree content vs. actual playlists more intelligent (usefull for utilization of the popup window)
** Fixed panel appearing twice in column UI layout
* '''V0.1''' [2010-05-03]
** Initial release

=To Do=
* Implement copy/paste settings across instances
* Synchronize playlist order with tree (on request and maybe automatically)
* Generate super set of contained playlists when activating a folder (maybe)
* Add capability to copy a playlist (create a new one) whith Ctrl Key (for internal drop source)
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=752994 bug]
* check this [http://www.hydrogenaudio.org/forums/index.php?showtopic=80705&view=findpost&p=734630 bug]
* Provide option to focus on target playlist after D&D (maybe)
* Provide Lockname as a variable
* Improve placement of restored playlist
* Make external dropsource return asynchronous (maybe)
* Eliminate drawing of drophighlighted item (source) on click without dragging (maybe)
* Prevent the panel from appearing in the toolbar menu (CUI)

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-18T22:33:51Z

NEMO7538: /* To do */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created (according to the corresponding toolbar menu options or depending on the special keys used to trigger the search).

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon gives and indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history<
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-18T22:33:22Z

NEMO7538: /* Change Log */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created (according to the corresponding toolbar menu options or depending on the special keys used to trigger the search).

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon gives and indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.14''' [2011-05-19]
** Implemented auto-complete in search pattern based on the content of history<
** Various bugs fixed
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Implement history dropdown
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-18T22:14:39Z

NEMO7538: /* Preferences */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created (according to the corresponding toolbar menu options or depending on the special keys used to trigger the search).

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon gives and indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the search history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Implement history dropdown
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields

Foobar2000:Components/Quick Search Toolbar (foo quicksearch)

2011-05-18T22:14:07Z

NEMO7538: /* Search ... */

{{fb2k}}
[[Category:foobar2000 3rd-Party Components|Quicksearch UI Element (foo quicksearch)]]
[[Image:QuickSearch3.png|thumb|right|405px|Quick Search]]
=General=
'''foo_quicksearch''' is derived from [http://www.hydrogenaudio.org/forums/index.php?showtopic=44012 foo_uie_quicksearch] and ported to foobar2000 V1.0.x. It is now available as either a Column UI panel or an UI element for the default UI. The version has been rewritten (almost) from scratch to benefit from the new SDK and introduce new features such as autoplaylist generation, full customization of the context menu, ....

Configuration has also been simplified with separation of general and toolbar customization, and performances have been improved thanks to new features in the SDK.

===Download link===
The component is available from [http://www.foobar2000.org/components/view/foo_quicksearch here]. Download an place in your foobar components directory (or use the automatic updater with foobar V1.1)

===Discussion===
Please use [http://www.hydrogenaudio.org/forums/index.php?showtopic=80259 this thread] to provide feedback or report any bug.

===Requirements===
As of version 2.4 [2011-04-16]:
* Foobar 1.1 (or newer) is required and Column UI 0.3.8.x (Optional). The component will not work with previous versions of Foobar.
* [[http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c32f406a-f8fc-4164-b6eb-5328b8578f03 Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system Microsoft Visual C++ 2010 Redistributable Package] may also be needed if not already present on your system

===Getting started===
Although the toolbar is highly configurable, the recommended scenario is to just install the toolbar as an UI element (Default UI) or a column UI panel, then type a string and press the enter key to visualize the results. A popup instance of the toolbar can also be activated from the main Menu (Library->Quicksearch).

If you are using column UI, it is recommended that your remove 'foo_uie_quicksearch' from your components directory.

=Usage=

===Basic usage===
A search is triggered by the enter key, using the string typed in the toolbar as the basic criteria.

The target playlist (as set in the Preferences page) will be fed with the results of the search ... or a new playlist (or autoplaylist) will be created (according to the corresponding toolbar menu options or depending on the special keys used to trigger the search).

The toolbar is highlighted when the search is not successful.

===Special Keys===
Pressing "Crtl", "Alt" or "Shift" keys (together with the enter key) will trigger the following processings, regardless of the search parameters that are currently selected :
* Ctrl: Force the creation of a new results playlist
* Ctrl+Shift: Force the creation of a new (results) autoplaylist
* Alt: Force search in the current playlist
* Alt+Shift: Force search in all playlist(except the last search results)
* Shift: Force inline playlist search
* Ctrl+Alt: Force the creation of a new results playlist and use the current playlist as the search source
* Ctrl+Alt+Shift: Force the creation of a new results playlist and use all playlists (except the last search results) as the search source

===About playlists created with the toolbar===
You can do whatever you want with the playlists that are created when the "New Playlist" or "New Autoplaylist" options are checked in the toolbar menu, except for the restrictions that apply to autoplaylists.

The "standard" results playlist behaves slightly differently. You can add or remove items or even delete it (it will be recreated automatically). As its contents is controlled by the toolbar,it cannot be renamed in order to avoid the situation where it would have been renamed and its contents changed by the next search.

===Main menu entry===
A menu entry (Library-->Quicksearch) is available to launch the toolbar in standalone pop-up mode, when the toolbar is not already available (DUI). This entry can be mapped to a keyboard shortcut.
===Main keyboard shortcuts===
Three additional entries are available to be mapped as (main) keyboard shortcuts :
* '''Activate toolbar''' will set focus to the toolbar
* '''Create playlist from last search''' will re execute the last search and create a new playlist
* '''Create autoplaylist from last search''' will re execute the last search and create a new autoplaylist. If the last search was not from the media library, a simple playlist is created instead.

Note that generated autoplaylists can later be edited to change their content and underlying query (See [[Foobar2000:Components/Quicksearch_UI_Element_(foo_quicksearch)#Autoplaylist_Client|Autoplaylist Client]] below).

===Context menu===
[[Image:QsContextMenu.png|thumb|right|405px|Quicksearch Context Menu]]

A context menu is available from the playlist view (Search for same) and will list some tags to be used in order to search in the media library for similar entries.

The content of the context menu is now fully customizable. Please refer to the "Tagz strings" area of the preferences page for details.

These context menu entries can be mapped to keyboard shortcuts.

Please note that the context menu is not available (and grayed) when several entries are selected in the playlist view.

=Configuration=
==Toolbar Menu==
A toolbar menu is available by (left) clicking on the toolbar icon and provides with the ability to customize search parameters or the look of the toolbar. Options are divided into sections which are described below :
[[Image:QsToolbarMenu.PNG|thumb|left|405px|Quicksearch Toolbar Menu]]
===Search configuration===
'''Search in :'''

Indicates where to search :
* '''Database''' Will search in the media library
* '''Playlist''' will search in the currently selected playlist
* '''Playlist (inline) ''' will search in the currently selected playlist but will highlight the results in the currently selected playlist. If "Set Focus to search results" is not selected in the preferences page, navigation in the selected results is available through the "Up" and "Down" arrow keys.
* '''All Playlists ''' will search in the contents of all playlist. Please note that the playlist containing the previous search results will be skipped when searching in all playlists.

'''Tags'''

Provides with the ability to select in which tags the search will be performed. The contents of this option is customizable in the general preferences page (See "Tagz strings" section).

'''Match :'''

Determines what kind of processing will be performed to produce the results, in particular when several keywords are typed :
* '''Match all''' will select tracks if all keywords are found in the tags determined by the "Search in ..." option
* '''Match all''' will select tracks if one of the keywords is found in the tags determined by the "Search ins" option
* '''Exact''' will select tracks if the typed string exactly matches the contents of the tags determined by the "Search in ..." option
* '''Prefix''' will select tracks if when the contents of the tags determined by the "Search in ..." option are starting with the typed string
* '''Extended''' will use the foobar query syntax. Look [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000:Query_syntax here] for further details.

'''Autosearch'''

Enables automatic searching. The toolbar will automatically (e.g. without the need to press the enter key) trigger a search when this option is selected. The launch of the search is control by a delay that can be tuned in the general Preferences page.
Autosearch is mutually exclusive with "New playlist" and "New autoplaylist" options.

Please note that the autosearch is not triggered when the searched string has only one character.

===Results Playlist Management===
These options are mutually exclusive with "Autosearch ..." option. Thee are not available as well for autoplaylist clients.

'''New Playlist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page. Please note this option is deactivated when "Playlist (inline)" is selected as the source.

'''New Autoplaylist'''

Will generate a new playlist instead of sending the results to the "Target Playlist" indicated in the preferences page, and set up this new playlist as an autopaylist, using the transformed search criteria. Please note this option is deactivated when anything else than "Database" is selected as the source and is mutually exclusive with the "New Playlist" option.

===History and Favorites===

'''History'''

This menu entry provides with the list of recent queries. Selecting one of them will reexecute the corresponding search. A visual indication of the source of each search appears in history (From DB=Noting, Playlist=[P], All Playlist=[A], Inline=[I]) after the searched pattern.

Please note that parameters (Search in ..., Tags ..., Match ...) are saved within the history and will be recalled together with the search criteria.

An option ("Clear") is provided to clear the history below the list.

'''Favorites'''

The search history can be used to flag some entries as favorites. The menu entry provides options :
* to add history items to favorites
* to delete favorites
* to recall one of the favorites searches for reexecution

===Options and Preferences===

'''Options'''

This option enable to customize the look of the toolbar, including :
* Loading a custom bitmap (Must be 2 x 16x20, e.g. hight=16, width=40 with the second part used as the mouseover image. The top left pixel of each part will be used as the transparent color). Selecting this option when a custombitmap is loaded will revert to the standard image.
* Customizing the frame style (None Grey, Sunken).
* Customizing the colors. Default toolbar colors are those set in DUI or CUI preferences, and a custom color can be set for each category (Text and Background ... for normal and errors state). When customized, these options will revert to the default colors if selected.

'''Options->Reset configuration'''

This option will revert to the default toolbar configuration, for all the toolbar menu options.

'''Preferences'''

Will give access to the general preferences.

===Notes===
* "New playlist" and "New autoplaylist" options are not compatible with "Inline playlist search" and will be deactivated accordingly.
* "New autoplaylist" cannot be used when searching from an other source than the media library and will be deactivated accordingly.
* You are not allowed to rename the results playlist. It is automatically managed by the plugin.
* Sorting (Foobar Query syntax) is not currently supported.

==Toolbar Icon Status==
The toolbar icon gives and indication of currently selected options and can take the following appearance :
* [[File:QsIcon-Normal.png]] Standard search in Media Library
* [[File:QsIcon-Autosearch.png]] Autosearch (e.g. search as you type)
* [[File:QsIcon-NewPlaylist.png]] A new playlist will be created
* [[File:QsIcon-NewAutoPlaylist.png]] A new autoplaylist will be created

* [[File:QsIcon-InPlaylist.png]] Search will take place in the current playlist
* [[File:QsIcon-Error.png]] Autosearch takes place in the current playlist, but there is no active selection. Selecting a playlist different from the search results playlist and reactivating the toolbar will revert to normal search in playlist
* [[File:QsIcon-PlaylistInline.png]] Search will take place using all playlists
* [[File:QsIcon-AllPlaylists.png]] Search will take place using all playlists

Please note that the corresponding situations may be combined in a single icon to reflect the actual selected search parameters.

==Preferences==
The general configuration is available from the Preferences menu (under Media Library/Quicksearch) or by selecting "Preferences" from the toolbar Menu.

Note that the general configuration is now consistent with the standard foobar behavior for preference pages (OK, Cancel and Apply buttons). Changes (including any change made in the Tagz list) are '''not''' taken into account until the OK or Apply buttons are hit.
[[Image:QsPreferences.png‎|thumb|right|600px|Quick Search Preferences Page]]
Options are divided into sections as follows :
===Search ...===
'''Reset searchstring when successfull'''

Will blank the string you have typed after a successfull search.

'''Reset "New Playlist" after execution'''

Will unselect "New Playlist" or "New Autoplaylist" after execution.

'''Remove parenthesis from search tags (context menu)'''

Will automatically remove parenthesis found in tags from the selected track before building the query. Can be usefull to search more globally (e.g. excluding "(Disc 1 ... n)" from the search criteria).

'''Automatic switch to extended search'''

Will automatically force the "Match ..." option in the toolbar to "Extended" when a "%" character is typed in the toolbar. Enables easier usage of extended queries.
The "Match ..." option will revert to its previous value if only normal characters are present or if the typing area is cleared.

'''Autosearch delay'''

Enables to fine tune the delay which triggers the search when the "Autosearch" option is selected in the toolbar. It is recommended that you set this option to "Slow" if your system is Slow or if you have a large library.

'''Autocomplete from history'''

Enable the appearance of a drop-down list while typing a search string, in order to select the string among previous searches, based on the content of the history.

===Tagz strings===
Enables the customization of strings to look for during a search. The list can be manipulated using the "Add", "Change", "Delete", "Reset", "Up" and "Down" buttons and the fields below the list :
* '''Name''' is the human readable index of the list and will appear in the "Tagz strings ..." menu of the toolbar and in the context menu options
* '''Value''' contains the Tagz language strings used for the search
* '''Context Menu''' will enable the entry in the context menu and keyboard shortcuts mapping.
'''Please note :'''
* The status of the "Add", "Change" and "Delete" buttons is managed to avoid duplicates in the list. Rules are the following :
** You cannot have the same value with two different name
** You cannot have several entries with the same name
* For the strings to appear in Keyboards shortcuts preferences, the "OK" button needs to be hit in Quicksearch Preferences page before moving to the keyboard shortcuts preference pages.

===Search Results===
'''Target Playlist'''

Indicates the name of the playlist that will be fed with the search results.

'''Target Playlist (New)'''

Indicates the name of the playlist that will be fed with the search results when generating a new playlist or a new autoplaylist.

'''Append searchstring to playlist name'''

When selected, the string used for the search will be appended (between brackets) to the playlist name.

'''Set focus to search results'''

Will set the focus to the main foobar window after a successful search. Please note that this option is irrelevant when Autosearch is activated.

'''History size'''

Indicates the desired length for the search history. Setting this parameter to zero will clear the search history.

'''Manage Favorites'''

Indicates whether the management of favorites is desired.

==Autoplaylist Client==
[[File:PlContextMenu.png|thumb|right|450px|Playlist Context Menu]]
Autoplaylists created with foo_quicksearch can be edited from the context menu (right click) of the playlist manager.

Activating this entry will pop-up a new instance of the quicksearch toolbar, in order to modify the search parameters. Results are directly fed into the selected playlist.

Please note that autoplaylists can only lookup in foobar's media library (and not playlists). Some options in the toolbar menu of autoplaylist clients are grayed out accordingly.

The "New playlist" and "New Autoplaylist" entries are not available in this context, as the results will only be updated in the selected autoplaylist.

=Change Log=
* '''V2.13''' [2011-05-16]
** Fixed improper display of dynamic icon, now using 32bpp
* '''V2.12''' [2011-05-16]
** Fixed GDI leak
* '''V2.11''' [2011-05-15]
** Restored custom bitmap option
** Modified menu style (use bullet for alternative selection)
* '''V2.10''' [2011-05-15]
** Use png icons for better visual effet [(c) Yusuke Kamiyamane]
** Fixed some bugs in autosearch + "in playlist" filer mode
* '''V2.9''' [2011-05-14]
** Reviewed history management in case of recall to acccount for forced parameters
** Provided visual indication of source in history (From DB=Noting, Playlist=[P], All Playlist=[A],Inline=[I]
** Complete Rework of autosearch (as you type ...) from within a playlist with quicksearch toolbar now acting as a filter to the current playlist
** Dynamic icon to provide visual feedback of selected options
* '''V2.8''' [2011-05-11]
** Invalidated Shift and Alt key in autoplaylist clients
** Fixed bug :Alt+Enter, Alt+Shift+Enter not working (since V2.3)
* '''V2.7''' [2011-05-10]
** Fixed behavior during copy/paste operations by core uie mgt.
** Implemented autoplaylist client (to easily edit previously generated autoplaylist)
** Various bugs fixed and code reorganized
** Implemented Quicksearch as a referenced media library viewer (Prefs pages->Media Library)
** Automatic refresh when in Autosearch mode when search criterias (e.g. Search in ..., Tags ..., Match ...) are changed
* '''V2.6''' [2011-05-05]
** Integrated Quicksearch in media library preferences page
** Implemented "bump" on activation request (From media library preferences page OR "Quicksearch" playlist lock OR menu command: activate toolbar)
* '''V2.5''' [2011-04-29]
** Removed default selection of first item after a search
* '''V2.4''' [2011-04-16]
** Compiled with the latest SDK [2011-03-11] & VS2010
** Fixed Alt+F4 Key behavior
* '''V2.3''' [2010-10-19]
** Fixed Alt Key behavior
* '''V2.2''' [2010-10-07]
** Reworked context menu management
** Branch to toolbar instead of preferences when invoking show_ui() from playlist lock in playlist managers
** Fixed GDI leak
* '''V2.1''' [2010-09-26]
** Reworked the removal of leading/trailing blanks in "search for same ..." query string when parenthesis removal is active (suspected crash)
* '''V2.0''' [2010-09-02]
** Eliminated leading/trailing blanks in "search for same ..." pattern when parenthesis removal is active
** Updated to latest SDK version [2010-05-21]
* '''V1.9''' [2010-05-14]
** Eliminated flickering
* '''V1.8'''
** Augmented max history and favorites size
** Fixed background color of preferences page
* '''V1.7'''
** ''V1.7.1 Quickfix'' : Removed setting the search results playlist as the playing playlist
** Invalidated "Tags ..." in toolbar Menu when "Extended" is selected
** Fixed small glitch in preferences display
** Fixed ''DURING LAST'' queries not working properly
* '''V1.6'''
** Fixed improper management of favorites
* '''V1.5'''
** Various minor bugfix in toolbar menus and playlist generation
** Revisited keyboard shortcut recalls to generate new playlist (instead of simply recalling the last search) and added autoplaylist option
* '''V1.4'''
** New keyboard shortcut to recall last search
** Separate field for target "new" playlist name (Preferences)
** Various labels changed in toolbar menu
** Permanent alignment of playlist name with preferences
** (Internal) re engineering of the playlist lock management (now in Init section)
* '''V1.3'''
** Results Playlist can be removed
** Implemented max favorites size (32)
* '''V1.2'''
** Implemented a new keyboard shortcut to focus on the toolbar
** Implemented a minmax size option for CUI
* '''V1.1'''
** CUI: Now available as a toolbar, not only a panel
** Renamed menu entries to "Quicksearch ..."
** Fixed (tbc) context menu option label glitch
** Invalidated "Set focus to search results" when Autosearch is active
** Updated help page address
* '''V1.0'''
** Initial version

=To do=
* Implement history dropdown
* Feed the shared selection instead of target playlist (maybe)
* Implement (playing) backup playlist and related switches
* Check "Set focus to search results" (improve focus mgt to focus on playlist manager, through service_enum ??)
* Add an option to play the results after a search
* Think about multi valued fields