Chris Womack / emwin

Headers for emWin lib

Dependents:   DISCO-F746NG_rtos_test

emWin_header/SCROLLBAR.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 : SCROLLBAR.h
redbird 0:1bf8f02b0770 29 Purpose : SCROLLBAR include
redbird 0:1bf8f02b0770 30 --------------------END-OF-HEADER-------------------------------------
redbird 0:1bf8f02b0770 31 */
redbird 0:1bf8f02b0770 32
redbird 0:1bf8f02b0770 33 #ifndef SCROLLBAR_H
redbird 0:1bf8f02b0770 34 #define SCROLLBAR_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
redbird 0:1bf8f02b0770 40 #if GUI_WINSUPPORT
redbird 0:1bf8f02b0770 41
redbird 0:1bf8f02b0770 42 #if defined(__cplusplus)
redbird 0:1bf8f02b0770 43 extern "C" { /* Make sure we have C-declarations in C++ programs */
redbird 0:1bf8f02b0770 44 #endif
redbird 0:1bf8f02b0770 45
redbird 0:1bf8f02b0770 46 /*********************************************************************
redbird 0:1bf8f02b0770 47 *
redbird 0:1bf8f02b0770 48 * Defines
redbird 0:1bf8f02b0770 49 *
redbird 0:1bf8f02b0770 50 **********************************************************************
redbird 0:1bf8f02b0770 51 */
redbird 0:1bf8f02b0770 52 #define SCROLLBAR_CI_THUMB 0
redbird 0:1bf8f02b0770 53 #define SCROLLBAR_CI_SHAFT 1
redbird 0:1bf8f02b0770 54 #define SCROLLBAR_CI_ARROW 2
redbird 0:1bf8f02b0770 55
redbird 0:1bf8f02b0770 56 /*********************************************************************
redbird 0:1bf8f02b0770 57 *
redbird 0:1bf8f02b0770 58 * States
redbird 0:1bf8f02b0770 59 */
redbird 0:1bf8f02b0770 60 #define SCROLLBAR_STATE_PRESSED WIDGET_STATE_USER0
redbird 0:1bf8f02b0770 61
redbird 0:1bf8f02b0770 62 /*********************************************************************
redbird 0:1bf8f02b0770 63 *
redbird 0:1bf8f02b0770 64 * Create / Status flags
redbird 0:1bf8f02b0770 65 */
redbird 0:1bf8f02b0770 66 #define SCROLLBAR_CF_VERTICAL WIDGET_CF_VERTICAL
redbird 0:1bf8f02b0770 67 #define SCROLLBAR_CF_FOCUSSABLE WIDGET_STATE_FOCUSSABLE
redbird 0:1bf8f02b0770 68
redbird 0:1bf8f02b0770 69 /************************************************************
redbird 0:1bf8f02b0770 70 *
redbird 0:1bf8f02b0770 71 * Skinning property indices
redbird 0:1bf8f02b0770 72 */
redbird 0:1bf8f02b0770 73 #define SCROLLBAR_SKINFLEX_PI_PRESSED 0
redbird 0:1bf8f02b0770 74 #define SCROLLBAR_SKINFLEX_PI_UNPRESSED 1
redbird 0:1bf8f02b0770 75
redbird 0:1bf8f02b0770 76 /*********************************************************************
redbird 0:1bf8f02b0770 77 *
redbird 0:1bf8f02b0770 78 * Public Types
redbird 0:1bf8f02b0770 79 *
redbird 0:1bf8f02b0770 80 **********************************************************************
redbird 0:1bf8f02b0770 81 */
redbird 0:1bf8f02b0770 82 typedef WM_HMEM SCROLLBAR_Handle;
redbird 0:1bf8f02b0770 83
redbird 0:1bf8f02b0770 84 typedef struct {
redbird 0:1bf8f02b0770 85 GUI_COLOR aColorFrame[3];
redbird 0:1bf8f02b0770 86 GUI_COLOR aColorUpper[2];
redbird 0:1bf8f02b0770 87 GUI_COLOR aColorLower[2];
redbird 0:1bf8f02b0770 88 GUI_COLOR aColorShaft[2];
redbird 0:1bf8f02b0770 89 GUI_COLOR ColorArrow;
redbird 0:1bf8f02b0770 90 GUI_COLOR ColorGrasp;
redbird 0:1bf8f02b0770 91 } SCROLLBAR_SKINFLEX_PROPS;
redbird 0:1bf8f02b0770 92
redbird 0:1bf8f02b0770 93 typedef struct {
redbird 0:1bf8f02b0770 94 int IsVertical;
redbird 0:1bf8f02b0770 95 int State;
redbird 0:1bf8f02b0770 96 } SCROLLBAR_SKINFLEX_INFO;
redbird 0:1bf8f02b0770 97
redbird 0:1bf8f02b0770 98 /*********************************************************************
redbird 0:1bf8f02b0770 99 *
redbird 0:1bf8f02b0770 100 * Create functions
redbird 0:1bf8f02b0770 101 *
redbird 0:1bf8f02b0770 102 **********************************************************************
redbird 0:1bf8f02b0770 103 */
redbird 0:1bf8f02b0770 104 SCROLLBAR_Handle SCROLLBAR_Create (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int Id, int WinFlags, int SpecialFlags);
redbird 0:1bf8f02b0770 105 SCROLLBAR_Handle SCROLLBAR_CreateAttached(WM_HWIN hParent, int SpecialFlags);
redbird 0:1bf8f02b0770 106 SCROLLBAR_Handle SCROLLBAR_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id);
redbird 0:1bf8f02b0770 107 SCROLLBAR_Handle SCROLLBAR_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int NumExtraBytes);
redbird 0:1bf8f02b0770 108 SCROLLBAR_Handle SCROLLBAR_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
redbird 0:1bf8f02b0770 109
redbird 0:1bf8f02b0770 110 /*********************************************************************
redbird 0:1bf8f02b0770 111 *
redbird 0:1bf8f02b0770 112 * The callback ...
redbird 0:1bf8f02b0770 113 *
redbird 0:1bf8f02b0770 114 * Do not call it directly ! It is only to be used from within an
redbird 0:1bf8f02b0770 115 * overwritten callback.
redbird 0:1bf8f02b0770 116 */
redbird 0:1bf8f02b0770 117 void SCROLLBAR_Callback(WM_MESSAGE * pMsg);
redbird 0:1bf8f02b0770 118
redbird 0:1bf8f02b0770 119 /*********************************************************************
redbird 0:1bf8f02b0770 120 *
redbird 0:1bf8f02b0770 121 * Member functions
redbird 0:1bf8f02b0770 122 *
redbird 0:1bf8f02b0770 123 **********************************************************************
redbird 0:1bf8f02b0770 124 */
redbird 0:1bf8f02b0770 125
redbird 0:1bf8f02b0770 126 /* Methods changing properties */
redbird 0:1bf8f02b0770 127
redbird 0:1bf8f02b0770 128 void SCROLLBAR_AddValue (SCROLLBAR_Handle hObj, int Add);
redbird 0:1bf8f02b0770 129 void SCROLLBAR_Dec (SCROLLBAR_Handle hObj);
redbird 0:1bf8f02b0770 130 void SCROLLBAR_Inc (SCROLLBAR_Handle hObj);
redbird 0:1bf8f02b0770 131 int SCROLLBAR_GetUserData(SCROLLBAR_Handle hObj, void * pDest, int NumBytes);
redbird 0:1bf8f02b0770 132 GUI_COLOR SCROLLBAR_SetColor (SCROLLBAR_Handle hObj, int Index, GUI_COLOR Color);
redbird 0:1bf8f02b0770 133 void SCROLLBAR_SetNumItems(SCROLLBAR_Handle hObj, int NumItems);
redbird 0:1bf8f02b0770 134 void SCROLLBAR_SetPageSize(SCROLLBAR_Handle hObj, int PageSize);
redbird 0:1bf8f02b0770 135 void SCROLLBAR_SetValue (SCROLLBAR_Handle hObj, int v);
redbird 0:1bf8f02b0770 136 int SCROLLBAR_SetWidth (SCROLLBAR_Handle hObj, int Width);
redbird 0:1bf8f02b0770 137 void SCROLLBAR_SetState (SCROLLBAR_Handle hObj, const WM_SCROLL_STATE* pState);
redbird 0:1bf8f02b0770 138 int SCROLLBAR_SetUserData(SCROLLBAR_Handle hObj, const void * pSrc, int NumBytes);
redbird 0:1bf8f02b0770 139
redbird 0:1bf8f02b0770 140 /*********************************************************************
redbird 0:1bf8f02b0770 141 *
redbird 0:1bf8f02b0770 142 * Member functions: Skinning
redbird 0:1bf8f02b0770 143 *
redbird 0:1bf8f02b0770 144 **********************************************************************
redbird 0:1bf8f02b0770 145 */
redbird 0:1bf8f02b0770 146 void SCROLLBAR_GetSkinFlexProps (SCROLLBAR_SKINFLEX_PROPS * pProps, int Index);
redbird 0:1bf8f02b0770 147 void SCROLLBAR_SetSkinClassic (SCROLLBAR_Handle hObj);
redbird 0:1bf8f02b0770 148 void SCROLLBAR_SetSkin (SCROLLBAR_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
redbird 0:1bf8f02b0770 149 int SCROLLBAR_DrawSkinFlex (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
redbird 0:1bf8f02b0770 150 void SCROLLBAR_SetSkinFlexProps (const SCROLLBAR_SKINFLEX_PROPS * pProps, int Index);
redbird 0:1bf8f02b0770 151 void SCROLLBAR_SetDefaultSkinClassic(void);
redbird 0:1bf8f02b0770 152 WIDGET_DRAW_ITEM_FUNC * SCROLLBAR_SetDefaultSkin(WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
redbird 0:1bf8f02b0770 153
redbird 0:1bf8f02b0770 154 #define SCROLLBAR_SKIN_FLEX SCROLLBAR_DrawSkinFlex
redbird 0:1bf8f02b0770 155
redbird 0:1bf8f02b0770 156 /*********************************************************************
redbird 0:1bf8f02b0770 157 *
redbird 0:1bf8f02b0770 158 * Global functions
redbird 0:1bf8f02b0770 159 *
redbird 0:1bf8f02b0770 160 **********************************************************************
redbird 0:1bf8f02b0770 161 */
redbird 0:1bf8f02b0770 162 int SCROLLBAR_GetDefaultWidth(void);
redbird 0:1bf8f02b0770 163 int SCROLLBAR_GetThumbSizeMin(void);
redbird 0:1bf8f02b0770 164 GUI_COLOR SCROLLBAR_SetDefaultColor(GUI_COLOR Color, unsigned int Index); /* Not yet documented */
redbird 0:1bf8f02b0770 165 int SCROLLBAR_SetDefaultWidth(int DefaultWidth);
redbird 0:1bf8f02b0770 166 int SCROLLBAR_SetThumbSizeMin(int ThumbSizeMin);
redbird 0:1bf8f02b0770 167
redbird 0:1bf8f02b0770 168 /*********************************************************************
redbird 0:1bf8f02b0770 169 *
redbird 0:1bf8f02b0770 170 * Query state
redbird 0:1bf8f02b0770 171 *
redbird 0:1bf8f02b0770 172 **********************************************************************
redbird 0:1bf8f02b0770 173 */
redbird 0:1bf8f02b0770 174 int SCROLLBAR_GetNumItems(SCROLLBAR_Handle hObj);
redbird 0:1bf8f02b0770 175 int SCROLLBAR_GetPageSize(SCROLLBAR_Handle hObj);
redbird 0:1bf8f02b0770 176 int SCROLLBAR_GetValue (SCROLLBAR_Handle hObj);
redbird 0:1bf8f02b0770 177
redbird 0:1bf8f02b0770 178 /*********************************************************************
redbird 0:1bf8f02b0770 179 *
redbird 0:1bf8f02b0770 180 * Macros for compatibility
redbird 0:1bf8f02b0770 181 *
redbird 0:1bf8f02b0770 182 **********************************************************************
redbird 0:1bf8f02b0770 183 */
redbird 0:1bf8f02b0770 184 #define SCROLLBAR_BKCOLOR0_DEFAULT SCROLLBAR_COLOR_ARROW_DEFAULT
redbird 0:1bf8f02b0770 185 #define SCROLLBAR_BKCOLOR1_DEFAULT SCROLLBAR_COLOR_SHAFT_DEFAULT
redbird 0:1bf8f02b0770 186 #define SCROLLBAR_COLOR0_DEFAULT SCROLLBAR_COLOR_THUMB_DEFAULT
redbird 0:1bf8f02b0770 187
redbird 0:1bf8f02b0770 188 #if defined(__cplusplus)
redbird 0:1bf8f02b0770 189 }
redbird 0:1bf8f02b0770 190 #endif
redbird 0:1bf8f02b0770 191
redbird 0:1bf8f02b0770 192 #endif // GUI_WINSUPPORT
redbird 0:1bf8f02b0770 193 #endif // SCROLLBAR_H
redbird 0:1bf8f02b0770 194
redbird 0:1bf8f02b0770 195 /*************************** End of file ****************************/