MyGUI_EditBox.h

Go to the documentation of this file.

/*
 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
 * Distributed under the MIT License
 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
 */

#ifndef __MYGUI_EDIT_BOX_H__
#define __MYGUI_EDIT_BOX_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_TextBox.h"
#include "MyGUI_TextChangeHistory.h"
#include "MyGUI_TextIterator.h"
#include "MyGUI_EventPair.h"
#include "MyGUI_ScrollViewBase.h"

namespace MyGUI
{

    typedef delegates::CMultiDelegate1<EditBox*> EventHandle_EditPtr;

    class MYGUI_EXPORT EditBox :
        public TextBox,
        public ScrollViewBase,
        public MemberObsolete<EditBox>
    {
        MYGUI_RTTI_DERIVED( EditBox )

    public:
        EditBox();

        void setTextIntervalColour(size_t _start, size_t _count, const Colour& _colour);

        size_t getTextSelectionStart() const;

        size_t getTextSelectionEnd() const;

        size_t getTextSelectionLength() const;

        // возвращает текст с тегами
        UString getTextInterval(size_t _start, size_t _count);

        void setTextSelection(size_t _start, size_t _end);

        void deleteTextSelection();

        UString getTextSelection();

        bool isTextSelection() const;

        void setTextSelectionColour(const Colour& _value);

        void setTextCursor(size_t _index);
        size_t getTextCursor() const;


        virtual void setCaption(const UString& _value);
        virtual const UString& getCaption();

        void setOnlyText(const UString& _value);
        UString getOnlyText();

        size_t getTextLength() const;

        void setOverflowToTheLeft(bool _value);
        bool getOverflowToTheLeft() const;

        void setMaxTextLength(size_t _value);
        size_t getMaxTextLength() const;

        void insertText(const UString& _text, size_t _index = ITEM_NONE);
        void addText(const UString& _text);
        void eraseText(size_t _start, size_t _count = 1);

        void setEditReadOnly(bool _value);
        bool getEditReadOnly() const;

        void setEditPassword(bool _value);
        bool getEditPassword() const;

        void setEditMultiLine(bool _value);
        bool getEditMultiLine() const;

        void setEditStatic(bool _value);
        bool getEditStatic() const;

        void setPasswordChar(Char _value);
        void setPasswordChar(const UString& _char);
        Char getPasswordChar() const;

        void setEditWordWrap(bool _value);
        bool getEditWordWrap() const;

        void setTabPrinting(bool _value);
        bool getTabPrinting() const;

        bool getInvertSelected();
        void setInvertSelected(bool _value);

        virtual void setPosition(const IntPoint& _value);
        virtual void setSize(const IntSize& _value);
        virtual void setCoord(const IntCoord& _value);

        void setPosition(int _left, int _top);
        void setSize(int _width, int _height);
        void setCoord(int _left, int _top, int _width, int _height);

        void setVisibleVScroll(bool _value);
        bool isVisibleVScroll() const;
        size_t getVScrollRange() const;
        size_t getVScrollPosition();
        void setVScrollPosition(size_t _index);

        void setVisibleHScroll(bool _value);
        bool isVisibleHScroll() const;
        size_t getHScrollRange() const;
        size_t getHScrollPosition();
        void setHScrollPosition(size_t _index);


        virtual void setFontName(const std::string& _value);
        virtual void setFontHeight(int _value);

        virtual void setTextAlign(Align _value);
        virtual void setTextColour(const Colour& _value);

        virtual IntCoord getTextRegion();

        virtual IntSize getTextSize();

        virtual void setTextShadowColour(const Colour& _value);

        virtual void setTextShadow(bool _value);

        /*events:*/
        EventPair<EventHandle_WidgetVoid, EventHandle_EditPtr> eventEditSelectAccept;

        EventPair<EventHandle_WidgetVoid, EventHandle_EditPtr> eventEditTextChange;

    protected:
        virtual void initialiseOverride();
        virtual void shutdownOverride();

        virtual void onMouseDrag(int _left, int _top, MouseButton _id);
        virtual void onKeyLostFocus(Widget* _new);
        virtual void onKeySetFocus(Widget* _old);
        virtual void onKeyButtonPressed(KeyCode _key, Char _char);

        // потом убрать все нотифи в сраку
        void notifyMouseSetFocus(Widget* _sender, Widget* _old);
        void notifyMouseLostFocus(Widget* _sender, Widget* _new);
        void notifyMousePressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseReleased(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseDrag(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseButtonDoubleClick(Widget* _sender);

        void notifyScrollChangePosition(ScrollBar* _sender, size_t _position);
        void notifyMouseWheel(Widget* _sender, int _rel);

        // обновление представления
        void updateView();
        void updateViewWithCursor();

        void eraseView();

        virtual void setPropertyOverride(const std::string& _key, const std::string& _value);

    private:
        // устанавливает текст
        void setText(const UString& _text, bool _history);
        // удаляет все что выделенно
        bool deleteTextSelect(bool _history);
        // вставляет текст в указанную позицию
        void insertText(const UString& _text, size_t _index, bool _history);
        // удаляет текст
        void eraseText(size_t _start, size_t _count, bool _history);
        // выделяет цветом выделение
        void setTextSelectColour(const Colour& _colour, bool _history);
        // выделяет цветом диапазон
        void _setTextColour(size_t _start, size_t _count, const Colour& _colour, bool _history);

        void frameEntered(float _frame);

        void updateEditState();

        // обновляет курсор по координате
        void updateSelectText();

        void resetSelect();

        // запись в историю данных о позиции
        void commandPosition(size_t _undo, size_t _redo, size_t _length, VectorChangeInfo* _info = nullptr);

        // команнды отмена и повтор
        bool commandRedo();
        bool commandUndo();
        // объединяет последние две комманды
        void commandMerge();
        // очистка
        void commandResetRedo();
        void commandResetHistory();
        void saveInHistory(VectorChangeInfo* _info = nullptr);

        // работа с буфером обмена
        void commandCut();
        void commandCopy();
        void commandPast();

        const UString& getRealString();

        void setRealString(const UString& _caption);

        void updateCursorPosition();

        // размер данных
        virtual IntSize getContentSize();
        // смещение данных
        virtual IntPoint getContentPosition();
        virtual void setContentPosition(const IntPoint& _point);
        // размер окна, через которые видно данные
        virtual IntSize getViewSize();
        // размер на который прокручиваются данные при щелчке по скролу
        virtual size_t getVScrollPage();
        virtual size_t getHScrollPage();

        virtual Align getContentAlign();

    protected:
        // нажата ли кнопка
        bool mIsPressed;
        // в фокусе ли кнопка
        bool mIsFocus;

        bool mCursorActive;
        float mCursorTimer;
        float mActionMouseTimer;

        // позиция курсора
        size_t mCursorPosition;
        // максимальное колличество
        size_t mTextLength;

        // выделение
        size_t mStartSelect;
        size_t mEndSelect;

        // списоки изменений для отмены и повтора
        DequeUndoRedoInfo mVectorUndoChangeInfo;
        DequeUndoRedoInfo mVectorRedoChangeInfo;

        bool mMouseLeftPressed;

        bool mModeReadOnly;
        bool mModePassword;
        bool mModeMultiline;
        bool mModeStatic;
        bool mModeWordWrap;

        bool mTabPrinting;

        // настоящий текст, закрытый за звездочками
        UString mPasswordText;

        // для поддержки режима статик, где курсор не нужен
        std::string mOriginalPointer;

        Char mCharPassword;

        bool mOverflowToTheLeft;
        size_t mMaxTextLength;

        ISubWidgetText* mClientText;
    };

} // namespace MyGUI

#endif // __MYGUI_EDIT_BOX_H__