AbstractKirigamiApplication Class

Detailed Description

AbstractKirigamiApplication is a class that needs to be inherited in your application.

It allows to expose the various actions of your application to the QML frontend. Depending on the complexitiy of the application, you can either reimplement setupActions only and put all your actions inside the mainCollection, or, if you want to organize your actions in multiple collections, you can also expose the custom collections by overwriting actionCollections.

class MyKoolApp : public AbstractKirigamiApplication
{
    Q_OBJECT
    QML_ELEMENT

 public:
    explicit MyKoolApp(QObject *parent = nullptr);

    void setupActions() override;
};

MyKoolApp::MyKoolApp(QObject *parent)
    : AbstractKirigamiApplication(parent)
{
     setupActions();
}

void MyKoolApp::setupActions()
{
    AbstractKirigamiApplication::setupActions();

    auto actionName = QLatin1String("add_notebook");
    if (KAuthorized::authorizeAction(actionName)) {
        auto action = mainCollection()->addAction(actionName, this, &MyKoolApp::newNotebook);
        action->setText(i18nc("@action:inmenu", "New Notebook"));
        action->setIcon(QIcon::fromTheme(QStringLiteral("list-add-symbolic")));
        mainCollection()->addAction(action->objectName(), action);
        mainCollection()->setDefaultShortcut(action, QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_N));
    }
}

The application object then need to be assigned to the application property in a StatefulWindow.

import org.kde.kirigamiaddons.StatefulApplication as StatefulApplication

StatefulApplication.StatefulWindow {
    id: root

    application: MyKoolApp {}

    StatefulApplication.Action {
        actionName: 'add_notebook'
        application: root.application
    }
}

{}