doc/otclient/uitextedit_8h_source.html

/*

 * Copyright (c) 2010-2020 OTClient <https://github.com/edubart/otclient>

 *

 * 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 UITEXTEDIT_H

#define UITEXTEDIT_H


#include "uiwidget.h"


// @bindclass

class UITextEdit : public UIWidget

{

public:

    UITextEdit();


    void drawSelf(Fw::DrawPane drawPane);


private:

    void update(bool focusCursor = false);


public:

    void setCursorPos(int pos);

    void setSelection(int start, int end);

    void setCursorVisible(bool enable) { m_cursorVisible = enable; }

    void setChangeCursorImage(bool enable) { m_changeCursorImage = enable; }

    void setTextHidden(bool hidden);

    void setValidCharacters(const std::string validCharacters) { m_validCharacters = validCharacters; }

    void setShiftNavigation(bool enable) { m_shiftNavigation = enable; }

    void setMultiline(bool enable) { m_multiline = enable; }

    void setMaxLength(uint maxLength) { m_maxLength = maxLength; }

    void setTextVirtualOffset(const Point& offset);

    void setEditable(bool editable) { m_editable = editable; }

    void setSelectable(bool selectable) { m_selectable = selectable; }

    void setSelectionColor(const Color& color) { m_selectionColor = color; }

    void setSelectionBackgroundColor(const Color& color) { m_selectionBackgroundColor = color; }

    void setAutoScroll(bool autoScroll) { m_autoScroll = autoScroll; }


    void moveCursorHorizontally(bool right);

    void moveCursorVertically(bool up);

    void appendText(std::string text);

    void appendCharacter(char c);

    void removeCharacter(bool right);

    void blinkCursor();


    void del(bool right = false);

    void paste(const std::string& text);

    std::string copy();

    std::string cut();

    void selectAll() { setSelection(0, m_text.length()); }

    void clearSelection() { setSelection(0, 0); }


    void wrapText();

    std::string getDisplayedText();

    std::string getSelection();

    int getTextPos(Point pos);

    int getCursorPos() { return m_cursorPos; }

    Point getTextVirtualOffset() { return m_textVirtualOffset; }

    Size getTextVirtualSize() { return m_textVirtualSize; }

    Size getTextTotalSize() { return m_textTotalSize; }

    uint getMaxLength() { return m_maxLength; }

    int getSelectionStart() { return m_selectionStart; }

    int getSelectionEnd() { return m_selectionEnd; }

    Color getSelectionColor() { return m_selectionColor; }

    Color getSelectionBackgroundColor() { return m_selectionBackgroundColor; }

    bool hasSelection() { return m_selectionEnd - m_selectionStart > 0; }

    bool isCursorVisible() { return m_cursorVisible; }

    bool isChangingCursorImage() { return m_changeCursorImage; }

    bool isTextHidden() { return m_textHidden; }

    bool isShiftNavigation() { return m_shiftNavigation; }

    bool isMultiline() { return m_multiline; }

    bool isEditable() { return m_editable; }

    bool isSelectable() { return m_selectable; }

    bool isAutoScrolling() { return m_autoScroll; }


protected:

    void updateText();


    virtual void onHoverChange(bool hovered);

    virtual void onStyleApply(const std::string& styleName, const OTMLNodePtr& styleNode);

    virtual void onGeometryChange(const Rect& oldRect, const Rect& newRect);

    virtual void onFocusChange(bool focused, Fw::FocusReason reason);

    virtual bool onKeyText(const std::string& keyText);

    virtual bool onKeyPress(uchar keyCode, int keyboardModifiers, int autoRepeatTicks);

    virtual bool onMousePress(const Point& mousePos, Fw::MouseButton button);

    virtual bool onMouseRelease(const Point& mousePos, Fw::MouseButton button);

    virtual bool onMouseMove(const Point& mousePos, const Point& mouseMoved);

    virtual bool onDoubleClick(const Point& mousePos);

    virtual void onTextAreaUpdate(const Point& vitualOffset, const Size& visibleSize, const Size& totalSize);


private:

    void disableUpdates() { m_updatesEnabled = false; }

    void enableUpdates() { m_updatesEnabled = true; }

    void recacheGlyphs() { m_glyphsMustRecache = true; }


    Rect m_drawArea;

    int m_cursorPos;

    Point m_textVirtualOffset;

    Size m_textVirtualSize;

    Size m_textTotalSize;

    ticks_t m_cursorTicks;

    bool m_textHidden;

    bool m_shiftNavigation;

    bool m_multiline;

    bool m_cursorInRange;

    bool m_cursorVisible;

    bool m_editable;

    bool m_changeCursorImage;

    std::string m_validCharacters;

    uint m_maxLength;

    bool m_updatesEnabled;

    bool m_autoScroll;


    bool m_selectable;

    int m_selectionReference;

    int m_selectionStart;

    int m_selectionEnd;


    Color m_selectionColor;

    Color m_selectionBackgroundColor;


    std::vector<Rect> m_glyphsCoords;

    std::vector<Rect> m_glyphsTexCoords;


    CoordsBuffer m_glyphsTextCoordsBuffer;

    CoordsBuffer m_glyphsSelectCoordsBuffer;

    bool m_glyphsMustRecache;

};


#endif