• Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List

FalEditbox.h

00001 /***********************************************************************
00002     filename:   FalEditbox.h
00003     created:    Sat Jun 25 2005
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _FalEditbox_h_
00029 #define _FalEditbox_h_
00030 
00031 #include "FalModule.h"
00032 #include "../../elements/CEGUIEditbox.h"
00033 #include "FalEditboxProperties.h"
00034 
00035 #if defined(_MSC_VER)
00036 #       pragma warning(push)
00037 #       pragma warning(disable : 4251)
00038 #endif
00039 
00040 // Start of CEGUI namespace section
00041 namespace CEGUI
00042 {
00077 class FALAGARDBASE_API FalagardEditbox : public EditboxWindowRenderer
00078 {
00079 public:
00081     static const utf8 TypeName[];
00083     static const String UnselectedTextColourPropertyName;
00085     static const String SelectedTextColourPropertyName;
00087     static const float DefaultCaretBlinkTimeout;
00088 
00093     FalagardEditbox(const String& type);
00094 
00103     colour getUnselectedTextColour() const;
00104 
00113     colour getSelectedTextColour() const;
00114 
00124     colour getOptionalPropertyColour(const String& propertyName) const;
00125 
00127     bool isCaretBlinkEnabled() const;
00129     float getCaretBlinkTimeout() const;
00131     void setCaretBlinkEnabled(bool enable);
00133     void setCaretBlinkTimeout(float seconds);
00134 
00135     void render();
00136 
00137     // overridden from EditboxWindowRenderer base class.
00138     size_t getTextIndexFromPosition(const Point& pt) const;
00139     // overridden from WindowRenderer class
00140     void update(float elapsed);
00141 
00142 protected:
00143     // properties
00144     static FalagardEditboxProperties::BlinkCaret d_blinkCaretProperty;
00145     static FalagardEditboxProperties::BlinkCaretTimeout d_blinkCaretTimeoutProperty;
00146 
00148     float d_lastTextOffset;
00150     bool d_blinkCaret;
00152     float d_caretBlinkTimeout;
00154     float d_caretBlinkElapsed;
00156     bool d_showCaret;
00157 };
00158 
00159 } // End of  CEGUI namespace section
00160 
00161 #if defined(_MSC_VER)
00162 #       pragma warning(pop)
00163 #endif
00164 
00165 #endif  // end of guard _FalEditbox_h_

Generated on Sat Sep 25 2010 02:10:34 for Crazy Eddies GUI System by  doxygen 1.7.1