MCUXpresso_LPC55S69/middleware/emwin/emWin_header/MULTIPAGE.h
Yilin Sun 6e8d03ec0a Updated to SDK v2.15.000
Signed-off-by: Yilin Sun <imi415@imi.moe>
2024-04-12 21:21:49 +08:00

250 lines
12 KiB
C

/*********************************************************************
* SEGGER Microcontroller GmbH *
* Solutions for real time microcontroller applications *
**********************************************************************
* *
* (c) 1996 - 2023 SEGGER Microcontroller GmbH *
* *
* Internet: www.segger.com Support: support@segger.com *
* *
**********************************************************************
** emWin V6.34 - Graphical user interface for embedded applications **
All Intellectual Property rights in the Software belongs to SEGGER.
emWin is protected by international copyright laws. Knowledge of the
source code may not be used to write a similar product. This file may
only be used in accordance with the following terms:
The software has been licensed to NXP Semiconductors USA, Inc. whose
registered office is situated at 411 E. Plumeria Drive, San Jose,
CA 95134, USA solely for the purposes of creating libraries for
NXPs M0, M3/M4 and ARM7/9 processor-based devices, sublicensed and
distributed under the terms and conditions of the NXP End User License
Agreement.
Full source code is available at: www.segger.com
We appreciate your understanding and fairness.
----------------------------------------------------------------------
Licensing information
Licensor: SEGGER Microcontroller Systems LLC
Licensed to: NXP Semiconductors, 1109 McKay Dr, M/S 76, San Jose, CA 95131, USA
Licensed SEGGER software: emWin
License number: GUI-00186
License model: emWin License Agreement, dated August 20th 2011 and Amendment No. 1, dated October 17th 2017 and Amendment No. 2, dated December 18th 2018
Licensed platform: NXP's ARM 7/9, Cortex-M0, M3, M4, M7, A7, M33
----------------------------------------------------------------------
Support and Update Agreement (SUA)
SUA period: 2011-08-19 - 2024-09-02
Contact to extend SUA: sales@segger.com
----------------------------------------------------------------------
File : MULTIPAGE.h
Purpose : MULTIPAGE include
--------------------END-OF-HEADER-------------------------------------
*/
#ifndef MULTIPAGE_H
#define MULTIPAGE_H
#include "WM.h"
#include "DIALOG.h" // Required for Create indirect data structure
#if GUI_WINSUPPORT
#if defined(__cplusplus)
extern "C" { // Make sure we have C-declarations in C++ programs
#endif
/*********************************************************************
*
* Defines
*
**********************************************************************
*/
/*********************************************************************
*
* MULTIPAGE alignment flags
*
* Description
* These flags are used by MULTIPAGE_SetAlign() and define the tab alignment
* of a MULTIPAGE widget. Horizontal and vertical flags are OR-combinable.
*/
#define MULTIPAGE_ALIGN_LEFT (0 << 0) // Aligns the tabs at the left side.
#define MULTIPAGE_ALIGN_RIGHT (1 << 0) // Aligns the tabs at the right side.
#define MULTIPAGE_ALIGN_TOP (0 << 2) // Aligns the tabs at the top of the widget.
#define MULTIPAGE_ALIGN_BOTTOM (1 << 2) // Aligns the tabs at the bottom of the widget.
/*********************************************************************
*
* MULTIPAGE color indexes
*
* Description
* Color indexes used by the MULTIPAGE widget.
*/
#define MULTIPAGE_CI_DISABLED 0 // Color for disabled pages.
#define MULTIPAGE_CI_ENABLED 1 // Color for enabled pages.
/*********************************************************************
*
* Create / Status flags
*/
#define MULTIPAGE_CF_ROTATE_CW WIDGET_CF_VERTICAL
#define MULTIPAGE_SKIN_FRAME_LEFT (1 << 0)
#define MULTIPAGE_SKIN_FRAME_RIGHT (1 << 1)
#define MULTIPAGE_SKIN_FRAME_TOP (1 << 2)
#define MULTIPAGE_SKIN_FRAME_BOTTOM (1 << 3)
#define MULTIPAGE_SKIN_FRAME_ALL (MULTIPAGE_SKIN_FRAME_LEFT | MULTIPAGE_SKIN_FRAME_RIGHT | MULTIPAGE_SKIN_FRAME_TOP | MULTIPAGE_SKIN_FRAME_BOTTOM)
#define MULTIPAGE_SKINFLEX_PI_ENABLED 0
#define MULTIPAGE_SKINFLEX_PI_SELECTED 1
#define MULTIPAGE_SKINFLEX_PI_DISABLED 2
#define SCROLLBAR_SIZE 32 // Defines the space for the scrollbar arrows
/*********************************************************************
*
* MULTIPAGE bitmap indexes
*/
#define MULTIPAGE_BI_SELECTED 0 // Selected state.
#define MULTIPAGE_BI_UNSELECTED 1 // Unselected state.
#define MULTIPAGE_BI_DISABLED 2 // Disabled state.
#define MULTIPAGE_BI_MAX 3 // The defines above are used as array indices.
/*********************************************************************
*
* Public Types
*
**********************************************************************
*/
typedef WM_HMEM MULTIPAGE_Handle;
typedef struct {
GUI_COLOR BkColor;
GUI_COLOR aBkUpper[2];
GUI_COLOR aBkLower[2];
GUI_COLOR FrameColor;
GUI_COLOR TextColor;
} MULTIPAGE_SKINFLEX_PROPS;
typedef struct {
U8 SelSideBorderInc; // Number of pixels to add on both sides when drawing the selected item.
U8 SelTopBorderInc; // Number of pixels to add on top of selected items.
} MULTIPAGE_SKIN_PROPS;
typedef struct {
#if GUI_SUPPORT_ROTATION
GUI_ROTATION * pRotation;
#endif
unsigned Align;
int Sel;
U16 State;
U8 FrameFlags; // Flags to let the drawing function know which parts of the frame to display.
U8 PageStatus;
GUI_DRAW_HANDLE * pDrawObj;
} MULTIPAGE_SKIN_INFO;
/*********************************************************************
*
* Create functions
*
**********************************************************************
*/
MULTIPAGE_Handle MULTIPAGE_Create (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int Id, int Flags, int SpecialFlags);
MULTIPAGE_Handle MULTIPAGE_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id);
MULTIPAGE_Handle MULTIPAGE_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int NumExtraBytes);
MULTIPAGE_Handle MULTIPAGE_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
/*********************************************************************
*
* The callback ...
*
* Do not call it directly ! It is only to be used from within an
* overwritten callback.
*/
void MULTIPAGE_Callback(WM_MESSAGE * pMsg);
/*********************************************************************
*
* Member functions
*
**********************************************************************
*/
void MULTIPAGE_AddEmptyPage (MULTIPAGE_Handle hObj, WM_HWIN hWin ,const char * pText);
void MULTIPAGE_AddPage (MULTIPAGE_Handle hObj, WM_HWIN hWin ,const char * pText);
WM_HWIN MULTIPAGE_AttachWindow (MULTIPAGE_Handle hObj, unsigned Index, WM_HWIN hWin);
void MULTIPAGE_DeletePage (MULTIPAGE_Handle hObj, unsigned Index, int Delete);
void MULTIPAGE_DisablePage (MULTIPAGE_Handle hObj, unsigned Index);
void MULTIPAGE_EnablePage (MULTIPAGE_Handle hObj, unsigned Index);
void MULTIPAGE_EnableScrollbar(MULTIPAGE_Handle hObj, unsigned OnOff);
GUI_COLOR MULTIPAGE_GetBkColor (MULTIPAGE_Handle hObj, unsigned Index);
const GUI_FONT * MULTIPAGE_GetFont (MULTIPAGE_Handle hObj);
int MULTIPAGE_GetNumTabs (MULTIPAGE_Handle hObj);
int MULTIPAGE_GetSelection (MULTIPAGE_Handle hObj);
int MULTIPAGE_GetPageText (MULTIPAGE_Handle hObj, unsigned Index, char * pBuffer, int MaxLen);
int MULTIPAGE_GetTabHeight (MULTIPAGE_Handle hObj);
int MULTIPAGE_GetTabWidth (MULTIPAGE_Handle hObj, int Index);
GUI_COLOR MULTIPAGE_GetTextColor (MULTIPAGE_Handle hObj, unsigned Index);
int MULTIPAGE_GetUserData (MULTIPAGE_Handle hObj, void * pDest, int NumBytes);
WM_HWIN MULTIPAGE_GetWindow (MULTIPAGE_Handle hObj, unsigned Index);
int MULTIPAGE_IsPageEnabled (MULTIPAGE_Handle hObj, unsigned Index);
void MULTIPAGE_SelectPage (MULTIPAGE_Handle hObj, unsigned Index);
void MULTIPAGE_SetAlign (MULTIPAGE_Handle hObj, unsigned Align);
int MULTIPAGE_SetBitmapEx (MULTIPAGE_Handle hObj, const GUI_BITMAP * pBitmap, int x, int y, int Index, int State);
int MULTIPAGE_SetBitmap (MULTIPAGE_Handle hObj, const GUI_BITMAP * pBitmap, int Index, int State);
void MULTIPAGE_SetBkColor (MULTIPAGE_Handle hObj, GUI_COLOR Color, unsigned Index);
void MULTIPAGE_SetFont (MULTIPAGE_Handle hObj, const GUI_FONT * pFont);
void MULTIPAGE_SetRotation (MULTIPAGE_Handle hObj, unsigned Rotation);
void MULTIPAGE_SetTabWidth (MULTIPAGE_Handle hObj, int Width, int Index);
void MULTIPAGE_SetTabHeight (MULTIPAGE_Handle hObj, int Height);
void MULTIPAGE_SetTextAlign (MULTIPAGE_Handle hObj, unsigned Align);
void MULTIPAGE_SetText (MULTIPAGE_Handle hObj, const char * pText, unsigned Index);
void MULTIPAGE_SetTextColor (MULTIPAGE_Handle hObj, GUI_COLOR Color, unsigned Index);
int MULTIPAGE_SetUserData (MULTIPAGE_Handle hObj, const void * pSrc, int NumBytes);
/*********************************************************************
*
* Managing default values
*
**********************************************************************
*/
unsigned MULTIPAGE_GetDefaultAlign (void);
GUI_COLOR MULTIPAGE_GetDefaultBkColor (unsigned Index);
const GUI_FONT * MULTIPAGE_GetDefaultFont (void);
GUI_COLOR MULTIPAGE_GetDefaultTextColor (unsigned Index);
void MULTIPAGE_SetDefaultAlign (unsigned Align);
void MULTIPAGE_SetDefaultBkColor (GUI_COLOR Color, unsigned Index);
void MULTIPAGE_SetDefaultBorderSizeX(unsigned Size);
void MULTIPAGE_SetDefaultBorderSizeY(unsigned Size);
void MULTIPAGE_SetDefaultFont (const GUI_FONT * pFont);
void MULTIPAGE_SetDefaultTextColor (GUI_COLOR Color, unsigned Index);
void MULTIPAGE_SetEffectColor (unsigned Index, GUI_COLOR Color);
GUI_COLOR MULTIPAGE_GetEffectColor (unsigned Index);
int MULTIPAGE_GetNumEffectColors (void);
/*********************************************************************
*
* Member functions: Skinning
*
**********************************************************************
*/
int MULTIPAGE_DrawSkinFlex (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
void MULTIPAGE_GetSkinFlexProps (MULTIPAGE_SKINFLEX_PROPS * pProps, int Index);
WIDGET_DRAW_ITEM_FUNC * MULTIPAGE_SetDefaultSkin (WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
void MULTIPAGE_SetDefaultSkinClassic(void);
void MULTIPAGE_SetSkinClassic (MULTIPAGE_Handle hObj);
void MULTIPAGE_SetSkin (MULTIPAGE_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
void MULTIPAGE_SetSkinFlexProps (const MULTIPAGE_SKINFLEX_PROPS * pProps, int Index);
#define MULTIPAGE_SKIN_FLEX MULTIPAGE_DrawSkinFlex
#if defined(__cplusplus)
}
#endif
#endif // GUI_WINSUPPORT
#endif // MULTIPAGE_H
/*************************** End of file ****************************/