update copyright year to 2018
[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 #include "list_window.hxx"
25
26 /**
27  * query user for a string and find it in a list window
28  *
29  * @param lw the list window to search
30  * @param findcmd the search command/mode
31  * @param callback_fn a function returning the text of a given line
32  * @param callback_data a pointer passed to callback_fn
33  * @return true if the command has been handled, false if not
34  */
35 bool
36 screen_find(struct list_window *lw,
37             command_t findcmd,
38             list_window_callback_fn_t callback_fn,
39             void *callback_data);
40
41 /* query user for a string and jump to the entry
42  * which begins with this string while the users types */
43 void
44 screen_jump(struct list_window *lw,
45             list_window_callback_fn_t callback_fn, void *callback_data,
46             list_window_paint_callback_t paint_callback, void *paint_data);
47
48 #endif