ES-DE/es-core/src/components/TextEditComponent.h

//  SPDX-License-Identifier: MIT
//
//  EmulationStation Desktop Edition
//  TextEditComponent.h
//
//  Component for editing text fields in menus.
//

#ifndef ES_CORE_COMPONENTS_TEXT_EDIT_COMPONENT_H
#define ES_CORE_COMPONENTS_TEXT_EDIT_COMPONENT_H

#include "components/NinePatchComponent.h"
#include "GuiComponent.h"

class Font;
class TextCache;

// Used to enter text.
class TextEditComponent : public GuiComponent
{
public:
    TextEditComponent(Window* window);

    void textInput(const std::string& text) override;
    bool input(InputConfig* config, Input input) override;
    void update(int deltaTime) override;
    void render(const Transform4x4f& parentTrans) override;

    void onFocusGained() override;
    void onFocusLost() override;

    void onSizeChanged() override;

    void setValue(const std::string& val) override;
    std::string getValue() const override;

    void startEditing();
    void stopEditing();

    inline bool isEditing() const { return mEditing; };
    inline std::shared_ptr<Font> getFont() const override{ return mFont; }

    void setCursor(size_t pos);

    virtual std::vector<HelpPrompt> getHelpPrompts() override;

private:
    void onTextChanged();
    void onCursorChanged();

    void updateCursorRepeat(int deltaTime);
    void moveCursor(int amt);

    bool isMultiline();
    Vector2f getTextAreaPos() const;
    Vector2f getTextAreaSize() const;

    std::string mText;
    std::string mTextOrig;
    bool mFocused;
    bool mEditing;
    unsigned int mCursor; // Cursor position in characters.

    int mCursorRepeatTimer;
    int mCursorRepeatDir;

    Vector2f mScrollOffset;

    NinePatchComponent mBox;
    float mResolutionAdjustment;

    std::shared_ptr<Font> mFont;
    std::unique_ptr<TextCache> mTextCache;
};

#endif // ES_CORE_COMPONENTS_TEXT_EDIT_COMPONENT_H