widgets/Editbox.h

/***********************************************************************
    filename:   CEGUIEditbox.h
    created:    13/4/2004
    author:     Paul D Turner

    purpose:    Interface to base class for Editbox widget
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIEditbox_h_
#define _CEGUIEditbox_h_

#include "CEGUI/Base.h"
#include "CEGUI/Window.h"
#include "CEGUI/RegexMatcher.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT EditboxWindowRenderer : public WindowRenderer
{
public:
    EditboxWindowRenderer(const String& name);

    virtual size_t getTextIndexFromPosition(const Vector2f& pt) const = 0;
};

//----------------------------------------------------------------------------//

class CEGUIEXPORT Editbox : public Window
{
public:
    typedef RegexMatcher::MatchState MatchState;

    static const String EventNamespace;
    static const String WidgetTypeName;
    static const String EventReadOnlyModeChanged;
    static const String EventMaskedRenderingModeChanged;
    static const String EventMaskCodePointChanged;
    static const String EventValidationStringChanged;
    static const String EventMaximumTextLengthChanged;
    static const String EventTextValidityChanged;
    static const String EventCaretMoved;
    static const String EventTextSelectionChanged;
    static const String EventEditboxFull;
    static const String EventTextAccepted;

    bool hasInputFocus(void) const;

    bool isReadOnly(void) const
        {return d_readOnly;}

    bool isTextMasked(void) const
        {return d_maskText;}

    MatchState getTextMatchState() const;

    const String& getValidationString(void) const
        {return d_validationString;}

    size_t getCaretIndex(void) const;

    size_t getSelectionStartIndex(void) const;

    size_t getSelectionEndIndex(void) const;

    size_t getSelectionLength(void) const;

    String::value_type getMaskCodePoint(void) const
    { return d_maskCodePoint; }

    size_t getMaxTextLength(void) const
        {return d_maxTextLen;}

    void setReadOnly(bool setting);

    void setTextMasked(bool setting);

    void setValidationString(const String& validation_string);

    void setCaretIndex(size_t caret_pos);

    void setSelection(size_t start_pos, size_t end_pos);

    void setSelectionStart(size_t start_pos);

    void setSelectionLength(size_t length);

    void setMaskCodePoint(String::value_type code_point);

    void setMaxTextLength(size_t max_len);

    void setValidator(RegexMatcher* matcher);

    virtual bool performCopy(Clipboard& clipboard);

    virtual bool performCut(Clipboard& clipboard);
    
    virtual bool performPaste(Clipboard& clipboard);
    
    Editbox(const String& type, const String& name);

    virtual ~Editbox(void);

protected:
    size_t getTextIndexFromPosition(const Vector2f& pt) const;

    void clearSelection(void);

    void eraseSelectedText(bool modify_text = true);

    MatchState getStringMatchState(const String& str) const;

    bool handleValidityChangeForString(const String& str);

    void handleBackspace(void);

    void handleDelete(void);

    void handleCharLeft(uint sysKeys);

    void handleWordLeft(uint sysKeys);

    void handleCharRight(uint sysKeys);

    void handleWordRight(uint sysKeys);

    void handleHome(uint sysKeys);

    void handleEnd(uint sysKeys);

    virtual bool validateWindowRenderer(const WindowRenderer* renderer) const;

    virtual void onReadOnlyChanged(WindowEventArgs& e);

    virtual void onMaskedRenderingModeChanged(WindowEventArgs& e);

    virtual void onMaskCodePointChanged(WindowEventArgs& e);

    virtual void onValidationStringChanged(WindowEventArgs& e);

    virtual void onMaximumTextLengthChanged(WindowEventArgs& e);

    virtual void onTextValidityChanged(RegexMatchStateEventArgs& e);

    virtual void onCaretMoved(WindowEventArgs& e);

    virtual void onTextSelectionChanged(WindowEventArgs& e);

    virtual void onEditboxFullEvent(WindowEventArgs& e);

    virtual void onTextAcceptedEvent(WindowEventArgs& e);

    // Overridden event handlers
    void onMouseButtonDown(MouseEventArgs& e);
    void onMouseButtonUp(MouseEventArgs& e);
    void onMouseDoubleClicked(MouseEventArgs& e);
    void onMouseTripleClicked(MouseEventArgs& e);
    void onMouseMove(MouseEventArgs& e);
    void onCaptureLost(WindowEventArgs& e);
    void onCharacter(KeyEventArgs& e);
    void onKeyDown(KeyEventArgs& e);
    void onTextChanged(WindowEventArgs& e);

    bool d_readOnly;
    bool d_maskText;
    String::value_type d_maskCodePoint;
    size_t d_maxTextLen;
    size_t d_caretPos;
    size_t d_selectionStart;
    size_t d_selectionEnd;
    String d_validationString;
    RegexMatcher* d_validator;
    bool d_weOwnValidator;
    bool d_dragging;
    size_t d_dragAnchorIdx;
    MatchState d_validatorMatchState;
    bool d_previousValidityChangeResponse;

private:

    void addEditboxProperties(void);
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIEditbox_h_