AAbstractTypeable.h

/*
 * AUI Framework - Declarative UI toolkit for modern C++20
 * Copyright (C) 2020-2024 Alex2772 and Contributors
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
 
#include <AUI/Util/ACursorSelectable.h>
#include <AUI/Enum/ATextInputActionIcon.h>
#include <AUI/Enum/ATextInputType.h>
#include "AUI/Common/ATimer.h"
#include "AUI/Render/IRenderer.h"
#include "AUI/Font/IFontView.h"

class API_AUI_VIEWS AAbstractTypeable: public ACursorSelectable {
public:
    AAbstractTypeable();
    ~AAbstractTypeable() override;
 
    void clear() {
        setText({});
    }
    void setMaxTextLength(size_t newTextLength) {
        mMaxTextLength = newTextLength;
    }
 
    void trimText() {
        setText(getText().trim());
    }
 
    void setCopyable(bool isCopyable) {
        mIsCopyable = isCopyable;
    }
 
    virtual void setText(const AString& t);

    [[nodiscard]]
    virtual bool isPasswordField() const noexcept = 0;

    [[nodiscard]]
    virtual ATextInputType textInputType() const noexcept = 0;

    void setTextInputActionIcon(ATextInputActionIcon textInputActionIcon) noexcept {
        mTextInputActionIcon = textInputActionIcon;
    }

    [[nodiscard]]
    ATextInputActionIcon textInputActionIcon() const noexcept {
        return mTextInputActionIcon;
    }

    void copyToClipboard() const;

    void cutToClipboard();

    void pasteFromClipboard();

    void paste(AString content);

    void moveCursorLeft();

    void moveCursorRight();
 
    virtual void emitTextChanged(const AString& text) = 0;
    virtual void emitTextChanging(const AString& text) = 0;
    virtual void emitActionButtonPressed() = 0;
 
signals:
    emits<AString> textChanged;

    emits<AString> textChanging;

    emits<Selection> selectionChanged;

    emits<> actionButtonPressed;
 
protected:
    size_t mMaxTextLength = 0x200;
    bool mIsMultiline = false;
 
protected:
    bool isCursorBlinkVisible() const {
        return mCursorBlinkVisible;
    }
 
    void updateCursorBlinking();
 
    virtual void typeableErase(size_t begin, size_t end) = 0;

    [[nodiscard]]
    virtual bool typeableInsert(size_t at, const AString& toInsert) = 0;

    [[nodiscard]]
    virtual bool typeableInsert(size_t at, char16_t toInsert) = 0;
    virtual size_t typeableFind(char16_t c, size_t startPos = -1) = 0;
    virtual size_t typeableReverseFind(char16_t c, size_t startPos = -1) = 0;
    virtual void updateSelectionOnTextSet(const AString& t);
 
    virtual void onCursorIndexChanged() = 0;
 

    void enterChar(char16_t c);
 
    AString getDisplayText() override;
    AMenuModel composeContextMenuImpl();
    void handleKey(AInput::Key key);
 
private:
    _<ATimer> mBlinkTimer = blinkTimer();

    ATextInputActionIcon mTextInputActionIcon = ATextInputActionIcon::DEFAULT;
    unsigned mCursorBlinkCount = 0;
    bool mCursorBlinkVisible = true;
    bool mTextChangedFlag = false;
    bool mIsCopyable = true;
 
private:
    static _<ATimer> blinkTimer();
 
    template<aui::derived_from<AView> Super>
    friend class AAbstractTypeableView;
 
    virtual void typeableInvalidateFont() = 0;
    void drawCursorImpl(IRenderer& renderer, glm::ivec2 position, unsigned lineHeight);
 
    void fastenSelection();
};
 
 

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.