Crazy Eddie's GUI System  0.8.4
MultiLineEditbox.h
00001 /***********************************************************************
00002     created:    Thu Jul 7 2005
00003     author:     Paul D Turner <paul@cegui.org.uk>
00004 *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00007  *
00008  *   Permission is hereby granted, free of charge, to any person obtaining
00009  *   a copy of this software and associated documentation files (the
00010  *   "Software"), to deal in the Software without restriction, including
00011  *   without limitation the rights to use, copy, modify, merge, publish,
00012  *   distribute, sublicense, and/or sell copies of the Software, and to
00013  *   permit persons to whom the Software is furnished to do so, subject to
00014  *   the following conditions:
00015  *
00016  *   The above copyright notice and this permission notice shall be
00017  *   included in all copies or substantial portions of the Software.
00018  *
00019  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00020  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00021  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00022  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00023  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00024  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00025  *   OTHER DEALINGS IN THE SOFTWARE.
00026  ***************************************************************************/
00027 #ifndef _FalMultiLineEditbox_h_
00028 #define _FalMultiLineEditbox_h_
00029 
00030 #include "CEGUI/WindowRendererSets/Core/Module.h"
00031 #include "CEGUI/widgets/MultiLineEditbox.h"
00032 
00033 #if defined(_MSC_VER)
00034 #       pragma warning(push)
00035 #       pragma warning(disable : 4251)
00036 #endif
00037 
00038 // Start of CEGUI namespace section
00039 namespace CEGUI
00040 {
00072 class COREWRSET_API FalagardMultiLineEditbox : public MultiLineEditboxWindowRenderer
00073 {
00074 public:
00075     static const String TypeName;     
00076 
00078     static const String UnselectedTextColourPropertyName;
00080     static const String SelectedTextColourPropertyName;
00082     static const String ActiveSelectionColourPropertyName;
00084     static const String InactiveSelectionColourPropertyName;
00086     static const float DefaultCaretBlinkTimeout;
00087 
00092     FalagardMultiLineEditbox(const String& type);
00093 
00094     // overridden from base classes.
00095     Rectf getTextRenderArea(void) const;
00096     void render();
00097     void update(float elapsed);
00098 
00100     bool isCaretBlinkEnabled() const;
00102     float getCaretBlinkTimeout() const;
00104     void setCaretBlinkEnabled(bool enable);
00106     void setCaretBlinkTimeout(float seconds);
00107 
00108     // overridden from base class
00109     bool handleFontRenderSizeChange(const Font* const font);
00110 
00111 protected:
00122     void cacheEditboxBaseImagery();
00123 
00131     void cacheCaretImagery(const Rectf& textArea);
00132 
00137     void cacheTextLines(const Rectf& dest_area);
00138 
00144     void setColourRectToUnselectedTextColour(ColourRect& colour_rect) const;
00145 
00151     void setColourRectToSelectedTextColour(ColourRect& colour_rect) const;
00152 
00158     void setColourRectToActiveSelectionColour(ColourRect& colour_rect) const;
00159 
00165     void setColourRectToInactiveSelectionColour(ColourRect& colour_rect) const;
00166 
00179     void setColourRectToOptionalPropertyColour(const String& propertyName,
00180                                                ColourRect& colour_rect) const;
00181 
00183     bool d_blinkCaret;
00185     float d_caretBlinkTimeout;
00187     float d_caretBlinkElapsed;
00189     bool d_showCaret;
00190 };
00191 
00192 } // End of  CEGUI namespace section
00193 
00194 
00195 #if defined(_MSC_VER)
00196 #       pragma warning(pop)
00197 #endif
00198 
00199 #endif  // end of guard _FalMultiLineEditbox_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends