WindowRendererSets/Core/Editbox.h

/***********************************************************************
    created:    Sat Jun 25 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _FalEditbox_h_
#define _FalEditbox_h_

#include "CEGUI/WindowRendererSets/Core/Module.h"
#include "CEGUI/widgets/Editbox.h"

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class COREWRSET_API FalagardEditbox : public EditboxWindowRenderer
{
public:
    static const String TypeName;

    static const String UnselectedTextColourPropertyName;
    static const String SelectedTextColourPropertyName;
    static const float DefaultCaretBlinkTimeout;

    FalagardEditbox(const String& type);

    void setColourRectToUnselectedTextColour(ColourRect& colour_rect) const;

    void setColourRectToSelectedTextColour(ColourRect& colour_rect) const;

    void setColourRectToOptionalPropertyColour(const String& propertyName,
                                            ColourRect& colour_rect) const;

    bool isCaretBlinkEnabled() const;
    float getCaretBlinkTimeout() const;
    void setCaretBlinkEnabled(bool enable);
    void setCaretBlinkTimeout(float seconds);

    void setTextFormatting(const HorizontalTextFormatting format);
    HorizontalTextFormatting getTextFormatting() const;

    void render();

    // overridden from EditboxWindowRenderer base class.
    size_t getTextIndexFromPosition(const Vector2f& pt) const;
    // overridden from WindowRenderer class
    void update(float elapsed);
    bool handleFontRenderSizeChange(const Font* const font);

protected:
    void renderBaseImagery(const WidgetLookFeel& wlf) const;
    void setupVisualString(String& visual) const;
    size_t getCaretIndex(const String& visual_string) const;
    float calculateTextOffset(const Rectf& text_area,
                              const float text_extent,
                              const float caret_width,
                              const float extent_to_caret);
    void renderTextNoBidi(const WidgetLookFeel& wlf,
                          const String& text,
                          const Rectf& text_area,
                          float text_offset);
    void renderTextBidi(const WidgetLookFeel& wlf,
                        const String& text,
                        const Rectf& text_area,
                        float text_offset);
    bool editboxIsFocussed() const;
    bool editboxIsReadOnly() const;
    void renderCaret(const ImagerySection& imagery,
                     const Rectf& text_area,
                     const float text_offset,
                     const float extent_to_caret) const;

    bool isUnsupportedFormat(const HorizontalTextFormatting format);

    float d_lastTextOffset;
    bool d_blinkCaret;
    float d_caretBlinkTimeout;
    float d_caretBlinkElapsed;
    bool d_showCaret;
    HorizontalTextFormatting d_textFormatting;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _FalEditbox_h_