From 37966ff16d923bbca53c9464815cb49cbd7fc3be Mon Sep 17 00:00:00 2001
From: inmarket <andrewh@inmarket.com.au>
Date: Wed, 19 Feb 2014 00:36:52 +1000
Subject: Integrate the include files with each module. Simplifies structure of
 code.

---
 src/ginput/dial.h | 111 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 111 insertions(+)
 create mode 100644 src/ginput/dial.h

(limited to 'src/ginput/dial.h')

diff --git a/src/ginput/dial.h b/src/ginput/dial.h
new file mode 100644
index 00000000..a90b5e46
--- /dev/null
+++ b/src/ginput/dial.h
@@ -0,0 +1,111 @@
+/*
+ * This file is subject to the terms of the GFX License. If a copy of
+ * the license was not distributed with this file, you can obtain one at:
+ *
+ *              http://ugfx.org/license.html
+ */
+
+/**
+ * @file    include/ginput/dial.h
+ * @brief   GINPUT GFX User Input subsystem header file.
+ *
+ * @defgroup Dial Dial
+ * @ingroup GINPUT
+ *
+ * @details	A dial provides a powerful way to navigate through menus
+ *			on a display. 
+ *
+ * @pre		GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
+ * @pre		GINPUT_NEED_DIAL must be set to TRUE in your gfxconf.h
+ *
+ * @{
+ */
+#ifndef _GINPUT_DIAL_H
+#define _GINPUT_DIAL_H
+
+#if GINPUT_NEED_DIAL || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Type definitions                                                          */
+/*===========================================================================*/
+
+// Event types for various ginput sources
+#define GEVENT_DIAL			(GEVENT_GINPUT_FIRST+4)
+
+typedef struct GEventDial_t {
+	GEventType		type;				// The type of this event (GEVENT_DIAL)
+	uint16_t		instance;			// The dial instance
+	uint16_t		value;				// The dial value
+	uint16_t		maxvalue;			// The maximum dial value
+	} GEventDial;
+
+/*===========================================================================*/
+/* External declarations.                                                    */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+	/**
+	 * @brief	Create a dial input instance
+	 *
+	 * @param[in] instance	The ID of the dial input instance (from 0 to 9999)
+	 *
+	 * @return	The soure handle of the created dial instance
+	 */
+	GSourceHandle ginputGetDial(uint16_t instance);				
+	
+	/**
+	 * @brief	Reset the value back to the hardware default
+	 *
+	 * @param[in] instance	The ID of the dial input instance
+	 */
+	void ginputResetDialRange(uint16_t instance);				
+
+	/**
+	 * @brief	Get the maximum value
+	 * @details	The readings are scaled to be 0 ... max.
+	 *
+	 * @param[in] instance	The ID of the dial input instance
+	 *
+	 * @return	The maximum value
+	 */
+	uint16_t ginputGetDialRange(uint16_t instance);
+
+	/**
+	 * @brief	Set the maximum value
+	 * @details	The readings are scaled to be 0 ... max.
+	 *
+	 * @param[in] instance	The ID of the dial input instance
+	 * @param[in] max		The maximum value to be set
+	 */
+	void ginputSetDialRange(uint16_t instance, uint16_t max);
+
+	/**
+	 * @brief	Set the level change required before a dial even is generated (threshold)
+	 * @note	This is done after range scaling
+	 *
+	 * @param[in] instance	The ID of the dial input instance
+	 * @param[in] diff		The amount of level changes
+	 */
+	void ginputSetDialSensitivity(uint16_t instance, uint16_t diff);
+																	
+	/**
+	 * @brief	Get the current dial status
+	 *
+	 * @param[in] instance	The ID of the dial input instance
+	 * @param[in] pdial		The dial event struct
+	 *
+	 * @return	Returns FALSE on an error (eg invalid instance)
+	 */
+	bool_t ginputGetDialStatus(uint16_t instance, GEventDial *pdial);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* GINPUT_NEED_DIAL */
+
+#endif /* _GINPUT_DIAL_H */
+/** @} */
-- 
cgit v1.2.3