Chris Womack / emwin

Headers for emWin lib

Dependents:   DISCO-F746NG_rtos_test

emWin_header/KNOB.h@0:1bf8f02b0770, 2016-03-26 (annotated)

Committer:
redbird
Date:
Sat Mar 26 22:49:50 2016 +0000
Revision:
0:1bf8f02b0770
new code integration

Who changed what in which revision?

UserRevisionLine numberNew contents of line
redbird 0:1bf8f02b0770 1 /*********************************************************************
redbird 0:1bf8f02b0770 2 * SEGGER Microcontroller GmbH & Co. KG *
redbird 0:1bf8f02b0770 3 * Solutions for real time microcontroller applications *
redbird 0:1bf8f02b0770 4 **********************************************************************
redbird 0:1bf8f02b0770 5 * *
redbird 0:1bf8f02b0770 6 * (c) 1996 - 2014 SEGGER Microcontroller GmbH & Co. KG *
redbird 0:1bf8f02b0770 7 * *
redbird 0:1bf8f02b0770 8 * Internet: www.segger.com Support: support@segger.com *
redbird 0:1bf8f02b0770 9 * *
redbird 0:1bf8f02b0770 10 **********************************************************************
redbird 0:1bf8f02b0770 11
redbird 0:1bf8f02b0770 12 ** emWin V5.24 - Graphical user interface for embedded applications **
redbird 0:1bf8f02b0770 13 All Intellectual Property rights in the Software belongs to SEGGER.
redbird 0:1bf8f02b0770 14 emWin is protected by international copyright laws. Knowledge of the
redbird 0:1bf8f02b0770 15 source code may not be used to write a similar product. This file may
redbird 0:1bf8f02b0770 16 only be used in accordance with the following terms:
redbird 0:1bf8f02b0770 17
redbird 0:1bf8f02b0770 18 The software has been licensed to NXP Semiconductors USA, Inc. whose
redbird 0:1bf8f02b0770 19 registered office is situated at 411 E. Plumeria Drive, San Jose,
redbird 0:1bf8f02b0770 20 CA 95134, USA solely for the purposes of creating libraries for
redbird 0:1bf8f02b0770 21 NXPs M0, M3/M4 and ARM7/9 processor-based devices, sublicensed and
redbird 0:1bf8f02b0770 22 distributed under the terms and conditions of the NXP End User License
redbird 0:1bf8f02b0770 23 Agreement.
redbird 0:1bf8f02b0770 24 Full source code is available at: www.segger.com
redbird 0:1bf8f02b0770 25
redbird 0:1bf8f02b0770 26 We appreciate your understanding and fairness.
redbird 0:1bf8f02b0770 27 ----------------------------------------------------------------------
redbird 0:1bf8f02b0770 28 File : KNOB.h
redbird 0:1bf8f02b0770 29 Purpose : KNOB include
redbird 0:1bf8f02b0770 30 --------------------END-OF-HEADER-------------------------------------
redbird 0:1bf8f02b0770 31 */
redbird 0:1bf8f02b0770 32
redbird 0:1bf8f02b0770 33 #ifndef KNOB_H
redbird 0:1bf8f02b0770 34 #define KNOB_H
redbird 0:1bf8f02b0770 35
redbird 0:1bf8f02b0770 36 #include "WM.h"
redbird 0:1bf8f02b0770 37 #include "DIALOG_Intern.h" // Req. for Create indirect data structure
redbird 0:1bf8f02b0770 38 #include "WIDGET.h"
redbird 0:1bf8f02b0770 39 #include "GUI_Debug.h"
redbird 0:1bf8f02b0770 40
redbird 0:1bf8f02b0770 41 #if (GUI_SUPPORT_MEMDEV && GUI_WINSUPPORT)
redbird 0:1bf8f02b0770 42
redbird 0:1bf8f02b0770 43 #if defined(__cplusplus)
redbird 0:1bf8f02b0770 44 extern "C" { // Make sure we have C-declarations in C++ programs
redbird 0:1bf8f02b0770 45 #endif
redbird 0:1bf8f02b0770 46
redbird 0:1bf8f02b0770 47 /*********************************************************************
redbird 0:1bf8f02b0770 48 *
redbird 0:1bf8f02b0770 49 * Public Types
redbird 0:1bf8f02b0770 50 *
redbird 0:1bf8f02b0770 51 **********************************************************************
redbird 0:1bf8f02b0770 52 */
redbird 0:1bf8f02b0770 53 typedef WM_HMEM KNOB_Handle;
redbird 0:1bf8f02b0770 54
redbird 0:1bf8f02b0770 55 /*********************************************************************
redbird 0:1bf8f02b0770 56 *
redbird 0:1bf8f02b0770 57 * Create functions
redbird 0:1bf8f02b0770 58 *
redbird 0:1bf8f02b0770 59 **********************************************************************
redbird 0:1bf8f02b0770 60 */
redbird 0:1bf8f02b0770 61 KNOB_Handle KNOB_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int Id);
redbird 0:1bf8f02b0770 62 KNOB_Handle KNOB_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int Id, int NumExtraBytes);
redbird 0:1bf8f02b0770 63 KNOB_Handle KNOB_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
redbird 0:1bf8f02b0770 64
redbird 0:1bf8f02b0770 65 /*********************************************************************
redbird 0:1bf8f02b0770 66 *
redbird 0:1bf8f02b0770 67 * The callback ...
redbird 0:1bf8f02b0770 68 *
redbird 0:1bf8f02b0770 69 * Do not call it directly ! It is only to be used from within an
redbird 0:1bf8f02b0770 70 * overwritten callback.
redbird 0:1bf8f02b0770 71 */
redbird 0:1bf8f02b0770 72 void KNOB_Callback(WM_MESSAGE * pMsg);
redbird 0:1bf8f02b0770 73
redbird 0:1bf8f02b0770 74 /*********************************************************************
redbird 0:1bf8f02b0770 75 *
redbird 0:1bf8f02b0770 76 * Member functions
redbird 0:1bf8f02b0770 77 *
redbird 0:1bf8f02b0770 78 **********************************************************************
redbird 0:1bf8f02b0770 79 */
redbird 0:1bf8f02b0770 80 void KNOB_AddValue (KNOB_Handle hObj, I32 Value);
redbird 0:1bf8f02b0770 81 int KNOB_GetUserData(KNOB_Handle hObj, void * pDest, int NumBytes); // Gets user defined data
redbird 0:1bf8f02b0770 82 I32 KNOB_GetValue (KNOB_Handle hObj); // Returns the position of the knob in tenth of degree
redbird 0:1bf8f02b0770 83 void KNOB_SetBkColor (KNOB_Handle hObj, GUI_COLOR Color); // Sets the BK color of the widget
redbird 0:1bf8f02b0770 84 void KNOB_SetBkDevice(KNOB_Handle hObj, GUI_MEMDEV_Handle hMemBk); // Sets the background device
redbird 0:1bf8f02b0770 85 void KNOB_SetDevice (KNOB_Handle hObj, GUI_MEMDEV_Handle hMemSrc); // Sets the memory device with the drawn knob
redbird 0:1bf8f02b0770 86 void KNOB_SetKeyValue(KNOB_Handle hObj, I32 KeyValue); // Sets the value the knob will rotate on one key press
redbird 0:1bf8f02b0770 87 void KNOB_SetOffset (KNOB_Handle hObj, I32 Offset); // Sets the offset angle of the knob
redbird 0:1bf8f02b0770 88 void KNOB_SetPeriod (KNOB_Handle hObj, I32 Period); // Sets the period in which the knob stops
redbird 0:1bf8f02b0770 89 void KNOB_SetPos (KNOB_Handle hObj, I32 Pos); // Sets position of the knob in tenth of degree
redbird 0:1bf8f02b0770 90 void KNOB_SetRange (KNOB_Handle hObj, I32 MinRange, I32 MaxRange); // Sets the usable range of the knob widget
redbird 0:1bf8f02b0770 91 void KNOB_SetSnap (KNOB_Handle hObj, I32 Snap); // Sets Snap positions where the knob stops
redbird 0:1bf8f02b0770 92 void KNOB_SetTickSize(KNOB_Handle hObj, I32 TickSize); // Sets the ticksize, in 1/10 of degree
redbird 0:1bf8f02b0770 93 int KNOB_SetUserData(KNOB_Handle hObj, const void * pSrc, int NumBytes); // Sets user defined data
redbird 0:1bf8f02b0770 94
redbird 0:1bf8f02b0770 95 /*********************************************************************
redbird 0:1bf8f02b0770 96 *
redbird 0:1bf8f02b0770 97 * Global functions
redbird 0:1bf8f02b0770 98 *
redbird 0:1bf8f02b0770 99 **********************************************************************
redbird 0:1bf8f02b0770 100 */
redbird 0:1bf8f02b0770 101
redbird 0:1bf8f02b0770 102 #if defined(__cplusplus)
redbird 0:1bf8f02b0770 103 }
redbird 0:1bf8f02b0770 104 #endif
redbird 0:1bf8f02b0770 105
redbird 0:1bf8f02b0770 106 #endif // (GUI_SUPPORT_MEMDEV && GUI_WINSUPPORT)
redbird 0:1bf8f02b0770 107 #endif // KNOB_H
redbird 0:1bf8f02b0770 108
redbird 0:1bf8f02b0770 109 /*************************** End of file ****************************/