280 lines
11 KiB
C
280 lines
11 KiB
C
/*********************************************************************
|
|
* Portions COPYRIGHT 2016 STMicroelectronics *
|
|
* Portions SEGGER Microcontroller GmbH & Co. KG *
|
|
* Solutions for real time microcontroller applications *
|
|
**********************************************************************
|
|
* *
|
|
* (c) 1996 - 2015 SEGGER Microcontroller GmbH & Co. KG *
|
|
* *
|
|
* Internet: www.segger.com Support: support@segger.com *
|
|
* *
|
|
**********************************************************************
|
|
|
|
** emWin V5.32 - 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 STMicroelectronics International
|
|
N.V. a Dutch company with a Swiss branch and its headquarters in Plan-
|
|
les-Ouates, Geneva, 39 Chemin du Champ des Filles, Switzerland for the
|
|
purposes of creating libraries for ARM Cortex-M-based 32-bit microcon_
|
|
troller products commercialized by Licensee only, sublicensed and dis_
|
|
tributed under the terms and conditions of the End User License Agree_
|
|
ment supplied by STMicroelectronics International N.V.
|
|
Full source code is available at: www.segger.com
|
|
|
|
We appreciate your understanding and fairness.
|
|
----------------------------------------------------------------------
|
|
File : MENU.h
|
|
Purpose : MENU include
|
|
--------------------END-OF-HEADER-------------------------------------
|
|
*/
|
|
|
|
/**
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
|
|
* You may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.st.com/software_license_agreement_liberty_v2
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
#ifndef MENU_H
|
|
#define MENU_H
|
|
|
|
#include "WM.h"
|
|
#include "WIDGET.h"
|
|
#include "DIALOG_Intern.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
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
#define MENU_SKIN_FLEX MENU_DrawSkinFlex
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Create flags
|
|
*/
|
|
#define MENU_CF_HORIZONTAL (0<<0)
|
|
#define MENU_CF_VERTICAL (1<<0)
|
|
#define MENU_CF_OPEN_ON_POINTEROVER (1<<1) // Normally a menu opens first when clicked on it
|
|
#define MENU_CF_CLOSE_ON_SECOND_CLICK (1<<2) // Normally a menu closes only when clicked outside it
|
|
#define MENU_CF_HIDE_DISABLED_SEL (1<<3) // Hides the selection when a disabled item is selected
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Menu item flags
|
|
*/
|
|
#define MENU_IF_DISABLED (1<<0) // Indicates that item is disabled
|
|
#define MENU_IF_SEPARATOR (1<<1) // Indicates that item is a separator
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Color indices
|
|
*/
|
|
#define MENU_CI_ENABLED 0
|
|
#define MENU_CI_SELECTED 1
|
|
#define MENU_CI_DISABLED 2
|
|
#define MENU_CI_DISABLED_SEL 3
|
|
#define MENU_CI_ACTIVE_SUBMENU 4
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Border indices
|
|
*/
|
|
#define MENU_BI_LEFT 0
|
|
#define MENU_BI_RIGHT 1
|
|
#define MENU_BI_TOP 2
|
|
#define MENU_BI_BOTTOM 3
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Message types
|
|
*/
|
|
#define MENU_ON_ITEMSELECT 0 // Send to owner when selecting a menu item
|
|
#define MENU_ON_INITMENU 1 // Send to owner when for the first time selecting a submenu
|
|
#define MENU_ON_INITSUBMENU 2 // Send to owner when selecting a submenu
|
|
#define MENU_ON_OPEN 3 // Internal message of menu widget (only send to submenus)
|
|
#define MENU_ON_CLOSE 4 // Internal message of menu widget (only send to submenus)
|
|
#define MENU_IS_MENU 5 // Internal message of menu widget. Owner must call
|
|
// WM_DefaultProc() when not handle the message
|
|
#define MENU_ON_ITEMACTIVATE 6 // Send to owner when highlighting a menu item
|
|
#define MENU_ON_ITEMPRESSED 7 // Send to owner when a menu item has been pressed
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Skinning property indices
|
|
*/
|
|
#define MENU_SKINFLEX_PI_ENABLED 0
|
|
#define MENU_SKINFLEX_PI_SELECTED 1
|
|
#define MENU_SKINFLEX_PI_DISABLED 2
|
|
#define MENU_SKINFLEX_PI_DISABLED_SEL 3
|
|
#define MENU_SKINFLEX_PI_ACTIVE_SUBMENU 4
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Types
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
|
|
typedef WM_HMEM MENU_Handle;
|
|
|
|
typedef struct {
|
|
//
|
|
// Background
|
|
//
|
|
GUI_COLOR aBkColorH[2];
|
|
GUI_COLOR BkColorV;
|
|
GUI_COLOR FrameColorH;
|
|
GUI_COLOR FrameColorV;
|
|
//
|
|
// Selection
|
|
//
|
|
GUI_COLOR aSelColorH[2];
|
|
GUI_COLOR aSelColorV[2];
|
|
GUI_COLOR FrameColorSelH;
|
|
GUI_COLOR FrameColorSelV;
|
|
//
|
|
// Separator
|
|
//
|
|
GUI_COLOR aSepColorH[2];
|
|
GUI_COLOR aSepColorV[2];
|
|
//
|
|
// Arrow
|
|
//
|
|
GUI_COLOR ArrowColor;
|
|
//
|
|
// Text
|
|
//
|
|
GUI_COLOR TextColor;
|
|
} MENU_SKINFLEX_PROPS;
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Menu message data
|
|
*/
|
|
typedef struct {
|
|
U16 MsgType;
|
|
U16 ItemId;
|
|
} MENU_MSG_DATA;
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Menu item data
|
|
*/
|
|
typedef struct {
|
|
const char * pText;
|
|
U16 Id;
|
|
U16 Flags;
|
|
MENU_Handle hSubmenu;
|
|
} MENU_ITEM_DATA;
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Create functions
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
MENU_Handle MENU_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
|
|
MENU_Handle MENU_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id);
|
|
MENU_Handle MENU_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int NumExtraBytes);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* The callback ...
|
|
*
|
|
* Do not call it directly ! It is only to be used from within an
|
|
* overwritten callback.
|
|
*/
|
|
void MENU_Callback(WM_MESSAGE * pMsg);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Individual member functions
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
void MENU_AddItem (MENU_Handle hObj, const MENU_ITEM_DATA * pItemData);
|
|
void MENU_Attach (MENU_Handle hObj, WM_HWIN hDestWin, int x, int y, int xSize, int ySize, int Flags);
|
|
void MENU_DeleteItem (MENU_Handle hObj, U16 ItemId);
|
|
void MENU_DisableItem (MENU_Handle hObj, U16 ItemId);
|
|
void MENU_EnableItem (MENU_Handle hObj, U16 ItemId);
|
|
void MENU_GetItem (MENU_Handle hObj, U16 ItemId, MENU_ITEM_DATA * pItemData);
|
|
void MENU_GetItemText (MENU_Handle hObj, U16 ItemId, char * pBuffer, unsigned BufferSize);
|
|
unsigned MENU_GetNumItems (MENU_Handle hObj);
|
|
WM_HWIN MENU_GetOwner (MENU_Handle hObj);
|
|
int MENU_GetUserData (MENU_Handle hObj, void * pDest, int NumBytes);
|
|
void MENU_InsertItem (MENU_Handle hObj, U16 ItemId, const MENU_ITEM_DATA * pItemData);
|
|
void MENU_Popup (MENU_Handle hObj, WM_HWIN hDestWin, int x, int y, int xSize, int ySize, int Flags);
|
|
void MENU_SetBkColor (MENU_Handle hObj, unsigned ColorIndex, GUI_COLOR Color);
|
|
void MENU_SetBorderSize(MENU_Handle hObj, unsigned BorderIndex, U8 BorderSize);
|
|
void MENU_SetFont (MENU_Handle hObj, const GUI_FONT * pFont);
|
|
void MENU_SetItem (MENU_Handle hObj, U16 ItemId, const MENU_ITEM_DATA * pItemData);
|
|
void MENU_SetOwner (MENU_Handle hObj, WM_HWIN hOwner);
|
|
int MENU_SetSel (MENU_Handle hObj, int Sel);
|
|
void MENU_SetTextColor (MENU_Handle hObj, unsigned ColorIndex, GUI_COLOR Color);
|
|
int MENU_SetUserData (MENU_Handle hObj, const void * pSrc, int NumBytes);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Managing default values
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
GUI_COLOR MENU_GetDefaultTextColor (unsigned ColorIndex);
|
|
GUI_COLOR MENU_GetDefaultBkColor (unsigned ColorIndex);
|
|
U8 MENU_GetDefaultBorderSize (unsigned BorderIndex);
|
|
const WIDGET_EFFECT * MENU_GetDefaultEffect (void);
|
|
const GUI_FONT * MENU_GetDefaultFont (void);
|
|
void MENU_SetDefaultTextColor (unsigned ColorIndex, GUI_COLOR Color);
|
|
void MENU_SetDefaultBkColor (unsigned ColorIndex, GUI_COLOR Color);
|
|
void MENU_SetDefaultBorderSize (unsigned BorderIndex, U8 BorderSize);
|
|
void MENU_SetDefaultEffect (const WIDGET_EFFECT * pEffect);
|
|
void MENU_SetDefaultFont (const GUI_FONT * pFont);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Member functions: Skinning
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
int MENU_DrawSkinFlex (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
|
|
void MENU_GetSkinFlexProps (MENU_SKINFLEX_PROPS * pProps, int Index);
|
|
WIDGET_DRAW_ITEM_FUNC * MENU_SetDefaultSkin (WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
|
|
void MENU_SetDefaultSkinClassic(void);
|
|
void MENU_SetSkinClassic (MENU_Handle hObj);
|
|
void MENU_SetSkin (MENU_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
|
|
void MENU_SetSkinFlexProps (const MENU_SKINFLEX_PROPS * pProps, int Index);
|
|
void MENU_SkinEnableArrow (MENU_Handle hObj, int OnOff);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif // GUI_WINSUPPORT
|
|
#endif // MENU_H
|
|
|
|
/*************************** End of file ****************************/
|