0a0552467374bbaf8ffa1c6879a54b9b3abb4f0c
[ncmpc-debian.git] / src / wreadln.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 WREADLN_H
21 #define WREADLN_H
22
23 #include "config.h"
24 #include "History.hxx"
25 #include "ncmpc_curses.h"
26
27 #include <string>
28
29 class Completion;
30
31 /* Note, wreadln calls curs_set() and noecho(), to enable cursor and
32  * disable echo. wreadln will not restore these settings when exiting! */
33 std::string
34 wreadln(WINDOW *w,            /* the curses window to use */
35         const char *prompt, /* the prompt string or nullptr */
36         const char *initial_value, /* initial value or nullptr for a empty line
37                                     * (char *) -1 = get value from history */
38         unsigned x1,              /* the maximum x position or 0 */
39         History *history, /* a pointer to a history list or nullptr */
40         Completion *completion    /* a GCompletion structure or nullptr */
41         );
42
43 std::string
44 wreadln_masked(WINDOW *w,
45                const char *prompt,
46                const char *initial_value,
47                unsigned x1);
48
49 #endif