178 lines
6.2 KiB
C
178 lines
6.2 KiB
C
#ifndef _GUISLICE_EX_XSELNUM_H_
|
|
#define _GUISLICE_EX_XSELNUM_H_
|
|
|
|
#include "GUIslice.h"
|
|
|
|
|
|
// =======================================================================
|
|
// GUIslice library extension: Select Number (SelNum) control
|
|
// - Calvin Hass
|
|
// - https://www.impulseadventure.com/elec/guislice-gui.html
|
|
// - https://github.com/ImpulseAdventure/GUIslice
|
|
// =======================================================================
|
|
//
|
|
// The MIT License
|
|
//
|
|
// Copyright 2016-2020 Calvin Hass
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
//
|
|
// =======================================================================
|
|
/// \file XSelNum.h
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif // __cplusplus
|
|
|
|
|
|
|
|
#if (GSLC_FEATURE_COMPOUND)
|
|
// ============================================================================
|
|
// Extended Element: SelNum (Number Selector)
|
|
// - Demonstration of a compound element consisting of
|
|
// a counter text field along with an increment and
|
|
// decrement button.
|
|
// ============================================================================
|
|
|
|
// Define unique identifier for extended element type
|
|
// - Select any number above GSLC_TYPE_BASE_EXTEND
|
|
#define GSLC_TYPEX_SELNUM GSLC_TYPE_BASE_EXTEND + 3
|
|
|
|
#define SELNUM_STR_LEN 6
|
|
|
|
// Extended element data structures
|
|
// - These data structures are maintained in the gslc_tsElem
|
|
// structure via the pXData pointer
|
|
/// Extended data for SelNum element
|
|
typedef struct {
|
|
|
|
// Core functionality for SelNum
|
|
int16_t nCounter; ///< Counter for demo purposes
|
|
|
|
// Internal sub-element members
|
|
gslc_tsCollect sCollect; ///< Collection management for sub-elements
|
|
gslc_tsElemRef asElemRef[4]; ///< Storage for sub-element references
|
|
gslc_tsElem asElem[4]; ///< Storage for sub-elements
|
|
|
|
#if (GSLC_LOCAL_STR == 0)
|
|
// If elements don't provide their own internal string buffer, then
|
|
// we need to provide storage here in the extended data of the compound
|
|
// element. For now, simply provide a fixed-length memory buffer.
|
|
char acElemTxt[4][SELNUM_STR_LEN]; ///< Storage for strings
|
|
#endif
|
|
} gslc_tsXSelNum;
|
|
|
|
|
|
|
|
|
|
///
|
|
/// Create a SelNum Element
|
|
///
|
|
/// \param[in] pGui: Pointer to GUI
|
|
/// \param[in] nElemId: Element ID to assign (0..16383 or GSLC_ID_AUTO to autogen)
|
|
/// \param[in] nPage: Page ID to attach element to
|
|
/// \param[in] pXData: Ptr to extended element data structure
|
|
/// \param[in] rElem: Rectangle coordinates defining element size
|
|
/// \param[in] nFontId: Font ID to use for drawing the element
|
|
///
|
|
/// \return Pointer to Element or NULL if failure
|
|
///
|
|
gslc_tsElemRef* gslc_ElemXSelNumCreate(gslc_tsGui* pGui,int16_t nElemId,int16_t nPage,
|
|
gslc_tsXSelNum* pXData,gslc_tsRect rElem,int8_t nFontId);
|
|
|
|
|
|
///
|
|
/// Draw a SelNum element on the screen
|
|
/// - Called during redraw
|
|
///
|
|
/// \param[in] pvGui: Void ptr to GUI (typecast to gslc_tsGui*)
|
|
/// \param[in] pvElemRef: Void ptr to Element ref (typecast to gslc_tsElemRef*)
|
|
/// \param[in] eRedraw: Redraw mode
|
|
///
|
|
/// \return true if success, false otherwise
|
|
///
|
|
bool gslc_ElemXSelNumDraw(void* pvGui,void* pvElemRef,gslc_teRedrawType eRedraw);
|
|
|
|
|
|
///
|
|
/// Get the current counter associated with SelNum
|
|
///
|
|
/// \param[in] pGui: Ptr to GUI
|
|
/// \param[in] pSelNum: Ptr to Element
|
|
///
|
|
/// \return Current counter value
|
|
///
|
|
int gslc_ElemXSelNumGetCounter(gslc_tsGui* pGui,gslc_tsXSelNum* pSelNum);
|
|
|
|
|
|
///
|
|
/// Set the current counter associated with SelNum
|
|
///
|
|
/// \param[in] pGui: Pointer to GUI
|
|
/// \param[in] pSelNum: Ptr to Element
|
|
/// \param[in] nCount: New counter value
|
|
///
|
|
/// \return none
|
|
///
|
|
void gslc_ElemXSelNumSetCounter(gslc_tsGui* pGui,gslc_tsXSelNum* pSelNum,int16_t nCount);
|
|
|
|
|
|
///
|
|
/// Handle a click event within the SelNum
|
|
/// - This is called internally by the SelNum touch handler
|
|
///
|
|
/// \param[in] pvGui: Void ptr to GUI (typecast to gslc_tsGui*)
|
|
/// \param[in] pvElemRef: Void ptr to Element ref (typecast to gslc_tsElemRef*)
|
|
/// \param[in] eTouch: Touch event type
|
|
/// \param[in] nX: Touch X coord
|
|
/// \param[in] nY: Touch Y coord
|
|
///
|
|
/// \return none
|
|
///
|
|
bool gslc_ElemXSelNumClick(void* pvGui,void *pvElemRef,gslc_teTouch eTouch,int16_t nX,int16_t nY);
|
|
|
|
///
|
|
/// Handle touch (up,down,move) events to SelNum element
|
|
/// - Called from gslc_ElemSendEventTouch()
|
|
///
|
|
/// \param[in] pvGui: Void ptr to GUI (typecast to gslc_tsGui*)
|
|
/// \param[in] pvElemRef: Void ptr to Element ref (typecast to gslc_tsElemRef*)
|
|
/// \param[in] eTouch: Touch event type
|
|
/// \param[in] nRelX: Touch X coord relative to element
|
|
/// \param[in] nRelY: Touch Y coord relative to element
|
|
///
|
|
/// \return true if success, false otherwise
|
|
///
|
|
bool gslc_ElemXSelNumTouch(void* pvGui,void* pvElemRef,gslc_teTouch eTouch,int16_t nRelX,int16_t nRelY);
|
|
#endif // GLSC_COMPOUND
|
|
|
|
// ============================================================================
|
|
|
|
// ------------------------------------------------------------------------
|
|
// Read-only element macros
|
|
// ------------------------------------------------------------------------
|
|
|
|
// Macro initializers for Read-Only Elements in Flash/PROGMEM
|
|
//
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif // __cplusplus
|
|
#endif // _GUISLICE_EX_XSELNUM_H_
|
|
|