urho3d/Engine/UI/LineEdit.h

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// 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 OR COPYRIGHT HOLDERS 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 UI_LINEEDIT_H
#define UI_LINEEDIT_H

#include "BorderImage.h"

class Font;
class Text;

class LineEdit : public BorderImage
{
    DEFINE_TYPE(LineEdit);
    
public:
    //! Construct with name and initial text
    LineEdit(const std::string& name = std::string(), const std::string& text = std::string());
    //! Destruct
    virtual ~LineEdit();
    
    //! Set UI element style from XML data
    virtual void setStyle(const XMLElement& element, ResourceCache* cache);
    //! Perform UI element update
    virtual void update(float timeStep);
    
    //! React to mouse click
    virtual void onClick(const IntVector2& position, const IntVector2& screenPosition, int buttons, int qualifiers);
    //! React to mouse drag start
    virtual void onDragStart(const IntVector2& position, const IntVector2& screenPosition, int buttons, int qualifiers);
    //! React to mouse drag motion
    virtual void onDragMove(const IntVector2& position, const IntVector2& screenPosition, int buttons, int qualifiers);
    //! React to a key press
    virtual void onKey(int key, int buttons, int qualifiers);
    //! React to a key press translated to a character
    virtual void onChar(unsigned char c, int buttons, int qualifiers);
    //! React to gaining focus
    virtual void onFocus();
    //! React to losing focus
    virtual void onDefocus();
    
    //! Set text
    void setText(const std::string& text);
    //! Set cursor position
    void setCursorPosition(unsigned position);
    //! Set cursor blink rate. 0 disables blinking
    void setCursorBlinkRate(float rate);
    //! Set maximum text length. 0 for unlimited
    void setMaxLength(unsigned length);
    //! Set echo character for password entry and such. 0 (default) shows the actual text
    void setEchoCharacter(char c);
    //! Set whether can move cursor with arrows or mouse, default true
    void setCursorMovable(bool enable);
    //! Set whether selections are allowed, default true
    void setTextSelectable(bool enable);
    //! Set whether copy-paste operations are allowed, default true
    void setTextCopyable(bool enable);
    
    //! Return text
    const std::string& getText() const { return mLine; }
    //! Return cursor position
    unsigned getCursorPosition() const { return mCursorPosition; }
    //! Return cursor blink rate
    float getCursorBlinkRate() const { return mCursorBlinkRate; }
    //! Return maximum text length
    unsigned getMaxLength() const { return mMaxLength; }
    //! Return echo character
    char getEchoCharacter() const { return mEchoCharacter; }
    //! Return whether can move cursor with arrows or mouse
    bool isCursorMovable() const { return mCursorMovable; }
    //! Return whether selections are allowed
    bool isTextSelectable() const { return mTextSelectable; }
    //! Return whether copy-paste operations are allowed
    bool isTextCopyable() const { return mTextCopyable; }
    //! Return text element
    Text* getTextElement() const { return mText; }
    //! Return cursor element
    BorderImage* getCursor() const { return mCursor; }
    
protected:
    //! Update displayed text
    void updateText();
    //! Update cursor position and restart cursor blinking
    void updateCursor();
    //! Return char index corresponding to position within element, or M_MAX_UNSIGNED if not found
    unsigned getCharIndex(const IntVector2& position);
    
    //! Text element
    SharedPtr<Text> mText;
    //! Cursor element
    SharedPtr<BorderImage> mCursor;
    //! Text line
    std::string mLine;
    //! Last known text font
    Font* mLastFont;
    //! Last known text size
    int mLastFontSize;
    //! Cursor position
    unsigned mCursorPosition;
    //! Drag start cursor position
    unsigned mDragStartPosition;
    //! Cursor blink rate
    float mCursorBlinkRate;
    //! Cursor blink timer
    float mCursorBlinkTimer;
    //! Maximum text length
    unsigned mMaxLength;
    //! Echo character
    char mEchoCharacter;
    //! Cursor movable flag
    bool mCursorMovable;
    //! Text selectable flag
    bool mTextSelectable;
    //! Copy-paste enable flag
    bool mTextCopyable;
};

#endif // UI_LINEEDIT_H