Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
FalEditbox.h
1 /***********************************************************************
2  filename: FalEditbox.h
3  created: Sat Jun 25 2005
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _FalEditbox_h_
29 #define _FalEditbox_h_
30 
31 #include "FalModule.h"
32 #include "../../elements/CEGUIEditbox.h"
33 #include "FalEditboxProperties.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
77 class FALAGARDBASE_API FalagardEditbox : public EditboxWindowRenderer
78 {
79 public:
81  static const utf8 TypeName[];
87  static const float DefaultCaretBlinkTimeout;
88 
93  FalagardEditbox(const String& type);
94 
103  colour getUnselectedTextColour() const;
104 
113  colour getSelectedTextColour() const;
114 
124  colour getOptionalPropertyColour(const String& propertyName) const;
125 
127  bool isCaretBlinkEnabled() const;
129  float getCaretBlinkTimeout() const;
131  void setCaretBlinkEnabled(bool enable);
133  void setCaretBlinkTimeout(float seconds);
134 
146  void setTextFormatting(const HorizontalTextFormatting format);
147  HorizontalTextFormatting getTextFormatting() const;
148 
149  void render();
150 
151  // overridden from EditboxWindowRenderer base class.
152  size_t getTextIndexFromPosition(const Point& pt) const;
153  // overridden from WindowRenderer class
154  void update(float elapsed);
155 
156 protected:
157  // properties
158  static FalagardEditboxProperties::BlinkCaret d_blinkCaretProperty;
159  static FalagardEditboxProperties::BlinkCaretTimeout d_blinkCaretTimeoutProperty;
160  static FalagardEditboxProperties::TextFormatting d_textFormattingProperty;
161 
163  void renderBaseImagery(const WidgetLookFeel& wlf) const;
165  void setupVisualString(String& visual) const;
166  size_t getCaretIndex(const String& visual_string) const;
167  float calculateTextOffset(const Rect& text_area,
168  const float text_extent,
169  const float caret_width,
170  const float extent_to_caret);
171  void renderTextNoBidi(const WidgetLookFeel& wlf,
172  const String& text,
173  const Rect& text_area,
174  float text_offset);
175  void renderTextBidi(const WidgetLookFeel& wlf,
176  const String& text,
177  const Rect& text_area,
178  float text_offset);
179  bool editboxIsFocussed() const;
180  void renderCaret(const ImagerySection& imagery,
181  const Rect& text_area,
182  const float text_offset,
183  const float extent_to_caret) const;
184 
185  bool isUnsupportedFormat(const HorizontalTextFormatting format);
186 
199 };
200 
201 } // End of CEGUI namespace section
202 
203 #if defined(_MSC_VER)
204 # pragma warning(pop)
205 #endif
206 
207 #endif // end of guard _FalEditbox_h_
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
float d_lastTextOffset
x rendering offset used last time we drew the widget.
Definition: FalEditbox.h:188
static const String UnselectedTextColourPropertyName
Name of property to access for unselected text colour.
Definition: FalEditbox.h:83
bool d_blinkCaret
true if the caret imagery should blink.
Definition: FalEditbox.h:190
bool d_showCaret
true if caret should be shown.
Definition: FalEditbox.h:196
float d_caretBlinkElapsed
current time elapsed since last caret blink state change.
Definition: FalEditbox.h:194
Property to access the setting that controls the speed at which the caret blinks when the caret blink...
Definition: FalEditboxProperties.h:75
Base class for the EditboxWindowRenderer class.
Definition: CEGUIEditbox.h:46
Class representing colour values within the system.
Definition: CEGUIcolour.h:45
HorizontalTextFormatting
Enumeration of possible values to indicate the horizontal formatting to be used for a text component...
Definition: CEGUIFalEnums.h:94
Property to access the horizontal formatting mode setting.
Definition: FalEditboxProperties.h:102
Property to access the setting that controls whether the caret will blink.
Definition: FalEditboxProperties.h:52
Editbox class for the FalagardBase module.
Definition: FalEditbox.h:77
HorizontalTextFormatting d_textFormatting
horizontal formatting. Only supports left, right, and centred.
Definition: FalEditbox.h:198
Class that encapsulates look &amp; feel information for a particular widget type.
Definition: CEGUIFalWidgetLookFeel.h:53
static const float DefaultCaretBlinkTimeout
The default timeout (in seconds) used when blinking the caret.
Definition: FalEditbox.h:87
static const String SelectedTextColourPropertyName
Name of property to access for selected text colour.
Definition: FalEditbox.h:85
float d_caretBlinkTimeout
time-out in seconds used for blinking the caret.
Definition: FalEditbox.h:192
Class that encapsulates a re-usable collection of imagery specifications.
Definition: CEGUIFalImagerySection.h:48
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44
String class used within the GUI system.
Definition: CEGUIString.h:57