NXWidgets: itextbox.hxx Source File

NXWidgets 1.19

itextbox.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/itextbox.hxx
3 *
4 * Copyright (C) 2012 Gregory Nutt. All rights reserved.
5 * Author: Gregory Nutt <gnutt@nuttx.org>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
18 * me be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *
34 ****************************************************************************
35 *
36 * Portions of this package derive from Woopsi (http://woopsi.org/) and
37 * portions are original efforts. It is difficult to determine at this
38 * point what parts are original efforts and which parts derive from Woopsi.
39 * However, in any event, the work of Antony Dzeryn will be acknowledged
40 * in most NxWidget files. Thanks Antony!
41 *
42 * Copyright (c) 2007-2011, Antony Dzeryn
43 * All rights reserved.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions are met:
47 *
48 * * Redistributions of source code must retain the above copyright
49 * notice, this list of conditions and the following disclaimer.
50 * * Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in the
52 * documentation and/or other materials provided with the distribution.
53 * * Neither the names "Woopsi", "Simian Zombie" nor the
54 * names of its contributors may be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY Antony Dzeryn ``AS IS'' AND ANY
58 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
59 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
60 * DISCLAIMED. IN NO EVENT SHALL Antony Dzeryn BE LIABLE FOR ANY
61 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
62 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
63 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
64 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
66 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 *
68 ****************************************************************************/
69
70 #ifndef __INCLUDE_ITEXTBOX_HXX
71 #define __INCLUDE_ITEXTBOX_HXX
72
73 /****************************************************************************
74 * Included Files
75 ****************************************************************************/
76
77 #include <nuttx/config.h>
78
79 #include <stdint.h>
80 #include <stdbool.h>
81
82 #include <nuttx/nx/nxglib.h>
83
84 #include "cnxstring.hxx"
85 #include "cwidgetstyle.hxx"
86 #include "cwidgeteventargs.hxx"
87
88 /****************************************************************************
89 * Pre-Processor Definitions
90 ****************************************************************************/
91
92 /****************************************************************************
93 * Abstract Base Classes
94 ****************************************************************************/
95
96 #if defined(__cplusplus)
97
98 namespace NXWidgets
99 {
100 /**
101 * Cursor display options.
102 */
103
104 typedef enum
105 {
106 SHOW_CURSOR_ONFOCUS = 0, /**< Show the cursor only if the widget has focus */
107 SHOW_CURSOR_NEVER, /**< The cursor is never displayed */
108 SHOW_CURSOR_ALWAYS /**< Always show the cursor */
109 } EShowCursor;
110
111 /**
112 * Defines the interface that textbox-like classes should implement.
113 */
114
115 class ITextBox
116 {
117 public:
118 /**
119 * A virtual destructor is required in order to override the ITextBox
120 * destructor. We do this because if we delete ITextBox, we want the
121 * destructor of the class that inherits from ITextBox to run, not this
122 * one.
123 */
124
125 virtual ~ITextBox(void) { }
126
127 /**
128 * Sets the cursor display mode.
129 *
130 *@param cursorMode Determines cursor display mode
131 */
132
133 virtual void showCursor(EShowCursor cursorMode) = 0;
134
135 /**
136 * Enables/disables cursor wrapping
137 *
138 * @param wrap True enables cursor wrapping
139 */
140
141 virtual void wrapCursor(bool wrap) = 0;
142
143 /**
144 * Set the text displayed in the label.
145 *
146 * @param text String to display.
147 */
148
149 virtual void setText(const CNxString &text) = 0;
150
151 /**
152 * Append new text to the end of the current text displayed in the
153 * label.
154 *
155 * @param text String to append.
156 */
157
158 virtual void appendText(const CNxString &text) = 0;
159
160 /**
161 * Remove all characters from the string from the start index onwards.
162 *
163 * @param startIndex Index to remove from.
164 */
165
166 virtual void removeText(const unsigned int startIndex) = 0;
167
168 /**
169 * Remove specified number of characters from the string from the
170 * start index onwards.
171 *
172 * @param startIndex Index to remove from.
173 * @param count Number of characters to remove.
174 */
175
176 virtual void removeText(const unsigned int startIndex, const unsigned int count) = 0;
177
178 /**
179 * Insert text at the specified index.
180 *
181 * @param text The text to insert.
182 * @param index Index at which to insert the text.
183 */
184
185 virtual void insertText(const CNxString &text, const unsigned int index) = 0;
186
187 /**
188 * Insert text at the current cursor position.
189 *
190 * @param text The text to insert.
191 */
192
193 virtual void insertTextAtCursor(const CNxString &text) = 0;
194
195 /**
196 * Move the cursor to the text position specified. 0 indicates the
197 * start of the string. If position is greater than the length of the
198 * string, the cursor is moved to the end of the string.
199 *
200 * @param position The new cursor position.
201 */
202
203 virtual void moveCursorToPosition(const int position) = 0;
204
205 /**
206 * Get the cursor position. This is the index within the string that
207 * the cursor is currently positioned over.
208 * @return position The cursor position.
209 */
210
211 virtual const int getCursorPosition(void) const = 0;
212 };
213 }
214
215 #endif // __cplusplus
216
217 #endif // __INCLUDE_ITEXTBOX_HXX
NXWidgets::ITextBox::appendText
virtual void appendText(const CNxString &text)=0
NXWidgets::ITextBox::moveCursorToPosition
virtual void moveCursorToPosition(const int position)=0
cwidgetstyle.hxx
NXWidgets::ITextBox::insertText
virtual void insertText(const CNxString &text, const unsigned int index)=0
NXWidgets::ITextBox::insertTextAtCursor
virtual void insertTextAtCursor(const CNxString &text)=0
NXWidgets::EShowCursor
EShowCursor
Definition: itextbox.hxx:104
cwidgeteventargs.hxx
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::ITextBox::wrapCursor
virtual void wrapCursor(bool wrap)=0
NXWidgets::SHOW_CURSOR_ONFOCUS
Definition: itextbox.hxx:106
NXWidgets::ITextBox::~ITextBox
virtual ~ITextBox(void)
Definition: itextbox.hxx:125
NXWidgets::ITextBox::removeText
virtual void removeText(const unsigned int startIndex)=0
NXWidgets::ITextBox::setText
virtual void setText(const CNxString &text)=0
NXWidgets::ITextBox::showCursor
virtual void showCursor(EShowCursor cursorMode)=0
NXWidgets::CNxString
Definition: cnxstring.hxx:121
NXWidgets::SHOW_CURSOR_ALWAYS
Definition: itextbox.hxx:108
cnxstring.hxx
NXWidgets::ITextBox
Definition: itextbox.hxx:115
NXWidgets::SHOW_CURSOR_NEVER
Definition: itextbox.hxx:107
NXWidgets::ITextBox::getCursorPosition
virtual const int getCursorPosition(void) const =0