Crazy Eddies GUI System  0.7.2
FalMultiLineEditbox.h
1 /***********************************************************************
2  filename: FalMultiLineEditbox.h
3  created: Thu Jul 7 2005
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 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 _FalMultiLineEditbox_h_
29 #define _FalMultiLineEditbox_h_
30 
31 #include "FalModule.h"
32 #include "../../elements/CEGUIMultiLineEditbox.h"
33 #include "FalMultiLineEditboxProperties.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 {
75 {
76 public:
77  static const utf8 TypeName[];
78 
87  static const float DefaultCaretBlinkTimeout;
88 
93  FalagardMultiLineEditbox(const String& type);
94 
95  // overridden from base classes.
96  Rect getTextRenderArea(void) const;
97  void render();
98  void update(float elapsed);
99 
101  bool isCaretBlinkEnabled() const;
103  float getCaretBlinkTimeout() const;
105  void setCaretBlinkEnabled(bool enable);
107  void setCaretBlinkTimeout(float seconds);
108 
109 protected:
120  void cacheEditboxBaseImagery();
121 
129  void cacheCaratImagery(const Rect& textArea);
130 
135  void cacheTextLines(const Rect& dest_area);
136 
145  colour getUnselectedTextColour() const;
146 
155  colour getActiveSelectionColour() const;
156 
165  colour getInactiveSelectionColour() const;
166 
175  colour getSelectedTextColour() const;
176 
186  colour getOptionalPropertyColour(const String& propertyName) const;
187 
188  // properties
189  static FalagardMultiLineEditboxProperties::BlinkCaret d_blinkCaretProperty;
190  static FalagardMultiLineEditboxProperties::BlinkCaretTimeout d_blinkCaretTimeoutProperty;
191 
200 };
201 
202 } // End of CEGUI namespace section
203 
204 
205 #if defined(_MSC_VER)
206 # pragma warning(pop)
207 #endif
208 
209 #endif // end of guard _FalMultiLineEditbox_h_