README: convert to reStructuredText
[ncmpc.git] / src / screen.h
blob8a91d46279254a7205a16af18d899196de787d2e
1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2017 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
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.
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.
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.
20 #ifndef SCREEN_H
21 #define SCREEN_H
23 #include "config.h"
24 #include "command.h"
25 #include "window.h"
26 #include "title_bar.h"
27 #include "progress_bar.h"
28 #include "status_bar.h"
29 #include "ncmpc_curses.h"
31 #include <mpd/client.h>
33 #include <glib.h>
35 #include <stdbool.h>
37 struct mpdclient;
38 struct screen_functions;
40 struct screen {
41 struct title_bar title_bar;
42 struct window main_window;
43 struct progress_bar progress_bar;
44 struct status_bar status_bar;
46 const struct screen_functions *current_page;
48 char *buf;
49 size_t buf_size;
51 char *findbuf;
52 GList *find_history;
54 #ifndef NCMPC_MINI
55 /**
56 * Non-zero when the welcome message is currently being
57 * displayed. The associated timer will disable it.
59 guint welcome_source_id;
60 #endif
63 extern struct screen screen;
65 void screen_init(struct mpdclient *c);
66 void screen_exit(void);
67 void screen_resize(struct mpdclient *c);
69 void
70 paint_top_window(const struct mpdclient *c);
72 void
73 screen_paint(struct mpdclient *c, bool main_dirty);
75 void screen_update(struct mpdclient *c);
76 void screen_cmd(struct mpdclient *c, command_t cmd);
78 void
79 screen_switch(const struct screen_functions *sf, struct mpdclient *c);
80 void
81 screen_swap(struct mpdclient *c, const struct mpd_song *song);
83 static inline bool
84 screen_is_visible(const struct screen_functions *sf)
86 return sf == screen.current_page;
89 int
90 screen_get_mouse_event(struct mpdclient *c, unsigned long *bstate, int *row);
92 #endif