ListWindow: convert list_window_callback_fn_t to an abstract class
[ncmpc-debian.git] / src / screen_find.hxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2018 The Music Player Daemon Project
3  * Project homepage: http://musicpd.org
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19
20 #ifndef NCMPC_SCREEN_FIND_H
21 #define NCMPC_SCREEN_FIND_H
22
23 #include "command.hxx"
24
25 class ScreenManager;
26 class ListWindow;
27 class ListRenderer;
28 class ListText;
29
30 /**
31  * query user for a string and find it in a list window
32  *
33  * @param lw the list window to search
34  * @param findcmd the search command/mode
35  * @param callback_fn a function returning the text of a given line
36  * @param callback_data a pointer passed to callback_fn
37  * @return true if the command has been handled, false if not
38  */
39 bool
40 screen_find(ScreenManager &screen, ListWindow *lw,
41             command_t findcmd,
42             const ListText &text);
43
44 /* query user for a string and jump to the entry
45  * which begins with this string while the users types */
46 void
47 screen_jump(ScreenManager &screen, ListWindow *lw,
48             const ListText &text, const ListRenderer &renderer);
49
50 #endif