blob: 5b0cea8565c04f978af2ad12f1ff3d824bcc4b7a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/**
* @file src/gwin/gwin_textedit.h
* @brief GWIN textedit widget header file
*
* @defgroup TextEdit TextEdit
* @ingroup Widgets
*
* @details A GWIN TextEdit widget allows user input.
*
* @pre GFX_USE_GDISP must be set to TRUE in your gfxconf.h
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GDISP_NEED_TEXT must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_TEXTEDIT must be set to TRUE in your gfxconf.h
* @pre The fonts you want to use must be enabled in your gfxconf.h
*
* @{
*/
#ifndef _GWIN_TEXTEDIT_H
#define _GWIN_TEXTEDIT_H
// This file is included within "src/gwin/gwin_widget.h"
// A TextEdit widget
typedef struct GTexteditObject {
GWidgetObject w;
char* textBuffer;
size_t bufferSize;
uint16_t cursorPos;
} GTexteditObject;
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Create a TextEdit widget
* @details A TextEdit widget is a rectangular box which allows the user to input data through a keyboard.
* The keyboard can either be a physical one or a virtual on-screen keyboard as the keyboard driver
* is abstracted through the GINPUT module.
*
* @param[in] g The GDisplay on which the textedit should be displayed
* @param[in] widget The TextEdit structure to initialise. If this is NULL, the structure is dynamically allocated.
* @param[in] pInit The initialisation parameters to use.
* @param[in] bufSize The maximum number of characters the TextEdit widget can hold.
*
* @return NULL if there is no resultat drawing area, otherwise the widget handle.
*
* @api
*/
GHandle gwinGTexteditCreate(GDisplay* g, GTexteditObject* widget, GWidgetInit* pInit, size_t bufSize);
#define gwinTexteditCreate(w, pInit, bufSize) gwinGTexteditCreate(GDISP, w, pInit, bufSize)
/**
* @brief Border settings for the default rendering routine
*
* @note Border is enabled by default.
*
* @param[in] gh The widget handle (must be a TextEdit handle)
* @param[in] border Shall a border be rendered?
*
* @api
*/
void gwinTexteditSetBorder(GHandle gh, bool_t border);
#ifdef __cplusplus
}
#endif
#endif // _GWIN_TEXTEDIT_H
/** @} */
|
