plugin: convert plugin_fd_add() to method
[ncmpc-debian.git] / src / wreadln.hxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2019 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 "History.hxx"
24
25 #include <curses.h>
26
27 #include <string>
28
29 class Completion;
30
31 /**
32  *
33  * This function calls curs_set(1), to enable cursor.  It will not
34  * restore this settings when exiting.
35  *
36  * @param the curses window to use
37  * @param initial_value initial value or nullptr for a empty line;
38  * (char *) -1 = get value from history
39  * @param x1 the maximum x position or 0
40  * @param history a pointer to a history list or nullptr
41  * @param a #Completion instance or nullptr
42  */
43 std::string
44 wreadln(WINDOW *w,
45         const char *initial_value,
46         unsigned x1,
47         History *history,
48         Completion *completion) noexcept;
49
50 std::string
51 wreadln_masked(WINDOW *w,
52                const char *initial_value,
53                unsigned x1) noexcept;
54
55 #endif