Andrew Reed / Mbed OS CITY1082-i2c_master_wifi_mqtt
Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers LISTWHEEL.h Source File

LISTWHEEL.h

00001 /*********************************************************************
00002 *                SEGGER Microcontroller GmbH                         *
00003 *        Solutions for real time microcontroller applications        *
00004 **********************************************************************
00005 *                                                                    *
00006 *        (c) 1996 - 2018  SEGGER Microcontroller GmbH                *
00007 *                                                                    *
00008 *        Internet: www.segger.com    Support:  support@segger.com    *
00009 *                                                                    *
00010 **********************************************************************
00011 
00012 ** emWin V5.48 - Graphical user interface for embedded applications **
00013 All  Intellectual Property rights  in the Software belongs to  SEGGER.
00014 emWin is protected by  international copyright laws.  Knowledge of the
00015 source code may not be used to write a similar product.  This file may
00016 only be used in accordance with the following terms:
00017 
00018 The software  has been licensed to  Cypress Semiconductor Corporation,
00019 whose registered  office is situated  at 198 Champion Ct. San Jose, CA 
00020 95134 USA  solely for the  purposes of creating  libraries for Cypress
00021 PSoC3 and  PSoC5 processor-based devices,  sublicensed and distributed
00022 under  the  terms  and  conditions  of  the  Cypress  End User License
00023 Agreement.
00024 Full source code is available at: www.segger.com
00025 
00026 We appreciate your understanding and fairness.
00027 ----------------------------------------------------------------------
00028 Licensing information
00029 Licensor:                 SEGGER Microcontroller Systems LLC
00030 Licensed to:              Cypress Semiconductor Corp, 198 Champion Ct., San Jose, CA 95134, USA
00031 Licensed SEGGER software: emWin
00032 License number:           GUI-00319
00033 License model:            Services and License Agreement, signed June 10th, 2009
00034 Licensed platform:        Any Cypress platform (Initial targets are: PSoC3, PSoC5)
00035 ----------------------------------------------------------------------
00036 Support and Update Agreement (SUA)
00037 SUA period:               2009-06-12 - 2022-07-27
00038 Contact to extend SUA:    sales@segger.com
00039 ----------------------------------------------------------------------
00040 File        : LISTWHEEL.h
00041 Purpose     : LISTWHEEL widget include
00042 --------------------END-OF-HEADER-------------------------------------
00043 */
00044 
00045 #ifndef LISTWHEEL_H
00046 #define LISTWHEEL_H
00047 
00048 #include "WM.h"
00049 #include "DIALOG_Intern.h"
00050 #include "WIDGET.h"
00051 
00052 #if GUI_WINSUPPORT
00053 
00054 #if defined(__cplusplus)
00055   extern "C" {        // Make sure we have C-declarations in C++ programs
00056 #endif
00057 
00058 /*********************************************************************
00059 *
00060 *       Defines
00061 *
00062 **********************************************************************
00063 */
00064 #define LISTWHEEL_CI_UNSEL 0
00065 #define LISTWHEEL_CI_SEL   1
00066 
00067 /*********************************************************************
00068 *
00069 *       Types
00070 *
00071 **********************************************************************
00072 */
00073 typedef WM_HMEM LISTWHEEL_Handle;
00074 
00075 /*********************************************************************
00076 *
00077 *       Standard member functions
00078 *
00079 **********************************************************************
00080 */
00081 /*********************************************************************
00082 *
00083 *       Create functions
00084 *
00085 **********************************************************************
00086 */
00087 LISTWHEEL_Handle LISTWHEEL_Create        (const GUI_ConstString * ppText, int x0, int y0, int xSize, int ySize, int Flags);
00088 LISTWHEEL_Handle LISTWHEEL_CreateAsChild (const GUI_ConstString * ppText, WM_HWIN hWinParent, int x0, int y0, int xSize, int ySize, int Flags);
00089 LISTWHEEL_Handle LISTWHEEL_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
00090 LISTWHEEL_Handle LISTWHEEL_CreateEx      (int x0, int y0, int xSize, int ySize, WM_HWIN hParent,
00091                                           int WinFlags, int ExFlags, int Id, const GUI_ConstString * ppText);
00092 LISTWHEEL_Handle LISTWHEEL_CreateUser    (int x0, int y0, int xSize, int ySize, WM_HWIN hParent,
00093                                           int WinFlags, int ExFlags, int Id, const GUI_ConstString * ppText, int NumExtraBytes);
00094 
00095 /*********************************************************************
00096 *
00097 *       The callback ...
00098 *
00099 * Do not call it directly ! It is only to be used from within an
00100 * overwritten callback.
00101 */
00102 void LISTWHEEL_Callback(WM_MESSAGE * pMsg);
00103 
00104 /*********************************************************************
00105 *
00106 *       Member functions
00107 *
00108 **********************************************************************
00109 */
00110 void      LISTWHEEL_AddString      (LISTWHEEL_Handle hObj, const char * s);
00111 GUI_COLOR LISTWHEEL_GetBkColor     (LISTWHEEL_Handle hObj, unsigned int Index);
00112 void *    LISTWHEEL_GetItemData    (LISTWHEEL_Handle hObj, unsigned Index); /* not to be documented */
00113 void      LISTWHEEL_GetItemText    (LISTWHEEL_Handle hObj, unsigned Index, char * pBuffer, int MaxSize);
00114 int       LISTWHEEL_GetItemFromPos (LISTWHEEL_Handle hObj, int yPos);
00115 int       LISTWHEEL_GetLBorder     (LISTWHEEL_Handle hObj);
00116 unsigned  LISTWHEEL_GetLineHeight  (LISTWHEEL_Handle hObj);
00117 int       LISTWHEEL_GetNumItems    (LISTWHEEL_Handle hObj);
00118 int       LISTWHEEL_GetPos         (LISTWHEEL_Handle hObj);
00119 int       LISTWHEEL_GetRBorder     (LISTWHEEL_Handle hObj);
00120 int       LISTWHEEL_GetSel         (LISTWHEEL_Handle hObj);
00121 int       LISTWHEEL_GetSnapPosition(LISTWHEEL_Handle hObj);
00122 int       LISTWHEEL_GetTextAlign   (LISTWHEEL_Handle hObj);
00123 GUI_COLOR LISTWHEEL_GetTextColor   (LISTWHEEL_Handle hObj, unsigned int Index);
00124 int       LISTWHEEL_GetUserData    (LISTWHEEL_Handle hObj, void * pDest, int NumBytes);
00125 int       LISTWHEEL_IsMoving       (LISTWHEEL_Handle hObj);
00126 void      LISTWHEEL_MoveToPos      (LISTWHEEL_Handle hObj, unsigned int Index);
00127 int       LISTWHEEL_OwnerDraw      (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
00128 void      LISTWHEEL_SetBkColor     (LISTWHEEL_Handle hObj, unsigned int Index, GUI_COLOR Color);
00129 void      LISTWHEEL_SetDeceleration(LISTWHEEL_Handle hObj, unsigned Deceleration);
00130 void      LISTWHEEL_SetFont        (LISTWHEEL_Handle hObj, const GUI_FONT * pFont);
00131 void      LISTWHEEL_SetItemData    (LISTWHEEL_Handle hObj, unsigned Index, void * pData); /* not to be documented */
00132 void      LISTWHEEL_SetLBorder     (LISTWHEEL_Handle hObj, unsigned BorderSize);
00133 void      LISTWHEEL_SetLineHeight  (LISTWHEEL_Handle hObj, unsigned LineHeight);
00134 void      LISTWHEEL_SetOwnerDraw   (LISTWHEEL_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfOwnerDraw);
00135 void      LISTWHEEL_SetPos         (LISTWHEEL_Handle hObj, unsigned int Index);
00136 void      LISTWHEEL_SetRBorder     (LISTWHEEL_Handle hObj, unsigned BorderSize);
00137 void      LISTWHEEL_SetSel         (LISTWHEEL_Handle hObj, int Sel);
00138 void      LISTWHEEL_SetSnapPosition(LISTWHEEL_Handle hObj, int SnapPosition);
00139 void      LISTWHEEL_SetText        (LISTWHEEL_Handle hObj, const GUI_ConstString * ppText);
00140 void      LISTWHEEL_SetTextAlign   (LISTWHEEL_Handle hObj, int Align);
00141 void      LISTWHEEL_SetTextColor   (LISTWHEEL_Handle hObj, unsigned int Index, GUI_COLOR Color);
00142 void      LISTWHEEL_SetTimerPeriod (LISTWHEEL_Handle hObj, GUI_TIMER_TIME TimerPeriod);
00143 int       LISTWHEEL_SetUserData    (LISTWHEEL_Handle hObj, const void * pSrc, int NumBytes);
00144 void      LISTWHEEL_SetVelocity    (LISTWHEEL_Handle hObj, int Velocity);
00145 
00146 const GUI_FONT * LISTWHEEL_GetFont(LISTWHEEL_Handle hObj);
00147 
00148 #if defined(__cplusplus)
00149   }
00150 #endif
00151 
00152 #endif  // GUI_WINSUPPORT
00153 #endif  // LISTWHEEL_H
00154 
00155 /*************************** End of file ****************************/