qwerty_ui.h

/*
 * Copyright © 2018-2023 Synthstrom Audible Limited
 *
 * This file is part of The Synthstrom Audible Deluge Firmware.
 *
 * The Synthstrom Audible Deluge Firmware is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "gui/ui/ui.h"
#include "model/favourite/favourite_manager.h"
#include "util/d_string.h"
#include <cstdint>
 
class QwertyUI : public UI {
public:
    QwertyUI() = default;
    ActionResult padAction(int32_t x, int32_t y, int32_t velocity) override;
    ActionResult horizontalEncoderAction(int32_t offset) override;
    ActionResult timerCallback() override;
    bool renderMainPads(uint32_t whichRows, RGB image[][kDisplayWidth + kSideBarWidth] = nullptr,
                        uint8_t occupancyMask[][kDisplayWidth + kSideBarWidth] = nullptr,
                        bool drawUndefinedArea = true) override {
        return true;
    }
 
    static bool predictionInterrupted;
    static String enteredText;
 
protected:
    bool opened() override;
    virtual bool predictExtendedText() { return true; } // Returns whether we're allowed that new character.
    void drawKeys();
    virtual void processBackspace(); // May be called in card routine
    virtual void enterKeyPress() = 0;
 
    // This may be called in card routine so long as either !currentFileExists (which is always the case in a
    // processBackspace()), or we are not LoadSongUI
 
    char const* title;
    void drawTextForOLEDEditing(int32_t textStartX, int32_t xPixelMax, int32_t yPixel, int32_t maxChars,
                                deluge::hid::display::oled_canvas::Canvas& canvas);
 
    // 7SEG only
    virtual void displayText(bool blinkImmediately = false);
 
    // Favourites
    void renderFavourites();
 
    static uint8_t favouriteRow;
    static constexpr uint8_t favouriteBankRow = 7;
 
    static int16_t enteredTextEditPos;
    static int32_t scrollPosHorizontal;
    static bool favouritesVisible;
    static bool banksVisible;
 
private:
    static uint8_t currentBank;
    static std::optional<uint8_t> currentFavourite;
    static FavouritesDefaultLayout favouritesLayoutSelected;
};