include "config.h" in all files using HAVE_* defines

[ncmpc.git] / src / hscroll.h

diff --git a/src/hscroll.h b/src/hscroll.h
index d266c8a335d8b50e46a424ad5d8f97c0196e2eaa..6d32b84b0b14aa16516628b9e1c7b664456a2fdb 100644 (file)
--- a/src/hscroll.h
+++ b/src/hscroll.h
@@ -20,10 +20,57 @@
 #ifndef HSCROLL_H
 #define HSCROLL_H
 
+#include "config.h"
+
 #include <glib.h>
 
+#ifdef HAVE_NCURSESW_NCURSES_H
+#include <ncursesw/ncurses.h>
+#else
+#include <ncurses.h>
+#endif
+
+/**
+ * This class is used to auto-scroll text which does not fit on the
+ * screen.  Call hscroll_init() to initialize the object,
+ * hscroll_clear() to free resources, and hscroll_set() to begin
+ * scrolling.
+ */
 struct hscroll {
+       WINDOW *w;
+       const char *separator;
+
+       /**
+        * The bounding coordinates on the screen.
+        */
+       unsigned x, y, width;
+
+       /**
+        * ncurses attributes for drawing the text.
+        */
+       attr_t attrs;
+
+       /**
+        * ncurses colors for drawing the text.
+        */
+       short pair;
+
+       /**
+        * The scrolled text, in the current locale.
+        */
+       char *text;
+
+       /**
+        * The current scrolling offset.  This is a character
+        * position, not a screen column.
+        */
        gsize offset;
+
+       /**
+        * The id of the timer which updates the scrolled area every
+        * second.
+        */
+       guint source_id;
 };
 
 static inline void
@@ -42,4 +89,37 @@ char *
 strscroll(struct hscroll *hscroll, const char *str, const char *separator,
          unsigned width);
 
+/**
+ * Initializes a #hscroll object allocated by the caller.
+ */
+static inline void
+hscroll_init(struct hscroll *hscroll, WINDOW *w, const char *separator)
+{
+       hscroll->w = w;
+       hscroll->separator = separator;
+}
+
+/**
+ * Sets a text to scroll.  This installs a timer which redraws every
+ * second with the current window attributes.  Call hscroll_clear() to
+ * disable it.  This function automatically removes the old text.
+ */
+void
+hscroll_set(struct hscroll *hscroll, unsigned x, unsigned y, unsigned width,
+           const char *text);
+
+/**
+ * Removes the text and the timer.  It may be reused with
+ * hscroll_set().
+ */
+void
+hscroll_clear(struct hscroll *hscroll);
+
+/**
+ * Explicitly draws the scrolled text.  Calling this function is only
+ * allowed if there is a text currently.
+ */
+void
+hscroll_draw(struct hscroll *hscroll);
+
 #endif