MCUXpresso_LPC55S69/middleware/emwin/emWin_header/GRAPH.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

239 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 : GRAPH.h
Purpose : GRAPH include
--------------------END-OF-HEADER-------------------------------------
*/
#ifndef GRAPH_H
#define GRAPH_H
#include "WM.h"
#include "DIALOG_Type.h" /* Req. for Create indirect data structure */
#include "WIDGET.h"
#if GUI_WINSUPPORT
#if defined(__cplusplus)
extern "C" { /* Make sure we have C-declarations in C++ programs */
#endif
/*********************************************************************
*
* Defines
*
**********************************************************************
*/
/*********************************************************************
*
* GRAPH color indexes
*
* Description
* Color indexes used by the GRAPH widget.
*/
#define GRAPH_CI_BK 0 // Background color.
#define GRAPH_CI_BORDER 1 // Color of the border area.
#define GRAPH_CI_FRAME 2 // Color of the thin frame line.
#define GRAPH_CI_GRID 3 // Color of the grid.
/*********************************************************************
*
* SCALE create flags
*
* Description
* Create flags used for scale objects.
*/
#define GRAPH_SCALE_CF_HORIZONTAL (0 << 0) // Creates a horizontal scale object.
#define GRAPH_SCALE_CF_VERTICAL (1 << 0) // Creates a vertical scale object.
/* status flags */
#define GRAPH_SCALE_SF_HORIZONTAL GRAPH_SCALE_CF_HORIZONTAL
#define GRAPH_SCALE_SF_VERTICAL GRAPH_SCALE_CF_VERTICAL
/*********************************************************************
*
* GRAPH user draw stages
*
* Description
* Stages sent to a user draw routine with the \a{Stage} parameter.
* For more information, refer to GRAPH_SetUserDraw().
*/
#define GRAPH_DRAW_FIRST 0 // Gives the application the possibility to perform drawing operations at the beginning of the drawing process.
#define GRAPH_DRAW_AFTER_BORDER 1 // Gives the application the possibility to perform drawing operations after the border was drawn.
#define GRAPH_DRAW_LAST 2 // Performs final drawing operations.
/*********************************************************************
*
* GRAPH alignment flags
*
* Description
* Flags that define the alignment of the date of a graph.
*/
#define GRAPH_ALIGN_RIGHT (0 << 0) // The data is aligned at the right edge (default).
#define GRAPH_ALIGN_LEFT (1 << 0) // The data is aligned at the left edge.
/*********************************************************************
*
* GRAPH create flags
*
* Description
* Create flags used for GRAPH objects.
*/
#define GRAPH_CF_GRID_FIXED_X (1 << 0) // This flag 'fixes' the grid in X-axis. That means if horizontal scrolling is used, the grid remains in its position.
#define GRAPH_CF_AVOID_SCROLLBAR_H (1 << 1) // Automatic use of a horizontal scrollbar is disabled. (Default).
#define GRAPH_CF_AVOID_SCROLLBAR_V (1 << 2) // Automatic use of a vertical scrollbar is disabled. (Default).
/* */
//
// Status flags
//
#define GRAPH_SF_AVOID_SCROLLBAR_H GRAPH_CF_AVOID_SCROLLBAR_H
#define GRAPH_SF_AVOID_SCROLLBAR_V GRAPH_CF_AVOID_SCROLLBAR_V
/*********************************************************************
*
* Public Types
*
**********************************************************************
*/
typedef WM_HMEM GRAPH_Handle;
typedef WM_HMEM GRAPH_DATA_Handle;
typedef WM_HMEM GRAPH_SCALE_Handle;
/*********************************************************************
*
* Create functions
*
**********************************************************************
*/
GRAPH_Handle GRAPH_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id);
GRAPH_Handle GRAPH_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int NumExtraBytes);
GRAPH_Handle GRAPH_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
GRAPH_DATA_Handle GRAPH_DATA_XY_Create(GUI_COLOR Color, unsigned MaxNumItems, const GUI_POINT * pData, unsigned NumItems);
GRAPH_DATA_Handle GRAPH_DATA_YT_Create(GUI_COLOR Color, unsigned MaxNumItems, const I16 * pData, unsigned NumItems);
GRAPH_SCALE_Handle GRAPH_SCALE_Create (int Pos, int TextAlign, unsigned Flags, unsigned TickDist);
/*********************************************************************
*
* The callback ...
*
* Do not call it directly ! It is only to be used from within an
* overwritten callback.
*/
void GRAPH_Callback(WM_MESSAGE * pMsg);
/*********************************************************************
*
* Member functions
*
**********************************************************************
*/
void GRAPH_AttachData (GRAPH_Handle hObj, GRAPH_DATA_Handle hData);
void GRAPH_AttachScale (GRAPH_Handle hObj, GRAPH_SCALE_Handle hScale);
void GRAPH_DetachData (GRAPH_Handle hObj, GRAPH_DATA_Handle hData);
void GRAPH_DetachScale (GRAPH_Handle hObj, GRAPH_SCALE_Handle hScale);
GUI_COLOR GRAPH_GetColor (GRAPH_Handle hObj, unsigned Index);
I32 GRAPH_GetScrollValue (GRAPH_Handle hObj, U8 Coord);
int GRAPH_GetUserData (GRAPH_Handle hObj, void * pDest, int NumBytes);
void GRAPH_InvertScrollbar (GRAPH_Handle hObj, U8 Coord);
void GRAPH_SetAutoScrollbar (GRAPH_Handle hObj, U8 Coord, U8 OnOff);
void GRAPH_SetBorder (GRAPH_Handle hObj, unsigned BorderL, unsigned BorderT, unsigned BorderR, unsigned BorderB);
GUI_COLOR GRAPH_SetColor (GRAPH_Handle hObj, GUI_COLOR Color, unsigned Index);
unsigned GRAPH_SetGridFixedX (GRAPH_Handle hObj, unsigned OnOff);
unsigned GRAPH_SetGridOffX (GRAPH_Handle hObj, unsigned Value);
unsigned GRAPH_SetGridOffY (GRAPH_Handle hObj, unsigned Value);
unsigned GRAPH_SetGridVis (GRAPH_Handle hObj, unsigned OnOff);
unsigned GRAPH_SetGridDistX (GRAPH_Handle hObj, unsigned Value);
unsigned GRAPH_SetGridDistY (GRAPH_Handle hObj, unsigned Value);
U8 GRAPH_SetLineStyleH (GRAPH_Handle hObj, U8 Value);
U8 GRAPH_SetLineStyleV (GRAPH_Handle hObj, U8 Value);
void GRAPH_SetLineStyle (GRAPH_Handle hObj, U8 Value);
void GRAPH_SetScrollValue (GRAPH_Handle hObj, U8 Coord, U32 Value);
unsigned GRAPH_SetVSizeX (GRAPH_Handle hObj, unsigned Value);
unsigned GRAPH_SetVSizeY (GRAPH_Handle hObj, unsigned Value);
int GRAPH_SetUserData (GRAPH_Handle hObj, const void * pSrc, int NumBytes);
void GRAPH_SetUserDraw (GRAPH_Handle hObj, void (* pOwnerDraw)(WM_HWIN, int));
void GRAPH_DATA_YT_AddValue (GRAPH_DATA_Handle hDataObj, I16 Value);
void GRAPH_DATA_YT_Clear (GRAPH_DATA_Handle hDataObj);
void GRAPH_DATA_YT_Delete (GRAPH_DATA_Handle hDataObj);
int GRAPH_DATA_YT_GetValue (GRAPH_DATA_Handle hDataObj, I16 * pValue, U32 Index);
void GRAPH_DATA_YT_SetAlign (GRAPH_DATA_Handle hDataObj, int Align);
GUI_COLOR GRAPH_DATA_YT_SetColor (GRAPH_DATA_Handle hDataObj, GUI_COLOR Color);
void GRAPH_DATA_YT_SetOffY (GRAPH_DATA_Handle hDataObj, int Off);
void GRAPH_DATA_YT_MirrorX (GRAPH_DATA_Handle hDataObj, int OnOff);
void GRAPH_DATA_XY_AddPoint (GRAPH_DATA_Handle hDataObj, GUI_POINT * pPoint);
void GRAPH_DATA_XY_Clear (GRAPH_DATA_Handle hDataObj);
void GRAPH_DATA_XY_Delete (GRAPH_DATA_Handle hDataObj);
unsigned GRAPH_DATA_XY_GetLineVis (GRAPH_DATA_Handle hDataObj);
int GRAPH_DATA_XY_GetPoint (GRAPH_DATA_Handle hDataObj, GUI_POINT * pPoint, U32 Index);
unsigned GRAPH_DATA_XY_GetPointVis (GRAPH_DATA_Handle hDataObj);
GUI_COLOR GRAPH_DATA_XY_SetColor (GRAPH_DATA_Handle hDataObj, GUI_COLOR Color);
void GRAPH_DATA_XY_SetLineStyle (GRAPH_DATA_Handle hDataObj, U8 LineStyle);
unsigned GRAPH_DATA_XY_SetLineVis (GRAPH_DATA_Handle hDataObj, unsigned OnOff);
void GRAPH_DATA_XY_SetOffX (GRAPH_DATA_Handle hDataObj, int Off);
void GRAPH_DATA_XY_SetOffY (GRAPH_DATA_Handle hDataObj, int Off);
void GRAPH_DATA_XY_SetPenSize (GRAPH_DATA_Handle hDataObj, U8 PenSize);
void GRAPH_DATA_XY_SetPointSize (GRAPH_DATA_Handle hDataObj, unsigned PointSize);
unsigned GRAPH_DATA_XY_SetPointVis (GRAPH_DATA_Handle hDataObj, unsigned OnOff);
void GRAPH_DATA_XY_SetOwnerDraw (GRAPH_DATA_Handle hDataObj, WIDGET_DRAW_ITEM_FUNC * pOwnerDraw);
void GRAPH_SCALE_Delete (GRAPH_SCALE_Handle hScaleObj);
float GRAPH_SCALE_SetFactor (GRAPH_SCALE_Handle hScaleObj, float Factor);
const GUI_FONT * GRAPH_SCALE_SetFont (GRAPH_SCALE_Handle hScaleObj, const GUI_FONT * pFont);
int GRAPH_SCALE_SetNumDecs (GRAPH_SCALE_Handle hScaleObj, int NumDecs);
int GRAPH_SCALE_SetOff (GRAPH_SCALE_Handle hScaleObj, int Off);
int GRAPH_SCALE_SetPos (GRAPH_SCALE_Handle hScaleObj, int Pos);
GUI_COLOR GRAPH_SCALE_SetTextColor(GRAPH_SCALE_Handle hScaleObj, GUI_COLOR Color);
unsigned GRAPH_SCALE_SetTickDist (GRAPH_SCALE_Handle hScaleObj, unsigned Value);
#if defined(__cplusplus)
}
#endif
#endif // GUI_WINSUPPORT
#endif // GRAPH_H
/*************************** End of file ****************************/