Nuvoton / Mbed OS NuMaker-mbed-emWin-example

NuMaker emWin HMI

emWin/Include/HEADER.h@10:c8165817d92a, 6 months ago (annotated)

Committer:
csyang2
Date:
Mon Mar 04 15:47:41 2024 +0800
Revision:
10:c8165817d92a
Parent:
1:c0f972361605 
Support NuMaker-IoT-M467

Who changed what in which revision?

UserRevisionLine numberNew contents of line
csyang2 1:c0f972361605 1 /*********************************************************************
csyang2 1:c0f972361605 2 * SEGGER Software GmbH *
csyang2 1:c0f972361605 3 * Solutions for real time microcontroller applications *
csyang2 1:c0f972361605 4 **********************************************************************
csyang2 1:c0f972361605 5 * *
csyang2 1:c0f972361605 6 * (c) 1996 - 2018 SEGGER Microcontroller GmbH *
csyang2 1:c0f972361605 7 * *
csyang2 1:c0f972361605 8 * Internet: www.segger.com Support: support@segger.com *
csyang2 1:c0f972361605 9 * *
csyang2 1:c0f972361605 10 **********************************************************************
csyang2 1:c0f972361605 11
csyang2 1:c0f972361605 12 ** emWin V5.48 - Graphical user interface for embedded applications **
csyang2 1:c0f972361605 13 All Intellectual Property rights in the Software belongs to SEGGER.
csyang2 1:c0f972361605 14 emWin is protected by international copyright laws. Knowledge of the
csyang2 1:c0f972361605 15 source code may not be used to write a similar product. This file may
csyang2 1:c0f972361605 16 only be used in accordance with the following terms:
csyang2 1:c0f972361605 17
csyang2 1:c0f972361605 18 The software has been licensed by SEGGER Software GmbH to Nuvoton Technology Corporationat the address: No. 4, Creation Rd. III, Hsinchu Science Park, Taiwan
csyang2 1:c0f972361605 19 for the purposes of creating libraries for its
csyang2 1:c0f972361605 20 Arm Cortex-M and Arm9 32-bit microcontrollers, commercialized and distributed by Nuvoton Technology Corporation
csyang2 1:c0f972361605 21 under the terms and conditions of an End User
csyang2 1:c0f972361605 22 License Agreement supplied with the libraries.
csyang2 1:c0f972361605 23 Full source code is available at: www.segger.com
csyang2 1:c0f972361605 24
csyang2 1:c0f972361605 25 We appreciate your understanding and fairness.
csyang2 1:c0f972361605 26 ----------------------------------------------------------------------
csyang2 1:c0f972361605 27 Licensing information
csyang2 1:c0f972361605 28 Licensor: SEGGER Software GmbH
csyang2 1:c0f972361605 29 Licensed to: Nuvoton Technology Corporation, No. 4, Creation Rd. III, Hsinchu Science Park, 30077 Hsinchu City, Taiwan
csyang2 1:c0f972361605 30 Licensed SEGGER software: emWin
csyang2 1:c0f972361605 31 License number: GUI-00735
csyang2 1:c0f972361605 32 License model: emWin License Agreement, signed February 27, 2018
csyang2 1:c0f972361605 33 Licensed platform: Cortex-M and ARM9 32-bit series microcontroller designed and manufactured by or for Nuvoton Technology Corporation
csyang2 1:c0f972361605 34 ----------------------------------------------------------------------
csyang2 1:c0f972361605 35 Support and Update Agreement (SUA)
csyang2 1:c0f972361605 36 SUA period: 2018-03-26 - 2019-03-27
csyang2 1:c0f972361605 37 Contact to extend SUA: sales@segger.com
csyang2 1:c0f972361605 38 ----------------------------------------------------------------------
csyang2 1:c0f972361605 39 File : HEADER.h
csyang2 1:c0f972361605 40 Purpose : HEADER include
csyang2 1:c0f972361605 41 --------------------END-OF-HEADER-------------------------------------
csyang2 1:c0f972361605 42 */
csyang2 1:c0f972361605 43
csyang2 1:c0f972361605 44 #ifndef HEADER_H
csyang2 1:c0f972361605 45 #define HEADER_H
csyang2 1:c0f972361605 46
csyang2 1:c0f972361605 47 #include "WM.h"
csyang2 1:c0f972361605 48 #include "DIALOG_Intern.h" /* Req. for Create indirect data structure */
csyang2 1:c0f972361605 49 #include "WIDGET.h"
csyang2 1:c0f972361605 50
csyang2 1:c0f972361605 51 #if GUI_WINSUPPORT
csyang2 1:c0f972361605 52
csyang2 1:c0f972361605 53 #if defined(__cplusplus)
csyang2 1:c0f972361605 54 extern "C" { /* Make sure we have C-declarations in C++ programs */
csyang2 1:c0f972361605 55 #endif
csyang2 1:c0f972361605 56
csyang2 1:c0f972361605 57 /*********************************************************************
csyang2 1:c0f972361605 58 *
csyang2 1:c0f972361605 59 * Public Types
csyang2 1:c0f972361605 60 *
csyang2 1:c0f972361605 61 **********************************************************************
csyang2 1:c0f972361605 62 */
csyang2 1:c0f972361605 63
csyang2 1:c0f972361605 64 typedef WM_HMEM HEADER_Handle;
csyang2 1:c0f972361605 65
csyang2 1:c0f972361605 66 typedef struct {
csyang2 1:c0f972361605 67 GUI_COLOR aColorFrame[2];
csyang2 1:c0f972361605 68 GUI_COLOR aColorUpper[2];
csyang2 1:c0f972361605 69 GUI_COLOR aColorLower[2];
csyang2 1:c0f972361605 70 GUI_COLOR ColorArrow;
csyang2 1:c0f972361605 71 } HEADER_SKINFLEX_PROPS;
csyang2 1:c0f972361605 72
csyang2 1:c0f972361605 73 /*********************************************************************
csyang2 1:c0f972361605 74 *
csyang2 1:c0f972361605 75 * Create functions
csyang2 1:c0f972361605 76 *
csyang2 1:c0f972361605 77 **********************************************************************
csyang2 1:c0f972361605 78 */
csyang2 1:c0f972361605 79
csyang2 1:c0f972361605 80 HEADER_Handle HEADER_Create (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int Id, int Flags, int SpecialFlags);
csyang2 1:c0f972361605 81 HEADER_Handle HEADER_CreateAttached(WM_HWIN hParent, int Id, int SpecialFlags);
csyang2 1:c0f972361605 82 HEADER_Handle HEADER_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id);
csyang2 1:c0f972361605 83 HEADER_Handle HEADER_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int NumExtraBytes);
csyang2 1:c0f972361605 84 HEADER_Handle HEADER_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
csyang2 1:c0f972361605 85
csyang2 1:c0f972361605 86 /*********************************************************************
csyang2 1:c0f972361605 87 *
csyang2 1:c0f972361605 88 * The callback ...
csyang2 1:c0f972361605 89 *
csyang2 1:c0f972361605 90 * Do not call it directly ! It is only to be used from within an
csyang2 1:c0f972361605 91 * overwritten callback.
csyang2 1:c0f972361605 92 */
csyang2 1:c0f972361605 93 void HEADER_Callback(WM_MESSAGE * pMsg);
csyang2 1:c0f972361605 94
csyang2 1:c0f972361605 95 /*********************************************************************
csyang2 1:c0f972361605 96 *
csyang2 1:c0f972361605 97 * Managing default values
csyang2 1:c0f972361605 98 *
csyang2 1:c0f972361605 99 **********************************************************************
csyang2 1:c0f972361605 100 */
csyang2 1:c0f972361605 101 /* Set defaults */
csyang2 1:c0f972361605 102 GUI_COLOR HEADER_SetDefaultArrowColor(GUI_COLOR Color);
csyang2 1:c0f972361605 103 GUI_COLOR HEADER_SetDefaultBkColor (GUI_COLOR Color);
csyang2 1:c0f972361605 104 const GUI_CURSOR * HEADER_SetDefaultCursor (const GUI_CURSOR * pCursor);
csyang2 1:c0f972361605 105 const GUI_FONT * HEADER_SetDefaultFont (const GUI_FONT * pFont);
csyang2 1:c0f972361605 106 int HEADER_SetDefaultBorderH (int Spacing);
csyang2 1:c0f972361605 107 int HEADER_SetDefaultBorderV (int Spacing);
csyang2 1:c0f972361605 108 GUI_COLOR HEADER_SetDefaultTextColor (GUI_COLOR Color);
csyang2 1:c0f972361605 109
csyang2 1:c0f972361605 110 /* Get defaults */
csyang2 1:c0f972361605 111 GUI_COLOR HEADER_GetDefaultArrowColor(void);
csyang2 1:c0f972361605 112 GUI_COLOR HEADER_GetDefaultBkColor (void);
csyang2 1:c0f972361605 113 const GUI_CURSOR * HEADER_GetDefaultCursor (void);
csyang2 1:c0f972361605 114 const GUI_FONT * HEADER_GetDefaultFont (void);
csyang2 1:c0f972361605 115 int HEADER_GetDefaultBorderH (void);
csyang2 1:c0f972361605 116 int HEADER_GetDefaultBorderV (void);
csyang2 1:c0f972361605 117 GUI_COLOR HEADER_GetDefaultTextColor (void);
csyang2 1:c0f972361605 118
csyang2 1:c0f972361605 119 /*********************************************************************
csyang2 1:c0f972361605 120 *
csyang2 1:c0f972361605 121 * Member functions
csyang2 1:c0f972361605 122 *
csyang2 1:c0f972361605 123 **********************************************************************
csyang2 1:c0f972361605 124 */
csyang2 1:c0f972361605 125 void HEADER_AddItem (HEADER_Handle hObj, int Width, const char * s, int Align);
csyang2 1:c0f972361605 126 void HEADER_DeleteItem (HEADER_Handle hObj, unsigned Index);
csyang2 1:c0f972361605 127 GUI_COLOR HEADER_GetArrowColor (HEADER_Handle hObj);
csyang2 1:c0f972361605 128 GUI_COLOR HEADER_GetBkColor (HEADER_Handle hObj);
csyang2 1:c0f972361605 129 const GUI_FONT * HEADER_GetFont (HEADER_Handle hObj);
csyang2 1:c0f972361605 130 int HEADER_GetHeight (HEADER_Handle hObj);
csyang2 1:c0f972361605 131 int HEADER_GetItemText (HEADER_Handle hObj, unsigned Index, char * pBuffer, int MaxSize);
csyang2 1:c0f972361605 132 int HEADER_GetItemWidth (HEADER_Handle hObj, unsigned Index);
csyang2 1:c0f972361605 133 int HEADER_GetNumItems (HEADER_Handle hObj);
csyang2 1:c0f972361605 134 int HEADER_GetSel (HEADER_Handle hObj);
csyang2 1:c0f972361605 135 GUI_COLOR HEADER_GetTextColor (HEADER_Handle hObj);
csyang2 1:c0f972361605 136 int HEADER_GetUserData (HEADER_Handle hObj, void * pDest, int NumBytes);
csyang2 1:c0f972361605 137 void HEADER_SetArrowColor (HEADER_Handle hObj, GUI_COLOR Color);
csyang2 1:c0f972361605 138 void HEADER_SetBitmap (HEADER_Handle hObj, unsigned Index, const GUI_BITMAP * pBitmap);
csyang2 1:c0f972361605 139 void HEADER_SetBitmapEx (HEADER_Handle hObj, unsigned Index, const GUI_BITMAP * pBitmap, int x, int y);
csyang2 1:c0f972361605 140 void HEADER_SetBkColor (HEADER_Handle hObj, GUI_COLOR Color);
csyang2 1:c0f972361605 141 void HEADER_SetBMP (HEADER_Handle hObj, unsigned Index, const void * pBitmap);
csyang2 1:c0f972361605 142 void HEADER_SetBMPEx (HEADER_Handle hObj, unsigned Index, const void * pBitmap, int x, int y);
csyang2 1:c0f972361605 143 void HEADER_SetDirIndicator (HEADER_Handle hObj, int Column, int Reverse); /* !!!Not to be documented!!! */
csyang2 1:c0f972361605 144 void HEADER_SetDragLimit (HEADER_Handle hObj, unsigned DragLimit);
csyang2 1:c0f972361605 145 unsigned HEADER_SetFixed (HEADER_Handle hObj, unsigned Fixed);
csyang2 1:c0f972361605 146 void HEADER_SetFont (HEADER_Handle hObj, const GUI_FONT * pFont);
csyang2 1:c0f972361605 147 void HEADER_SetHeight (HEADER_Handle hObj, int Height);
csyang2 1:c0f972361605 148 void HEADER_SetTextAlign (HEADER_Handle hObj, unsigned Index, int Align);
csyang2 1:c0f972361605 149 void HEADER_SetItemText (HEADER_Handle hObj, unsigned Index, const char * s);
csyang2 1:c0f972361605 150 void HEADER_SetItemWidth (HEADER_Handle hObj, unsigned Index, int Width);
csyang2 1:c0f972361605 151 void HEADER_SetScrollPos (HEADER_Handle hObj, int ScrollPos);
csyang2 1:c0f972361605 152 void HEADER_SetStreamedBitmap (HEADER_Handle hObj, unsigned Index, const GUI_BITMAP_STREAM * pBitmap);
csyang2 1:c0f972361605 153 void HEADER_SetStreamedBitmapEx(HEADER_Handle hObj, unsigned Index, const GUI_BITMAP_STREAM * pBitmap, int x, int y);
csyang2 1:c0f972361605 154 void HEADER_SetTextColor (HEADER_Handle hObj, GUI_COLOR Color);
csyang2 1:c0f972361605 155 int HEADER_SetUserData (HEADER_Handle hObj, const void * pSrc, int NumBytes);
csyang2 1:c0f972361605 156
csyang2 1:c0f972361605 157 /*********************************************************************
csyang2 1:c0f972361605 158 *
csyang2 1:c0f972361605 159 * Member functions: Skinning
csyang2 1:c0f972361605 160 *
csyang2 1:c0f972361605 161 **********************************************************************
csyang2 1:c0f972361605 162 */
csyang2 1:c0f972361605 163 void HEADER_GetSkinFlexProps (HEADER_SKINFLEX_PROPS * pProps, int Index);
csyang2 1:c0f972361605 164 void HEADER_SetSkinClassic (HEADER_Handle hObj);
csyang2 1:c0f972361605 165 void HEADER_SetSkin (HEADER_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
csyang2 1:c0f972361605 166 int HEADER_DrawSkinFlex (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
csyang2 1:c0f972361605 167 void HEADER_SetSkinFlexProps (const HEADER_SKINFLEX_PROPS * pProps, int Index);
csyang2 1:c0f972361605 168 void HEADER_SetDefaultSkinClassic(void);
csyang2 1:c0f972361605 169 WIDGET_DRAW_ITEM_FUNC * HEADER_SetDefaultSkin(WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
csyang2 1:c0f972361605 170
csyang2 1:c0f972361605 171 #define HEADER_SKIN_FLEX HEADER_DrawSkinFlex
csyang2 1:c0f972361605 172
csyang2 1:c0f972361605 173 /*********************************************************************
csyang2 1:c0f972361605 174 *
csyang2 1:c0f972361605 175 * Macros for compatibility with older versions
csyang2 1:c0f972361605 176 *
csyang2 1:c0f972361605 177 **********************************************************************
csyang2 1:c0f972361605 178 */
csyang2 1:c0f972361605 179
csyang2 1:c0f972361605 180 #ifdef HEADER_SPACING_H
csyang2 1:c0f972361605 181 #define HEADER_BORDER_H_DEFAULT HEADER_SPACING_H
csyang2 1:c0f972361605 182 #endif
csyang2 1:c0f972361605 183 #ifdef HEADER_SPACING_V
csyang2 1:c0f972361605 184 #define HEADER_BORDER_V_DEFAULT HEADER_SPACING_V
csyang2 1:c0f972361605 185 #endif
csyang2 1:c0f972361605 186 #define HEADER_SetDefaultSpacingH(Value) HEADER_SetDefaultBorderH(Value)
csyang2 1:c0f972361605 187 #define HEADER_SetDefaultSpacingV(Value) HEADER_SetDefaultBorderV(Value)
csyang2 1:c0f972361605 188 #define HEADER_GetDefaultSpacingH() HEADER_GetDefaultBorderH()
csyang2 1:c0f972361605 189 #define HEADER_GetDefaultSpacingV() HEADER_GetDefaultBorderV()
csyang2 1:c0f972361605 190
csyang2 1:c0f972361605 191 #if defined(__cplusplus)
csyang2 1:c0f972361605 192 }
csyang2 1:c0f972361605 193 #endif
csyang2 1:c0f972361605 194
csyang2 1:c0f972361605 195 #endif // GUI_WINSUPPORT
csyang2 1:c0f972361605 196 #endif // HEADER_H
csyang2 1:c0f972361605 197
csyang2 1:c0f972361605 198 /*************************** End of file ****************************/