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
{
 
    using EventHandle_EditPtr = delegates::MultiDelegate<EditBox*>;
 
    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) const;
 
        void setTextSelection(size_t _start, size_t _end);
 
        void deleteTextSelection();
 
        UString getTextSelection() const;
 
        bool isTextSelection() const;
 
        void setTextSelectionColour(const Colour& _colour);
 
        void setTextCursor(size_t _index);
        size_t getTextCursor() const;
 
 
        void setCaption(const UString& _value) override;
        const UString& getCaption() const override;
 
        void setOnlyText(const UString& _text);
        UString getOnlyText() const;
 
        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 _password);
        bool getEditPassword() const;
 
        void setEditMultiLine(bool _value);
        bool getEditMultiLine() const;
 
        void setEditStatic(bool _value);
        bool getEditStatic() const;
 
        void setPasswordChar(Char _char);
        void setPasswordChar(const UString& _value);
        Char getPasswordChar() const;
 
        void setEditWordWrap(bool _value);
        bool getEditWordWrap() const;
 
        void setTabPrinting(bool _value);
        bool getTabPrinting() const;
 
        bool getInvertSelected() const;
        void setInvertSelected(bool _value);
 
        void setPosition(const IntPoint& _point) override;
        void setSize(const IntSize& _size) override;
        void setCoord(const IntCoord& _coord) override;
 
        using Widget::setPosition;
        using Widget::setSize;
        using Widget::setCoord;
 
        void setVisibleVScroll(bool _value);
        bool isVisibleVScroll() const;
        size_t getVScrollRange() const;
        size_t getVScrollPosition() const;
        void setVScrollPosition(size_t _index);
 
        void setVisibleHScroll(bool _value);
        bool isVisibleHScroll() const;
        size_t getHScrollRange() const;
        size_t getHScrollPosition() const;
        void setHScrollPosition(size_t _index);
 
 
        void setFontName(std::string_view _value) override;
        void setFontHeight(int _value) override;
        int getFontHeight() const override;
 
        void setTextAlign(Align _value) override;
        void setTextColour(const Colour& _value) override;
 
        IntCoord getTextRegion() const override;
 
        IntSize getTextSize() const override;
 
        void setTextShadowColour(const Colour& _value) override;
 
        void setTextShadow(bool _value) override;
 
        /*events:*/
        EventPair<EventHandle_WidgetVoid, EventHandle_EditPtr> eventEditSelectAccept;
 
        EventPair<EventHandle_WidgetVoid, EventHandle_EditPtr> eventEditTextChange;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        void onMouseDrag(int _left, int _top, MouseButton _id) override;
        void onKeyLostFocus(Widget* _new) override;
        void onKeySetFocus(Widget* _old) override;
        void onKeyButtonPressed(KeyCode _key, Char _char) override;
 
        // потом убрать все нотифи в сраку
        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();
 
        void setPropertyOverride(std::string_view _key, std::string_view _value) override;
 
    private:
        // устанавливает текст
        void setText(const UString& _caption, bool _history);
        // удаляет все что выделенно
        bool deleteTextSelect(bool _history);
        // вставляет текст в указанную позицию
        void insertText(const UString& _text, size_t _start, 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);
 
        // clipboard commands
        void commandCut();
        void commandCopy() const;
        void commandPaste();
 
        const UString& getRealString() const;
 
        void setRealString(const UString& _caption);
 
        void updateCursorPosition();
 
        // размер данных
        IntSize getContentSize() const override;
        // смещение данных
        IntPoint getContentPosition() const override;
        void setContentPosition(const IntPoint& _point) override;
        // размер окна, через которые видно данные
        IntSize getViewSize() const override;
        // размер на который прокручиваются данные при щелчке по скролу
        size_t getVScrollPage() const override;
        size_t getHScrollPage() const override;
 
        Align getContentAlign() const override;
 
    protected:
        // нажата ли кнопка
        bool mIsPressed{false};
        // в фокусе ли кнопка
        bool mIsFocus{false};
 
        bool mCursorActive{false};
        float mCursorTimer{0};
        float mActionMouseTimer{0};
 
        // позиция курсора
        size_t mCursorPosition{0};
        // максимальное колличество
        size_t mTextLength{0};
 
        // выделение
        size_t mStartSelect{ITEM_NONE};
        size_t mEndSelect{0};
 
        // списоки изменений для отмены и повтора
        DequeUndoRedoInfo mVectorUndoChangeInfo;
        DequeUndoRedoInfo mVectorRedoChangeInfo;
 
        bool mMouseLeftPressed{false};
 
        bool mModeReadOnly{false};
        bool mModePassword{false};
        bool mModeMultiline{false};
        bool mModeStatic{false};
        bool mModeWordWrap{false};
 
        bool mTabPrinting{false};
 
        // настоящий текст, закрытый за звездочками
        UString mPasswordText;
 
        // для поддержки режима статик, где курсор не нужен
        std::string mOriginalPointer;
 
        Char mCharPassword{'*'};
 
        bool mOverflowToTheLeft{false};
        size_t mMaxTextLength;
 
        ISubWidgetText* mClientText{nullptr};
    };
 
} // namespace MyGUI
 
#endif // MYGUI_EDIT_BOX_H_