STM32F769IDiscovery  1.00
uDANTE Audio Networking with STM32F7 DISCO board
LISTWHEEL.h
Go to the documentation of this file.
1 /*********************************************************************
2 * SEGGER Microcontroller GmbH & Co. KG *
3 * Solutions for real time microcontroller applications *
4 **********************************************************************
5 * *
6 * (c) 1996 - 2015 SEGGER Microcontroller GmbH & Co. KG *
7 * *
8 * Internet: www.segger.com Support: support@segger.com *
9 * *
10 **********************************************************************
11 
12 ** emWin V5.28 - Graphical user interface for embedded applications **
13 All Intellectual Property rights in the Software belongs to SEGGER.
14 emWin is protected by international copyright laws. Knowledge of the
15 source code may not be used to write a similar product. This file may
16 only be used in accordance with the following terms:
17 
18 The software has been licensed to STMicroelectronics International
19 N.V. a Dutch company with a Swiss branch and its headquarters in Plan-
20 les-Ouates, Geneva, 39 Chemin du Champ des Filles, Switzerland for the
21 purposes of creating libraries for ARM Cortex-M-based 32-bit microcon_
22 troller products commercialized by Licensee only, sublicensed and dis_
23 tributed under the terms and conditions of the End User License Agree_
24 ment supplied by STMicroelectronics International N.V.
25 Full source code is available at: www.segger.com
26 
27 We appreciate your understanding and fairness.
28 ----------------------------------------------------------------------
29 File : LISTWHEEL.h
30 Purpose : LISTWHEEL widget include
31 --------------------END-OF-HEADER-------------------------------------
32 */
33 
34 #ifndef LISTWHEEL_H
35 #define LISTWHEEL_H
36 
37 #include "WM.h"
38 #include "DIALOG_Intern.h"
39 #include "WIDGET.h"
40 
41 #if GUI_WINSUPPORT
42 
43 #if defined(__cplusplus)
44  extern "C" { // Make sure we have C-declarations in C++ programs
45 #endif
46 
47 /*********************************************************************
48 *
49 * Defines
50 *
51 **********************************************************************
52 */
53 #define LISTWHEEL_CI_UNSEL 0
54 #define LISTWHEEL_CI_SEL 1
55 
56 /*********************************************************************
57 *
58 * Types
59 *
60 **********************************************************************
61 */
62 typedef WM_HMEM LISTWHEEL_Handle;
63 
64 /*********************************************************************
65 *
66 * Standard member functions
67 *
68 **********************************************************************
69 */
70 /*********************************************************************
71 *
72 * Create functions
73 *
74 **********************************************************************
75 */
76 LISTWHEEL_Handle LISTWHEEL_Create (const GUI_ConstString * ppText, int x0, int y0, int xSize, int ySize, int Flags);
77 LISTWHEEL_Handle LISTWHEEL_CreateAsChild (const GUI_ConstString * ppText, WM_HWIN hWinParent, int x0, int y0, int xSize, int ySize, int Flags);
78 LISTWHEEL_Handle LISTWHEEL_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
79 LISTWHEEL_Handle LISTWHEEL_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent,
80  int WinFlags, int ExFlags, int Id, const GUI_ConstString * ppText);
81 LISTWHEEL_Handle LISTWHEEL_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent,
82  int WinFlags, int ExFlags, int Id, const GUI_ConstString * ppText, int NumExtraBytes);
83 
84 /*********************************************************************
85 *
86 * The callback ...
87 *
88 * Do not call it directly ! It is only to be used from within an
89 * overwritten callback.
90 */
91 void LISTWHEEL_Callback(WM_MESSAGE * pMsg);
92 
93 /*********************************************************************
94 *
95 * Member functions
96 *
97 **********************************************************************
98 */
99 void LISTWHEEL_AddString (LISTWHEEL_Handle hObj, const char * s);
100 void * LISTWHEEL_GetItemData (LISTWHEEL_Handle hObj, unsigned Index); /* not to be documented */
101 void LISTWHEEL_GetItemText (LISTWHEEL_Handle hObj, unsigned Index, char * pBuffer, int MaxSize);
102 int LISTWHEEL_GetItemFromPos (LISTWHEEL_Handle hObj, int yPos);
103 int LISTWHEEL_GetLBorder (LISTWHEEL_Handle hObj);
104 unsigned LISTWHEEL_GetLineHeight (LISTWHEEL_Handle hObj);
105 int LISTWHEEL_GetNumItems (LISTWHEEL_Handle hObj);
106 int LISTWHEEL_GetPos (LISTWHEEL_Handle hObj);
107 int LISTWHEEL_GetRBorder (LISTWHEEL_Handle hObj);
108 int LISTWHEEL_GetSel (LISTWHEEL_Handle hObj);
109 int LISTWHEEL_GetSnapPosition(LISTWHEEL_Handle hObj);
110 int LISTWHEEL_GetTextAlign (LISTWHEEL_Handle hObj);
111 int LISTWHEEL_GetUserData (LISTWHEEL_Handle hObj, void * pDest, int NumBytes);
112 void LISTWHEEL_MoveToPos (LISTWHEEL_Handle hObj, unsigned int Index);
113 int LISTWHEEL_OwnerDraw (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
114 void LISTWHEEL_SetBkColor (LISTWHEEL_Handle hObj, unsigned int Index, GUI_COLOR Color);
115 void LISTWHEEL_SetDeceleration(LISTWHEEL_Handle hObj, unsigned Deceleration);
116 void LISTWHEEL_SetFont (LISTWHEEL_Handle hObj, const GUI_FONT * pFont);
117 void LISTWHEEL_SetItemData (LISTWHEEL_Handle hObj, unsigned Index, void * pData); /* not to be documented */
118 void LISTWHEEL_SetLBorder (LISTWHEEL_Handle hObj, unsigned BorderSize);
119 void LISTWHEEL_SetLineHeight (LISTWHEEL_Handle hObj, unsigned LineHeight);
120 void LISTWHEEL_SetOwnerDraw (LISTWHEEL_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfOwnerDraw);
121 void LISTWHEEL_SetPos (LISTWHEEL_Handle hObj, unsigned int Index);
122 void LISTWHEEL_SetRBorder (LISTWHEEL_Handle hObj, unsigned BorderSize);
123 void LISTWHEEL_SetSel (LISTWHEEL_Handle hObj, int Sel);
124 void LISTWHEEL_SetSnapPosition(LISTWHEEL_Handle hObj, int SnapPosition);
125 void LISTWHEEL_SetText (LISTWHEEL_Handle hObj, const GUI_ConstString * ppText);
126 void LISTWHEEL_SetTextAlign (LISTWHEEL_Handle hObj, int Align);
127 void LISTWHEEL_SetTextColor (LISTWHEEL_Handle hObj, unsigned int Index, GUI_COLOR Color);
128 void LISTWHEEL_SetTimerPeriod (LISTWHEEL_Handle hObj, GUI_TIMER_TIME TimerPeriod);
129 int LISTWHEEL_SetUserData (LISTWHEEL_Handle hObj, const void * pSrc, int NumBytes);
130 void LISTWHEEL_SetVelocity (LISTWHEEL_Handle hObj, int Velocity);
131 
132 const GUI_FONT * LISTWHEEL_GetFont(LISTWHEEL_Handle hObj);
133 
134 #if defined(__cplusplus)
135  }
136 #endif
137 
138 #endif // GUI_WINSUPPORT
139 #endif // LISTWHEEL_H
140 
141 /*************************** End of file ****************************/
LCD_COLOR GUI_COLOR
Definition: GUI_Type.h:50
const char * GUI_ConstString
Definition: GUI_Type.h:48
#define GUI_TIMER_TIME