Nuvoton / Mbed OS NuMaker-mbed-emWin-example

NuMaker emWin HMI

emWin/Include/FRAMEWIN.h@10:c8165817d92a, 7 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 : FRAMEWIN.h
csyang2 1:c0f972361605 40 Purpose : Frame window include
csyang2 1:c0f972361605 41 --------------------END-OF-HEADER-------------------------------------
csyang2 1:c0f972361605 42 */
csyang2 1:c0f972361605 43
csyang2 1:c0f972361605 44 #ifndef FRAMEWIN_H
csyang2 1:c0f972361605 45 #define FRAMEWIN_H
csyang2 1:c0f972361605 46
csyang2 1:c0f972361605 47 #include "WM.h"
csyang2 1:c0f972361605 48 #include "WIDGET.h" /* Req. for WIDGET_DRAW_ITEM_FUNC */
csyang2 1:c0f972361605 49 #if GUI_WINSUPPORT
csyang2 1:c0f972361605 50 #include "DIALOG_Intern.h" /* Req. for Create indirect data structure */
csyang2 1:c0f972361605 51
csyang2 1:c0f972361605 52 #if defined(__cplusplus)
csyang2 1:c0f972361605 53 extern "C" { /* Make sure we have C-declarations in C++ programs */
csyang2 1:c0f972361605 54 #endif
csyang2 1:c0f972361605 55
csyang2 1:c0f972361605 56 /*********************************************************************
csyang2 1:c0f972361605 57 *
csyang2 1:c0f972361605 58 * Defines
csyang2 1:c0f972361605 59 *
csyang2 1:c0f972361605 60 **********************************************************************
csyang2 1:c0f972361605 61 */
csyang2 1:c0f972361605 62 /*********************************************************************
csyang2 1:c0f972361605 63 *
csyang2 1:c0f972361605 64 * Configuration
csyang2 1:c0f972361605 65 */
csyang2 1:c0f972361605 66 #ifndef FRAMEWIN_ALLOW_DRAG_ON_FRAME
csyang2 1:c0f972361605 67 #define FRAMEWIN_ALLOW_DRAG_ON_FRAME 1
csyang2 1:c0f972361605 68 #endif
csyang2 1:c0f972361605 69
csyang2 1:c0f972361605 70 /*********************************************************************
csyang2 1:c0f972361605 71 *
csyang2 1:c0f972361605 72 * Color indices
csyang2 1:c0f972361605 73 */
csyang2 1:c0f972361605 74 #define FRAMEWIN_CI_INACTIVE 0
csyang2 1:c0f972361605 75 #define FRAMEWIN_CI_ACTIVE 1
csyang2 1:c0f972361605 76
csyang2 1:c0f972361605 77 /*********************************************************************
csyang2 1:c0f972361605 78 *
csyang2 1:c0f972361605 79 * Create / Status flags
csyang2 1:c0f972361605 80 */
csyang2 1:c0f972361605 81 #define FRAMEWIN_CF_ACTIVE (1<<3)
csyang2 1:c0f972361605 82 #define FRAMEWIN_CF_MOVEABLE (1<<4)
csyang2 1:c0f972361605 83 #define FRAMEWIN_CF_TITLEVIS (1<<5)
csyang2 1:c0f972361605 84 #define FRAMEWIN_CF_MINIMIZED (1<<6)
csyang2 1:c0f972361605 85 #define FRAMEWIN_CF_MAXIMIZED (1<<7)
csyang2 1:c0f972361605 86 #define FRAMEWIN_CF_DRAGGING (1<<8)
csyang2 1:c0f972361605 87
csyang2 1:c0f972361605 88 #define FRAMEWIN_SF_ACTIVE FRAMEWIN_CF_ACTIVE
csyang2 1:c0f972361605 89 #define FRAMEWIN_SF_MOVEABLE FRAMEWIN_CF_MOVEABLE
csyang2 1:c0f972361605 90 #define FRAMEWIN_SF_TITLEVIS FRAMEWIN_CF_TITLEVIS
csyang2 1:c0f972361605 91 #define FRAMEWIN_SF_MINIMIZED FRAMEWIN_CF_MINIMIZED
csyang2 1:c0f972361605 92 #define FRAMEWIN_SF_MAXIMIZED FRAMEWIN_CF_MAXIMIZED
csyang2 1:c0f972361605 93 #define FRAMEWIN_SF_DRAGGING FRAMEWIN_CF_DRAGGING
csyang2 1:c0f972361605 94
csyang2 1:c0f972361605 95 /*********************************************************************
csyang2 1:c0f972361605 96 *
csyang2 1:c0f972361605 97 * BUTTON Flags
csyang2 1:c0f972361605 98 */
csyang2 1:c0f972361605 99 #define FRAMEWIN_BUTTON_RIGHT (1<<0)
csyang2 1:c0f972361605 100 #define FRAMEWIN_BUTTON_LEFT (1<<1)
csyang2 1:c0f972361605 101
csyang2 1:c0f972361605 102 /*********************************************************************
csyang2 1:c0f972361605 103 *
csyang2 1:c0f972361605 104 * Skinning property indices
csyang2 1:c0f972361605 105 */
csyang2 1:c0f972361605 106 #define FRAMEWIN_SKINFLEX_PI_ACTIVE 0
csyang2 1:c0f972361605 107 #define FRAMEWIN_SKINFLEX_PI_INACTIVE 1
csyang2 1:c0f972361605 108
csyang2 1:c0f972361605 109 /*********************************************************************
csyang2 1:c0f972361605 110 *
csyang2 1:c0f972361605 111 * Getting border size
csyang2 1:c0f972361605 112 */
csyang2 1:c0f972361605 113 #define FRAMEWIN_BORDERSIZE_T 0
csyang2 1:c0f972361605 114 #define FRAMEWIN_BORDERSIZE_L 1
csyang2 1:c0f972361605 115 #define FRAMEWIN_BORDERSIZE_B 2
csyang2 1:c0f972361605 116 #define FRAMEWIN_BORDERSIZE_R 3
csyang2 1:c0f972361605 117
csyang2 1:c0f972361605 118 /*********************************************************************
csyang2 1:c0f972361605 119 *
csyang2 1:c0f972361605 120 * Types
csyang2 1:c0f972361605 121 *
csyang2 1:c0f972361605 122 **********************************************************************
csyang2 1:c0f972361605 123 */
csyang2 1:c0f972361605 124 typedef WM_HMEM FRAMEWIN_Handle;
csyang2 1:c0f972361605 125
csyang2 1:c0f972361605 126 typedef struct {
csyang2 1:c0f972361605 127 GUI_COLOR aColorFrame[3];
csyang2 1:c0f972361605 128 GUI_COLOR aColorTitle[2];
csyang2 1:c0f972361605 129 int Radius;
csyang2 1:c0f972361605 130 int SpaceX;
csyang2 1:c0f972361605 131 int BorderSizeL;
csyang2 1:c0f972361605 132 int BorderSizeR;
csyang2 1:c0f972361605 133 int BorderSizeT;
csyang2 1:c0f972361605 134 int BorderSizeB;
csyang2 1:c0f972361605 135 } FRAMEWIN_SKINFLEX_PROPS;
csyang2 1:c0f972361605 136
csyang2 1:c0f972361605 137 /*********************************************************************
csyang2 1:c0f972361605 138 *
csyang2 1:c0f972361605 139 * Create functions
csyang2 1:c0f972361605 140 *
csyang2 1:c0f972361605 141 **********************************************************************
csyang2 1:c0f972361605 142 */
csyang2 1:c0f972361605 143 FRAMEWIN_Handle FRAMEWIN_Create (const char * pTitle, WM_CALLBACK * cb, int Flags, int x0, int y0, int xSize, int ySize);
csyang2 1:c0f972361605 144 FRAMEWIN_Handle FRAMEWIN_CreateAsChild (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, const char * pText, WM_CALLBACK * cb, int Flags);
csyang2 1:c0f972361605 145 FRAMEWIN_Handle FRAMEWIN_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, const char * pTitle, WM_CALLBACK * cb);
csyang2 1:c0f972361605 146 FRAMEWIN_Handle FRAMEWIN_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, const char * pTitle, WM_CALLBACK * cb, int NumExtraBytes);
csyang2 1:c0f972361605 147 FRAMEWIN_Handle FRAMEWIN_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
csyang2 1:c0f972361605 148
csyang2 1:c0f972361605 149 /*********************************************************************
csyang2 1:c0f972361605 150 *
csyang2 1:c0f972361605 151 * The callback ...
csyang2 1:c0f972361605 152 *
csyang2 1:c0f972361605 153 * Do not call it directly ! It is only to be used from within an
csyang2 1:c0f972361605 154 * overwritten callback.
csyang2 1:c0f972361605 155 */
csyang2 1:c0f972361605 156 void FRAMEWIN_Callback(WM_MESSAGE * pMsg);
csyang2 1:c0f972361605 157
csyang2 1:c0f972361605 158 /*********************************************************************
csyang2 1:c0f972361605 159 *
csyang2 1:c0f972361605 160 * Member functions: Set Properties
csyang2 1:c0f972361605 161 *
csyang2 1:c0f972361605 162 **********************************************************************
csyang2 1:c0f972361605 163 */
csyang2 1:c0f972361605 164 WM_HWIN FRAMEWIN_AddButton (FRAMEWIN_Handle hObj, int Flags, int Off, int Id);
csyang2 1:c0f972361605 165 WM_HWIN FRAMEWIN_AddCloseButton(FRAMEWIN_Handle hObj, int Flags, int Off);
csyang2 1:c0f972361605 166 WM_HWIN FRAMEWIN_AddMaxButton (FRAMEWIN_Handle hObj, int Flags, int Off);
csyang2 1:c0f972361605 167 void FRAMEWIN_AddMenu (FRAMEWIN_Handle hObj, WM_HWIN hMenu);
csyang2 1:c0f972361605 168 WM_HWIN FRAMEWIN_AddMinButton (FRAMEWIN_Handle hObj, int Flags, int Off);
csyang2 1:c0f972361605 169 void FRAMEWIN_Minimize (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 170 void FRAMEWIN_Maximize (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 171 void FRAMEWIN_Restore (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 172 void FRAMEWIN_SetActive (FRAMEWIN_Handle hObj, int State);
csyang2 1:c0f972361605 173 void FRAMEWIN_SetBarColor (FRAMEWIN_Handle hObj, unsigned Index, GUI_COLOR Color);
csyang2 1:c0f972361605 174 void FRAMEWIN_SetBorderSize (FRAMEWIN_Handle hObj, unsigned Size);
csyang2 1:c0f972361605 175 void FRAMEWIN_SetClientColor(FRAMEWIN_Handle hObj, GUI_COLOR Color);
csyang2 1:c0f972361605 176 void FRAMEWIN_SetFont (FRAMEWIN_Handle hObj, const GUI_FONT * pFont);
csyang2 1:c0f972361605 177 void FRAMEWIN_SetMoveable (FRAMEWIN_Handle hObj, int State);
csyang2 1:c0f972361605 178 void FRAMEWIN_SetOwnerDraw (FRAMEWIN_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawItem);
csyang2 1:c0f972361605 179 void FRAMEWIN_SetResizeable (FRAMEWIN_Handle hObj, int State);
csyang2 1:c0f972361605 180 void FRAMEWIN_SetText (FRAMEWIN_Handle hObj, const char* s);
csyang2 1:c0f972361605 181 void FRAMEWIN_SetTextAlign (FRAMEWIN_Handle hObj, int Align);
csyang2 1:c0f972361605 182 void FRAMEWIN_SetTextColor (FRAMEWIN_Handle hObj, GUI_COLOR Color);
csyang2 1:c0f972361605 183 void FRAMEWIN_SetTextColorEx(FRAMEWIN_Handle hObj, unsigned Index, GUI_COLOR Color);
csyang2 1:c0f972361605 184 void FRAMEWIN_SetTitleVis (FRAMEWIN_Handle hObj, int Show);
csyang2 1:c0f972361605 185 int FRAMEWIN_SetTitleHeight(FRAMEWIN_Handle hObj, int Height);
csyang2 1:c0f972361605 186 int FRAMEWIN_SetUserData (FRAMEWIN_Handle hObj, const void * pSrc, int NumBytes);
csyang2 1:c0f972361605 187
csyang2 1:c0f972361605 188 /*********************************************************************
csyang2 1:c0f972361605 189 *
csyang2 1:c0f972361605 190 * Member functions: Skinning
csyang2 1:c0f972361605 191 *
csyang2 1:c0f972361605 192 **********************************************************************
csyang2 1:c0f972361605 193 */
csyang2 1:c0f972361605 194 void FRAMEWIN_GetSkinFlexProps (FRAMEWIN_SKINFLEX_PROPS * pProps, int Index);
csyang2 1:c0f972361605 195 void FRAMEWIN_SetSkinClassic (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 196 void FRAMEWIN_SetSkin (FRAMEWIN_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
csyang2 1:c0f972361605 197 int FRAMEWIN_DrawSkinFlex (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
csyang2 1:c0f972361605 198 void FRAMEWIN_SetSkinFlexProps (const FRAMEWIN_SKINFLEX_PROPS * pProps, int Index);
csyang2 1:c0f972361605 199 void FRAMEWIN_SetDefaultSkinClassic(void);
csyang2 1:c0f972361605 200 WIDGET_DRAW_ITEM_FUNC * FRAMEWIN_SetDefaultSkin(WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
csyang2 1:c0f972361605 201
csyang2 1:c0f972361605 202 #define FRAMEWIN_SKIN_FLEX FRAMEWIN_DrawSkinFlex
csyang2 1:c0f972361605 203
csyang2 1:c0f972361605 204 /*********************************************************************
csyang2 1:c0f972361605 205 *
csyang2 1:c0f972361605 206 * Member functions: Get Properties
csyang2 1:c0f972361605 207 *
csyang2 1:c0f972361605 208 **********************************************************************
csyang2 1:c0f972361605 209 */
csyang2 1:c0f972361605 210 const GUI_FONT * FRAMEWIN_GetFont(FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 211
csyang2 1:c0f972361605 212 int FRAMEWIN_GetActive (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 213 int FRAMEWIN_GetTitleHeight (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 214 GUI_COLOR FRAMEWIN_GetBarColor (FRAMEWIN_Handle hObj, unsigned Index);
csyang2 1:c0f972361605 215 int FRAMEWIN_GetBorderSize (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 216 int FRAMEWIN_GetBorderSizeEx(FRAMEWIN_Handle hObj, unsigned Edge);
csyang2 1:c0f972361605 217 void FRAMEWIN_GetText (FRAMEWIN_Handle hObj, char * pBuffer, int MaxLen);
csyang2 1:c0f972361605 218 int FRAMEWIN_GetTextAlign (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 219 int FRAMEWIN_GetUserData (FRAMEWIN_Handle hObj, void * pDest, int NumBytes);
csyang2 1:c0f972361605 220 int FRAMEWIN_IsMinimized (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 221 int FRAMEWIN_IsMaximized (FRAMEWIN_Handle hObj);
csyang2 1:c0f972361605 222
csyang2 1:c0f972361605 223 /*********************************************************************
csyang2 1:c0f972361605 224 *
csyang2 1:c0f972361605 225 * Managing default values
csyang2 1:c0f972361605 226 *
csyang2 1:c0f972361605 227 **********************************************************************
csyang2 1:c0f972361605 228 */
csyang2 1:c0f972361605 229 GUI_COLOR FRAMEWIN_GetDefaultBarColor (unsigned Index);
csyang2 1:c0f972361605 230 int FRAMEWIN_GetDefaultBorderSize (void);
csyang2 1:c0f972361605 231 int FRAMEWIN_GetDefaultTitleHeight(void);
csyang2 1:c0f972361605 232 GUI_COLOR FRAMEWIN_GetDefaultClientColor(void);
csyang2 1:c0f972361605 233 const GUI_FONT * FRAMEWIN_GetDefaultFont (void);
csyang2 1:c0f972361605 234 GUI_COLOR FRAMEWIN_GetDefaultTextColor (unsigned Index);
csyang2 1:c0f972361605 235 int FRAMEWIN_OwnerDraw (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
csyang2 1:c0f972361605 236 void FRAMEWIN_SetDefaultBarColor (unsigned Index, GUI_COLOR Color);
csyang2 1:c0f972361605 237 void FRAMEWIN_SetDefaultBorderSize (int DefaultBorderSize);
csyang2 1:c0f972361605 238 void FRAMEWIN_SetDefaultTitleHeight(int DefaultTitleHeight);
csyang2 1:c0f972361605 239 void FRAMEWIN_SetDefaultClientColor(GUI_COLOR Color);
csyang2 1:c0f972361605 240 void FRAMEWIN_SetDefaultFont (const GUI_FONT * pFont);
csyang2 1:c0f972361605 241 int FRAMEWIN_SetDefaultTextAlign (int TextAlign);
csyang2 1:c0f972361605 242 void FRAMEWIN_SetDefaultTextColor (unsigned Index, GUI_COLOR Color);
csyang2 1:c0f972361605 243
csyang2 1:c0f972361605 244 /*********************************************************************
csyang2 1:c0f972361605 245 *
csyang2 1:c0f972361605 246 * Macros for compatibility
csyang2 1:c0f972361605 247 *
csyang2 1:c0f972361605 248 **********************************************************************
csyang2 1:c0f972361605 249 */
csyang2 1:c0f972361605 250 #define FRAMEWIN_SetDefaultCaptionSize(Height) FRAMEWIN_SetDefaultTitleHeight(Height)
csyang2 1:c0f972361605 251 #define FRAMEWIN_GetDefaultCaptionSize() FRAMEWIN_GetDefaultTitleHeight()
csyang2 1:c0f972361605 252 #define FRAMEWIN_CreateButton(hObj, Flags, Off, Id) FRAMEWIN_AddButton(hObj, Flags, Off, Id)
csyang2 1:c0f972361605 253 #define FRAMEWIN_CreateCloseButton(hObj, Flags, Off) FRAMEWIN_AddCloseButton(hObj, Flags, Off)
csyang2 1:c0f972361605 254 #define FRAMEWIN_CreateMaxButton(hObj, Flags, Off) FRAMEWIN_AddMaxButton(hObj, Flags, Off)
csyang2 1:c0f972361605 255 #define FRAMEWIN_CreateMinButton(hObj, Flags, Off) FRAMEWIN_AddMinButton(hObj, Flags, Off)
csyang2 1:c0f972361605 256
csyang2 1:c0f972361605 257 #if defined(__cplusplus)
csyang2 1:c0f972361605 258 }
csyang2 1:c0f972361605 259 #endif
csyang2 1:c0f972361605 260
csyang2 1:c0f972361605 261 #endif // GUI_WINSUPPORT
csyang2 1:c0f972361605 262 #endif // FRAMEWIN_H
csyang2 1:c0f972361605 263
csyang2 1:c0f972361605 264 /*************************** End of file ****************************/