aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin/gwin_textedit.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2017-08-26 11:15:56 +1000
committerinmarket <andrewh@inmarket.com.au>2017-08-26 11:15:56 +1000
commit0388755df1e3d65aa6d17f90965bcf5037c204ab (patch)
tree93aacdd84eed6b046631dff5ebd968430cbcc4d3 /src/gwin/gwin_textedit.h
parent04c23b408da0f1f4bc5aa7978be7aeb77f1cdd5d (diff)
downloaduGFX-0388755df1e3d65aa6d17f90965bcf5037c204ab.tar.gz
uGFX-0388755df1e3d65aa6d17f90965bcf5037c204ab.tar.bz2
uGFX-0388755df1e3d65aa6d17f90965bcf5037c204ab.zip
Add gwinTextEditSendKey() and gwinTextEditSendSpecialKey()
Diffstat (limited to 'src/gwin/gwin_textedit.h')
-rw-r--r--src/gwin/gwin_textedit.h26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/gwin/gwin_textedit.h b/src/gwin/gwin_textedit.h
index ed2f634d..8cf6c03e 100644
--- a/src/gwin/gwin_textedit.h
+++ b/src/gwin/gwin_textedit.h
@@ -64,6 +64,32 @@ GHandle gwinGTexteditCreate(GDisplay* g, GTexteditObject* wt, GWidgetInit* pInit
#define gwinTexteditCreate(wt, pInit, maxSize) gwinGTexteditCreate(GDISP, wt, pInit, maxSize)
/**
+ * @brief Send a special key to the textedit such as GKEY_LEFT, GKEY_RIGHT, GKEY_HOME, GKEY_END
+ *
+ * @param[in] gh The window handle (must be a textedit window)
+ * @param[in] key The special key to send.
+ * @pre Requires GINPUT_NEED_KEYBOARD or GWIN_NEED_KEYBOARD to be on
+ * @api
+ */
+void gwinTextEditSendSpecialKey(GHandle gh, uint8_t key);
+
+/**
+ * @brief Send a normal utf8 character to the textedit
+ *
+ * @param[in] gh The window handle (must be a textedit window)
+ * @param[in] pkey The pointer to the utf8 character to send.
+ * @param[in] len The length of the utf8 character in bytes.
+ * @note This must ONLY be called with a single utf8 character at a time. Don't attempt to
+ * send a string of characters in the one call.
+ * @note Characters are interpreted as if they came directly from a keyboard ie a backspace
+ * character will perform the backspace operation, a tab will send the focus to the next
+ * control etc.
+ * @pre Requires GINPUT_NEED_KEYBOARD or GWIN_NEED_KEYBOARD to be on
+ * @api
+ */
+void gwinTextEditSendKey(GHandle gh, char *pkey, unsigned len);
+
+/**
* @defgroup Renderings_Textedit Renderings
*
* @brief Built-in rendering functions for the textedit widget.