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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naess�n a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GCN_TEXTBOX_HPP
#define GCN_TEXTBOX_HPP
#include <ctime>
#include <string>
#include <vector>
#include "guichan/keylistener.hpp"
#include "guichan/mouselistener.hpp"
#include "guichan/platform.hpp"
#include "guichan/widget.hpp"
namespace gcn
{
/**
* An implementation of a text box where a user can enter text that contains of many lines.
*/
class GCN_CORE_DECLSPEC TextBox:
public Widget,
public MouseListener,
public KeyListener
{
public:
/**
* Constructor.
*/
TextBox();
/**
* Constructor.
*
* @param text The default text of the text box.
*/
TextBox(const std::string& text);
/**
* Sets the text of the text box.
*
* @param text The text of the text box.
* @see getText
*/
void setText(const std::string& text);
/**
* Gets the text of the text box.
*
* @return The text of the text box.
* @see setText
*/
std::string getText() const;
/**
* Gets a certain row from the text.
*
* @param row The number of the row to get from the text.
* @return A row from the text of the text box.
* @see setTextRow
*/
const std::string& getTextRow(int row) const;
/**
* Sets the text of a certain row of the text.
*
* @param row The number of the row to set in the text.
* @param text The text to set in the given row number.
* @see getTextRow
*/
void setTextRow(int row, const std::string& text);
/**
* Gets the number of rows in the text.
*
* @return The number of rows in the text.
*/
unsigned int getNumberOfRows() const;
/**
* Gets the caret position in the text.
*
* @return The caret position in the text.
* @see setCaretPosition
*/
unsigned int getCaretPosition() const;
/**
* Sets the position of the caret in the text.
*
* @param position the positon of the caret.
* @see getCaretPosition
*/
void setCaretPosition(unsigned int position);
/**
* Gets the row number where the caret is currently located.
*
* @return The row number where the caret is currently located.
* @see setCaretRow
*/
unsigned int getCaretRow() const;
/**
* Sets the row where the caret should be currently located.
*
* @param The row where the caret should be currently located.
* @see getCaretRow
*/
void setCaretRow(int row);
/**
* Gets the column where the caret is currently located.
*
* @return The column where the caret is currently located.
* @see setCaretColumn
*/
unsigned int getCaretColumn() const;
/**
* Sets the column where the caret should be currently located.
*
* @param The column where the caret should be currently located.
* @see getCaretColumn
*/
void setCaretColumn(int column);
/**
* Sets the row and the column where the caret should be curretly
* located.
*
* @param row The row where the caret should be currently located.
* @param column The column where the caret should be currently located.
* @see getCaretRow, getCaretColumn
*/
void setCaretRowColumn(int row, int column);
/**
* Scrolls the text to the caret if the text box is in a scroll area.
*
* @see ScrollArea
*/
virtual void scrollToCaret();
/**
* Checks if the text box is editable.
*
* @return True it the text box is editable, false otherwise.
* @see setEditable
*/
bool isEditable() const;
/**
* Sets the text box to be editable or not.
*
* @param editable True if the text box should be editable, false otherwise.
*/
void setEditable(bool editable);
/**
* Adds a row of text to the end of the text.
*
* @param row The row to add.
*/
virtual void addRow(const std::string row);
/**
* Checks if the text box is opaque. An opaque text box will draw
* it's background and it's text. A non opaque text box only draw it's
* text making it transparent.
*
* @return True if the text box is opaque, false otherwise.
* @see setOpaque
*/
bool isOpaque();
/**
* Sets the text box to be opaque or not. An opaque text box will draw
* it's background and it's text. A non opaque text box only draw it's
* text making it transparent.
*
* @param opaque True if the text box should be opaque, false otherwise.
* @see isOpaque
*/
void setOpaque(bool opaque);
// Inherited from Widget
virtual void draw(Graphics* graphics);
virtual void fontChanged();
// Inherited from KeyListener
virtual void keyPressed(KeyEvent& keyEvent);
// Inherited from MouseListener
virtual void mousePressed(MouseEvent& mouseEvent);
virtual void mouseDragged(MouseEvent& mouseEvent);
protected:
/**
* Draws the caret. Overloaded this method if you want to
* change the style of the caret.
*
* @param graphics a Graphics object to draw with.
* @param x the x position.
* @param y the y position.
*/
virtual void drawCaret(Graphics* graphics, int x, int y);
/**
* Adjusts the text box's size to fit the text.
*/
virtual void adjustSize();
/**
* Holds all the rows of the text.
*/
std::vector<std::string> mTextRows;
/**
* Holds the current column of the caret.
*/
int mCaretColumn;
/**
* Holds the current row of the caret.
*/
int mCaretRow;
/**
* True if the text box is editable, false otherwise.
*/
bool mEditable;
/**
* True if the text box is editable, false otherwise.
*/
bool mOpaque;
};
}
#endif // end GCN_TEXTBOX_HPP
|
