ui: Added spinbox widget.

777a5ae7 · = · 71e51349 · 777a5ae7 · 777a5ae7
Commit 777a5ae7 authored Sep 17, 2014 by =
Hide whitespace changes
Inline Side-by-side

Showing with 209 additions and 0 deletions

spinbox.c sw/freertos/src/apps/widgets/spinbox.c +103 -0

spinbox.h sw/freertos/src/apps/widgets/spinbox.h +106 -0

No files found.
--- a/sw/freertos/src/apps/widgets/spinbox.c
+++ b/sw/freertos/src/apps/widgets/spinbox.c
+/*
+ * Copyright (C) 2014 Julian Lewis
+ * @author Maciej Suminski <maciej.suminski@cern.ch>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+/**
+ * @brief Spin box (to select a digit or letter).
+ */
+
+#include "spinbox.h"
+
+// Default character sets.
+const char *char_digits = "0123456789\x0";
+const char *char_letters = "abcdefghijklmnopqrstuvwxyz\0";
+
+static void spinbox_event(struct ui_widget *w, const struct event *evt)
+{
+    struct spinbox *s = (struct spinbox*) w->data;
+
+    if(s->active && evt->type == BUTTON_PRESSED) {
+        if(evt->data.button == BUT_BR) {
+            if(s->chars[s->value_idx + 1] != 0) {
+                ++s->value_idx;
+                w->flags |= WF_DIRTY;
+            }
+        } else if(evt->data.button == BUT_BL) {
+            if(s->value_idx > 0) {
+                --s->value_idx;
+                w->flags |= WF_DIRTY;
+            }
+        }
+    }
+}
+
+static void spinbox_redraw(struct ui_widget *w)
+{
+    struct spinbox *s = (struct spinbox*) w->data;
+    const char buf[] = { spinbox_get_value(s), 0 };   // add the string terminator
+    int width = gfx_text_width(s->font, buf);
+
+    gfx_clear(&w->dc, 0);
+    gfx_text(&w->dc, s->font, 0, 0, buf, 1);
+
+    // underline
+    if(s->active) {
+        gfx_line(&w->dc, 0, s->font->height,
+                         0 + width, s->font->height, 1);
+        gfx_line(&w->dc, 0, s->font->height - 1,
+                         0 + width, s->font->height - 1, 1);
+    }
+}
+
+void spinbox_init_widget(struct spinbox *s, struct rect pos, const char *character_set)
+{
+    s->chars = character_set;
+    s->value_idx = 0;
+    s->active = false;
+
+    s->widget.redraw = &spinbox_redraw;
+    s->widget.event = &spinbox_event;
+    s->widget.pos = pos;
+    s->widget.order = 0;
+    s->widget.flags = WF_ACTIVE | WF_VISIBLE;
+    s->widget.data = (void*)s;
+    spinbox_set_font(s, &font_helv38b);
+    ui_init_widget(&s->widget);
+}
+
+void spinbox_set_font(struct spinbox *s, const struct font *f)
+{
+    s->font = f;
+}
+
+void spinbox_set_value(struct spinbox *s, char val)
+{
+    int idx = 0;
+
+    while(s->chars[idx]) {
+        if(s->chars[idx] == val) {
+            s->value_idx = idx;
+            break;
+        }
+        ++idx;
+    }
+}
+
--- a/sw/freertos/src/apps/widgets/spinbox.h
+++ b/sw/freertos/src/apps/widgets/spinbox.h
+/*
+ * Copyright (C) 2014 Julian Lewis
+ * @author Maciej Suminski <maciej.suminski@cern.ch>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+/**
+ * @brief Spin box (to select a digit or letter).
+ */
+
+#ifndef SPINBOX_H
+#define SPINBOX_H
+
+#include <gfx/ui.h>
+#include <stdbool.h>
+
+///> Set of digits that can be used in a spinbox.
+extern const char *char_digits;
+
+///> Set of letters that can be used in a spinbox.
+extern const char *char_letters;
+
+struct spinbox {
+    ///> UI widget that represents the spinbox.
+    struct ui_widget widget;
+
+    ///> Possible values to choose from.
+    const char *chars;
+
+    ///> Font used to display the value.
+    const struct font *font;
+
+    ///> Current index in the chars[] array.
+    int value_idx;
+
+    ///> Is it active spinbox?
+    bool active;
+};
+
+/**
+ * Function that initializes a spinbox structure. It is required to initialize
+ * a spinbox structure in order to use it.
+ * @param s is a pointer to the spinbox that should be initialized.
+ * @param character_set is a set of characters that will be selectable in
+ * the initalized spinbox.
+ */
+void spinbox_init_widget(struct spinbox *s, struct rect pos, const char *character_set);
+
+/**
+ * Changes the font used in the spinbox.
+ * @param s is a pointer to the spinbox that will have the font changed.
+ * @param f is a pointer to the new font.
+ */
+void spinbox_set_font(struct spinbox *s, const struct font *f);
+
+/**
+ * Returns the current value set in the spinbox. Please note that it returns
+ * an ASCII character, so in case of digits you should subtract '0' to get
+ * the digit.
+ * @param s is a pointer to the spinbox that is queried for its value.
+ * @return Currently set ASCII character.
+ */
+inline static char spinbox_get_value(const struct spinbox *s)
+{
+    return s->chars[s->value_idx];
+}
+
+/**
+ * Sets value for a spinbox. If value is not available in the available set of
+ * values, it will not be changed.
+ * @param s is a pointer to the spinbox.
+ * @param val is the new value.
+ */
+void spinbox_set_value(struct spinbox *s, char val);
+
+/**
+ * Changes the active property for a spinbox. By default spinbox is inactive.
+ * When it is active, it reacts to button events and displays an underline to
+ * indicate the active state. You can have multiple active spinboxes at the
+ * same time.
+ * @param s is a pointer to the spinbox to set.
+ * @param active decides if it should be active or not.
+ */
+inline static void spinbox_set_active(struct spinbox *s, bool active)
+{
+    s->active = active;
+    s->widget.flags |= WF_DIRTY;
+}
+
+#endif /* SPINBOX_H */