Updated changelog
[ncmpc-debian.git] / src / hscroll.hxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2020 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 HSCROLL_H
21 #define HSCROLL_H
22
23 #include "BasicMarquee.hxx"
24 #include "event/TimerEvent.hxx"
25
26 #include <curses.h>
27
28 enum class Style : unsigned;
29
30 /**
31  * This class is used to auto-scroll text which does not fit on the
32  * screen.  Call hscroll_init() to initialize the object,
33  * hscroll_clear() to free resources, and hscroll_set() to begin
34  * scrolling.
35  */
36 class hscroll {
37         WINDOW *const w;
38
39         BasicMarquee basic;
40
41         /**
42          * The postion on the screen.
43          */
44         unsigned x, y;
45
46         /**
47          * Style for drawing the text.
48          */
49         Style style;
50
51         attr_t attr;
52
53         /**
54          * A timer which updates the scrolled area every second.
55          */
56         TimerEvent timer;
57
58 public:
59         hscroll(EventLoop &event_loop,
60                 WINDOW *_w, const char *_separator) noexcept
61                 :w(_w), basic(_separator),
62                  timer(event_loop, BIND_THIS_METHOD(OnTimer))
63         {
64         }
65
66         bool IsDefined() const noexcept {
67                 return basic.IsDefined();
68         }
69
70         /**
71          * Sets a text to scroll.  This installs a timer which redraws
72          * every second with the current window attributes.  Call
73          * hscroll_clear() to disable it.
74          */
75         void Set(unsigned x, unsigned y, unsigned width, const char *text,
76                  Style style, attr_t attr=0) noexcept;
77
78         /**
79          * Removes the text and the timer.  It may be reused with
80          * Set().
81          */
82         void Clear() noexcept;
83
84         void Rewind() noexcept {
85                 basic.Rewind();
86         }
87
88         void Step() noexcept {
89                 basic.Step();
90         }
91
92         /**
93          * Explicitly draws the scrolled text.  Calling this function
94          * is only allowed if there is a text currently.
95          */
96         void Paint() const noexcept;
97
98 private:
99         void OnTimer() noexcept;
100
101         void ScheduleTimer() noexcept {
102                 timer.Schedule(std::chrono::seconds(1));
103         }
104 };
105
106 #endif