Diff: STemWin/inclib/EDIT.h

Revision:

0:a53ccea9154d

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/STemWin/inclib/EDIT.h	Mon Jan 04 18:53:06 2016 +0000
@@ -0,0 +1,222 @@
+/*********************************************************************
+*                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.28 - 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        : EDIT.h
+Purpose     : EDIT include
+--------------------END-OF-HEADER-------------------------------------
+*/
+
+#ifndef EDIT_H
+#define EDIT_H
+
+#include "WM.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
+
+/*********************************************************************
+*
+*       Defaults for configuration switches
+*
+*  The following are defaults for config switches which affect the
+*  interface specified in this module
+*
+**********************************************************************
+*/
+/*********************************************************************
+*
+*       Defines
+*
+**********************************************************************
+*/
+/*********************************************************************
+*
+*       Create / Status flags
+*/
+#define EDIT_CF_LEFT    GUI_TA_LEFT
+#define EDIT_CF_RIGHT   GUI_TA_RIGHT
+#define EDIT_CF_HCENTER GUI_TA_HCENTER
+
+#define EDIT_CF_VCENTER GUI_TA_VCENTER
+#define EDIT_CF_TOP     GUI_TA_TOP
+#define EDIT_CF_BOTTOM  GUI_TA_BOTTOM
+
+/*********************************************************************
+*
+*       Color indices
+*/
+#define EDIT_CI_DISABLED 0
+#define EDIT_CI_ENABLED  1
+
+/*********************************************************************
+*
+*       Types
+*
+**********************************************************************
+*/
+typedef WM_HMEM EDIT_Handle;
+typedef void tEDIT_AddKeyEx    (EDIT_Handle hObj, int Key);
+typedef void tEDIT_UpdateBuffer(EDIT_Handle hObj);
+
+/*********************************************************************
+*
+*             Create functions
+*/
+EDIT_Handle EDIT_Create        (int x0, int y0, int xSize, int ySize, int Id, int MaxLen, int Flags);
+EDIT_Handle EDIT_CreateAsChild (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int Id, int Flags, int MaxLen);
+EDIT_Handle EDIT_CreateEx      (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int MaxLen);
+EDIT_Handle EDIT_CreateUser    (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int MaxLen, int NumExtraBytes);
+EDIT_Handle EDIT_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 EDIT_Callback(WM_MESSAGE * pMsg);
+
+/*********************************************************************
+*
+*             Standard member functions
+*/
+#define EDIT_EnableMemdev(hObj)  WM_EnableMemdev(hObj)
+#define EDIT_DisableMemdev(hObj) WM_DisableMemdev(hObj)
+#define EDIT_Delete(hObj)        WM_DeleteWindow(hObj)
+#define EDIT_Paint(hObj)         WM_Paint(hObj)
+#define EDIT_Invalidate(hObj)    WM_InvalidateWindow(hObj)
+
+/*********************************************************************
+*
+*             Individual member functions
+*/
+//
+// Methods changing preferences
+//
+void EDIT_SetDefaultBkColor  (unsigned int Index, GUI_COLOR Color);
+void EDIT_SetDefaultFont     (const GUI_FONT * pFont);
+void EDIT_SetDefaultTextAlign(int Align);
+void EDIT_SetDefaultTextColor(unsigned int Index, GUI_COLOR Color);
+//
+// Query preferences
+//
+GUI_COLOR        EDIT_GetDefaultBkColor(unsigned int Index);
+const GUI_FONT * EDIT_GetDefaultFont(void);
+int              EDIT_GetDefaultTextAlign(void);
+GUI_COLOR        EDIT_GetDefaultTextColor(unsigned int Index);
+//
+// Methods changing properties
+//
+void EDIT_AddKey           (EDIT_Handle hObj, int Key);
+void EDIT_EnableBlink      (EDIT_Handle hObj, int Period, int OnOff);
+GUI_COLOR EDIT_GetBkColor  (EDIT_Handle hObj, unsigned int Index);
+void EDIT_SetBkColor       (EDIT_Handle hObj, unsigned int Index, GUI_COLOR color);
+void EDIT_SetCursorAtChar  (EDIT_Handle hObj, int Pos);
+void EDIT_SetCursorAtPixel (EDIT_Handle hObj, int xPos);
+void EDIT_SetFocussable    (EDIT_Handle hObj, int State);
+void EDIT_SetFont          (EDIT_Handle hObj, const GUI_FONT * pFont);
+int  EDIT_SetInsertMode    (EDIT_Handle hObj, int OnOff);
+void EDIT_SetMaxLen        (EDIT_Handle hObj, int MaxLen);
+void EDIT_SetpfAddKeyEx    (EDIT_Handle hObj, tEDIT_AddKeyEx * pfAddKeyEx);
+void EDIT_SetpfUpdateBuffer(EDIT_Handle hObj, tEDIT_UpdateBuffer * pfUpdateBuffer);
+void EDIT_SetText          (EDIT_Handle hObj, const char * s);
+void EDIT_SetTextAlign     (EDIT_Handle hObj, int Align);
+GUI_COLOR EDIT_GetTextColor(EDIT_Handle hObj, unsigned int Index);
+void EDIT_SetTextColor     (EDIT_Handle hObj, unsigned int Index, GUI_COLOR Color);
+void EDIT_SetSel           (EDIT_Handle hObj, int FirstChar, int LastChar);
+int  EDIT_SetUserData      (EDIT_Handle hObj, const void * pSrc, int NumBytes);
+//
+// Get/Set user input
+//
+int   EDIT_GetCursorCharPos  (EDIT_Handle hObj);
+void  EDIT_GetCursorPixelPos (EDIT_Handle hObj, int * pxPos, int * pyPos);
+float EDIT_GetFloatValue     (EDIT_Handle hObj);
+const GUI_FONT * EDIT_GetFont(EDIT_Handle hObj);
+int   EDIT_GetNumChars       (EDIT_Handle hObj);
+void  EDIT_GetText           (EDIT_Handle hObj, char * sDest, int MaxLen);
+I32   EDIT_GetValue          (EDIT_Handle hObj);
+void  EDIT_SetFloatValue     (EDIT_Handle hObj, float Value);
+int   EDIT_GetUserData       (EDIT_Handle hObj, void * pDest, int NumBytes);
+void  EDIT_SetValue          (EDIT_Handle hObj, I32 Value);
+
+/*********************************************************************
+*
+*             Routines for editing values
+*
+**********************************************************************
+*/
+void  EDIT_SetHexMode  (EDIT_Handle hEdit, U32 Value, U32 Min, U32 Max);
+void  EDIT_SetBinMode  (EDIT_Handle hEdit, U32 Value, U32 Min, U32 Max);
+void  EDIT_SetDecMode  (EDIT_Handle hEdit, I32 Value, I32 Min, I32 Max, int Shift, U8 Flags);
+void  EDIT_SetFloatMode(EDIT_Handle hEdit, float Value, float Min, float Max, int Shift, U8 Flags);
+void  EDIT_SetTextMode (EDIT_Handle hEdit);
+void  EDIT_SetUlongMode(EDIT_Handle hEdit, U32 Value, U32 Min, U32 Max);
+
+U32   GUI_EditHex      (U32 Value, U32 Min, U32 Max, int Len, int xSize);
+U32   GUI_EditBin      (U32 Value, U32 Min, U32 Max, int Len, int xSize);
+I32   GUI_EditDec      (I32 Value, I32 Min, I32 Max, int Len, int xSize, int Shift, U8 Flags);
+float GUI_EditFloat    (float Value, float Min, float Max, int Len, int xSize, int Shift, U8 Flags);
+void  GUI_EditString   (char * pString, int Len, int xSize);
+
+/*********************************************************************
+*
+*             Flags
+*
+**********************************************************************
+*/
+//
+// Signed or normal mode
+//
+#define GUI_EDIT_NORMAL                  (0 << 0)
+#define GUI_EDIT_SIGNED                  (1 << 0)
+#define GUI_EDIT_SUPPRESS_LEADING_ZEROES (1 << 1)
+//
+// Edit modes
+//
+#define GUI_EDIT_MODE_INSERT    0
+#define GUI_EDIT_MODE_OVERWRITE 1
+//
+// Compatibility macros
+//
+#define EDIT_CI_DISABELD EDIT_CI_DISABLED
+#define EDIT_CI_ENABELD  EDIT_CI_ENABLED
+
+#if defined(__cplusplus)
+  }
+#endif
+
+#endif  // GUI_WINSUPPORT
+#endif  // EDIT_H
+
+/*************************** End of file ****************************/
+