fontkeyboard.h

Go to the documentation of this file.

/*
  * Copyright 2026 Twilight
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
*/
#pragma once
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariantList>
#include <QVariantMap>

class FontKeyboard : public QObject
{
  Q_OBJECT
 
  Q_PROPERTY(int page READ getPage WRITE setPage NOTIFY pageChanged)   
  Q_PROPERTY(QStringList pageNames READ getPageNames CONSTANT)         
  Q_PROPERTY(QVariantList pageOrder READ getPageOrder CONSTANT)        
  Q_PROPERTY(int pageCount READ getPageCount CONSTANT)                 
 
public:
  enum Render {
    RenderEmpty = 0,   
    RenderTile,        
    RenderPreview,     
    RenderLabel,       
  };
  Q_ENUM(Render)
 
  
  enum Category {
    CatNone = 0,
    CatNormal,
    CatSingle,
    CatMulti,
    CatVariable,
    CatPicture,
    CatControl,
  };
  Q_ENUM(Category)
 
  explicit FontKeyboard(QObject* parent = nullptr);
 
  static constexpr int pageTotal = 8;  
  static constexpr int keyTotal = 47;
 
  int getPage() const;                 
  void setPage(int val);               
  QStringList getPageNames() const;    
  QVariantList getPageOrder() const;   
  int getPageCount() const;            

  Q_INVOKABLE static QStringList keyLabels();

  Q_INVOKABLE static int pageFor(bool shift, bool ctrl, bool alt);

  Q_INVOKABLE static int effectivePage(bool shift, bool ctrl, bool alt, bool caps);

  Q_INVOKABLE QVariantMap keyDataFor(const QString& key,
                                     bool shift, bool ctrl, bool alt, bool caps) const;

  Q_INVOKABLE static QString pageBadge(int page);

  Q_INVOKABLE static int indFor(int page, const QString& key);

  Q_INVOKABLE static QString naturalChar(const QString& key, bool shift);

  Q_INVOKABLE static QString pageDescription(int page);

  Q_INVOKABLE QVariantMap keyData(int page, const QString& key) const;

  Q_INVOKABLE QVariantMap spaceData() const;

  Q_INVOKABLE static QString chopLastToken(const QString& str);
 
signals:
  void pageChanged();
 
private:
  QVariantMap dataForInd(int ind, const QString& key, int page) const;
 
  int page = 0; 
};