aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/slider.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gwin/slider.h')
-rw-r--r--include/gwin/slider.h233
1 files changed, 233 insertions, 0 deletions
diff --git a/include/gwin/slider.h b/include/gwin/slider.h
new file mode 100644
index 00000000..412900a5
--- /dev/null
+++ b/include/gwin/slider.h
@@ -0,0 +1,233 @@
+/*
+ ChibiOS/GFX - Copyright (C) 2012, 2013
+ Joel Bodenmann aka Tectu <joel@unormal.org>
+
+ This file is part of ChibiOS/GFX.
+
+ ChibiOS/GFX 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 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/GFX 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, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file include/gwin/slider.h
+ * @brief GWIN Graphic window subsystem header file.
+ *
+ * @defgroup Slider Slider
+ * @ingroup GWIN
+ *
+ * @details Create sliders with different styles
+ *
+ * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
+ * @pre GWIN_NEED_SLIDER must be set to TRUE in your gfxconf.h
+ * @{
+ */
+
+#ifndef _GWIN_SLIDER_H
+#define _GWIN_SLIDER_H
+
+#if GWIN_NEED_SLIDER || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+#define GW_SLIDER 0x0004
+#define GEVENT_GWIN_SLIDER (GEVENT_GWIN_FIRST+1)
+
+/*===========================================================================*/
+/* Type definitions */
+/*===========================================================================*/
+
+typedef struct GEventGWinSlider_t {
+ GEventType type; // The type of this event (GEVENT_GWIN_BUTTON)
+ GHandle slider; // The slider that is returning results
+ int position;
+} GEventGWinSlider;
+
+// There are currently no GEventGWinSlider listening flags - use 0
+
+typedef struct GSliderDrawStyle_t {
+ color_t color_edge;
+ color_t color_thumb;
+ color_t color_active;
+ color_t color_inactive;
+} GSliderDrawStyle;
+
+typedef void (*GSliderDrawFunction)(GHandle gh, bool_t isVertical, coord_t thumbpos, const GSliderDrawStyle *pstyle, void *param);
+
+// A slider window
+typedef struct GSliderObject_t {
+ GWindowObject gwin;
+
+ GSliderDrawStyle style;
+ bool_t tracking;
+ int min;
+ int max;
+ int pos;
+ GSliderDrawFunction fn;
+ void *param;
+ GListener listener;
+} GSliderObject;
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Create a slider window.
+ * @return NULL if there is no resultant drawing area, otherwise a window handle.
+ *
+ * @param[in] gb The GSliderObject structure to initialise. If this is NULL the structure is dynamically allocated.
+ * @param[in] x,y The screen co-ordinates for the bottom left corner of the window
+ * @param[in] width The width of the window
+ * @param[in] height The height of the window
+ * @note The drawing color gets set to White and the background drawing color to Black.
+ * @note The dimensions and position may be changed to fit on the real screen.
+ * @note The slider is not automatically drawn. Call gwinSliderDraw() after changing the slider style.
+ * @note Sets the slider range from 0 to 100 with an initial position of 0
+ *
+ * @api
+ */
+GHandle gwinCreateSlider(GSliderObject *gb, coord_t x, coord_t y, coord_t width, coord_t height);
+
+/**
+ * @brief Set the slider range.
+ *
+ * @param[in] gh The window handle (must be a slider window)
+ * @param[in] min The minimum value
+ * @param[in] max The maximum value
+ * @note Sets the position to the minimum value.
+ * @note The slider is not automatically drawn. Call gwinSliderDraw() after changing the range.
+ *
+ * @api
+ */
+void gwinSetSliderRange(GHandle gh, int min, int max);
+
+/**
+ * @brief Set the slider position.
+ *
+ * @param[in] gh The window handle (must be a slider window)
+ * @param[in] pos The new position
+ * @note If the new position is outside the slider range then the position
+ * is set to the closest end of the range.
+ * @note The slider is not automatically drawn. Call gwinSliderDraw() after changing the position.
+ *
+ * @api
+ */
+void gwinSetSliderPosition(GHandle gh, int pos);
+
+/**
+ * @brief Set the style of a slider.
+ * @details The slider style is defined by its colours.
+ *
+ * @param[in] gh The window handle (must be a slider window)
+ * @param[in] pStyle The styling for the slider.
+ *
+ * @note The slider is not automatically redrawn. Call gwinSliderDraw() after changing the slider style
+ * @note The slider style is copied into the internal slider structure - there is no need to
+ * maintain a static style structure.
+ *
+ * @api
+ */
+void gwinSetSliderStyle(GHandle gh, const GSliderDrawStyle *pStyle);
+
+/**
+ * @brief Redraw the slider.
+ *
+ * @param[in] gh The window handle (must be a slider window)
+ *
+ * @api
+ */
+void gwinSliderDraw(GHandle gh);
+
+/**
+ * @brief Set the callback routine to perform a custom slider drawing.
+ *
+ * @param[in] gh The window handle (must be a slider window)
+ * @param[in] fn The function to use to draw the slider
+ * @param[in] param A parameter to pass to the slider drawing function
+ *
+ * @api
+ */
+void gwinSetSliderCustom(GHandle gh, GSliderDrawFunction fn, void *param);
+
+/**
+ * @brief Get the current slider position.
+ * @return The slider position
+ *
+ * @param[in] gh The window handle (must be a slider window)
+ *
+ * @note The use of a listener to get the slider position is recommended if you
+ * want continuous updates on the slider position.
+ *
+ * @api
+ */
+#define gwinGetSliderPosition(gh) (((GSliderObject *)(gh))->pos)
+
+/**
+ * @brief Get the source handle of a slider
+ * @details Get the source handle of a slider so the application can listen for events
+ *
+ * @param[in] gh The window handle
+ *
+ * @api
+ */
+#define gwinGetSliderSource(gh) ((GSourceHandle)(gh))
+
+#if defined(GINPUT_NEED_MOUSE) && GINPUT_NEED_MOUSE
+ /**
+ * @brief Attach a mouse source
+ * @details Attach a mouse source to a slider
+ *
+ * @param[in] gh The slider handle
+ * @param[in] gsh The source handle
+ *
+ * @api
+ */
+ bool_t gwinAttachSliderMouseSource(GHandle gh, GSourceHandle gsh);
+#endif
+
+/**
+ * @brief Standard slider drawing routines
+ * @details This routine is called to draw the standard slider.
+ *
+ * @param[in] gh The slider handle
+ * @param[in] isVertical The slider is vertically oriented instead of horizontal
+ * @param[in] thumbpos The position of the slider (0..cx-1 or cy-1..0)
+ * @param[in] pstyle The current drawing style
+ * @param[in] param A parameter passed in from the user
+ *
+ * @note In your custom slider drawing function you may optionally call this
+ * standard functions and then draw your extra details on top.
+ * @note The standard functions below ignore the param parameter. It is there
+ * only to ensure the functions match the GSliderDrawFunction type.
+ * @note When called by a slider the framework ensure that it is
+ * a slider object and sets up clipping to the slider object window. These
+ * drawing routines then don't have to worry about explicitly doing that.
+ *
+ * @api
+ */
+void gwinSliderDraw_Std(GHandle gh, bool_t isVertical, coord_t thumbpos, const GSliderDrawStyle *pstyle, void *param);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* GWIN_NEED_SLIDER */
+
+#endif /* _GWIN_SLIDER_H */
+/** @} */
+
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-25 21:35:57 +0000