105 lines
3.0 KiB
C
105 lines
3.0 KiB
C
/*
|
|
* 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.io/license.html
|
|
*/
|
|
|
|
/**
|
|
* @file src/ginput/ginput_dial.h
|
|
*
|
|
* @defgroup Dial Dial
|
|
* @ingroup GINPUT
|
|
*
|
|
* @brief Sub-Module to handle physical controls that provide a range value (eg. potentiometers and rotary encoders).
|
|
*
|
|
* @details A dial provides a powerful way to navigate through menus
|
|
* on a display.
|
|
*
|
|
* @pre GFX_USE_GINPUT must be set to GFXON in your gfxconf.h
|
|
* @pre GINPUT_NEED_DIAL must be set to GFXON 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)
|
|
gU16 instance; // The dial instance
|
|
gU16 value; // The dial value
|
|
gU16 maxvalue; // The maximum dial value
|
|
} GEventDial;
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @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(gU16 instance);
|
|
|
|
/**
|
|
* @brief Reset the value back to the hardware default
|
|
*
|
|
* @param[in] instance The ID of the dial input instance
|
|
*/
|
|
void ginputResetDialRange(gU16 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
|
|
*/
|
|
gU16 ginputGetDialRange(gU16 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(gU16 instance, gU16 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(gU16 instance, gU16 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 gFalse on an error (eg invalid instance)
|
|
*/
|
|
gBool ginputGetDialStatus(gU16 instance, GEventDial *pdial);
|
|
|
|
#endif /* GINPUT_NEED_DIAL */
|
|
|
|
#endif /* _GINPUT_DIAL_H */
|
|
/** @} */
|