AbstractKirigamiApplication Class Reference

Inheritance diagram for AbstractKirigamiApplication:

Properties
QML_ELEMENTQSortFilterProxyModel *	actionsModel
QObject *	configurationView
QAbstractListModel *	shortcutsModel
Properties inherited from QObject
	objectName

Signals
void	configurationViewChanged ()
void	openAboutKDEPage ()
void	openAboutPage ()
void	openKCommandBarAction ()
void	shortcutsEditorAction ()

Public Member Functions
	AbstractKirigamiApplication (QObject *parent=nullptr)
virtual	~AbstractKirigamiApplication ()
Q_INVOKABLE QAction *	action (const QString &actionName)
virtual QList< KirigamiActionCollection * >	actionCollections () const
QSortFilterProxyModel *	actionsModel ()
QObject *	configurationView () const
KirigamiActionCollection *	mainCollection () const
void	setConfigurationView (QObject *configurationView)
QAbstractListModel *	shortcutsModel ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
void	readSettings ()
virtual void	setupActions ()
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Detailed Description

The main container for your actions.

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
    }
}

{}

Since

KirigamiAddons 1.4.0

Definition at line 75 of file abstractkirigamiapplication.h.

Property Documentation

actionsModel

QSortFilterProxyModel * AbstractKirigamiApplication::actionsModel

read

Used by StatefulApp.ManagedWindow

Definition at line 82 of file abstractkirigamiapplication.h.

configurationView

QObject * AbstractKirigamiApplication::configurationView

readwrite

This property holds the configurationView of the application.

When set, AbstractKirigamiApplication will setup a "options_configure" action that will open the configurationView when triggered.

Definition at line 91 of file abstractkirigamiapplication.h.

shortcutsModel

QAbstractListModel * AbstractKirigamiApplication::shortcutsModel

read

Used by StatefulApp.ManagedWindow

Definition at line 85 of file abstractkirigamiapplication.h.

Constructor & Destructor Documentation

AbstractKirigamiApplication()

AbstractKirigamiApplication::AbstractKirigamiApplication ( QObject * parent = nullptr )

explicit

Default constructor of AbstractKirigamiApplication.

Definition at line 29 of file abstractkirigamiapplication.cpp.

~AbstractKirigamiApplication()

AbstractKirigamiApplication::~AbstractKirigamiApplication ( )

virtual

Default destructor of AbstractKirigamiApplication.

Definition at line 36 of file abstractkirigamiapplication.cpp.

Member Function Documentation

action()

QAction * AbstractKirigamiApplication::action

(

const QString &

actionName

)

Get the named action.

Returns

nullptr is not such action is defined.

Definition at line 113 of file abstractkirigamiapplication.cpp.

actionCollections()

QList< KirigamiActionCollection * > AbstractKirigamiApplication::actionCollections ( ) const

virtual

Return the list of KirigamiActionCollection setup in your application.

Overwrite this method if you are using custom collections.

Definition at line 128 of file abstractkirigamiapplication.cpp.

actionsModel()

QSortFilterProxyModel * AbstractKirigamiApplication::actionsModel

(

)

Used by StatefulApp.StatefulWindow

configurationView()

QObject * AbstractKirigamiApplication::configurationView

(

)

const

Getter for the configurationView property.

Definition at line 188 of file abstractkirigamiapplication.cpp.

configurationViewChanged

void AbstractKirigamiApplication::configurationViewChanged ( )

signal

Changed signal for the configurationView property.

mainCollection()

KirigamiActionCollection * AbstractKirigamiApplication::mainCollection

(

)

const

Return the main action collection.

Definition at line 135 of file abstractkirigamiapplication.cpp.

openAboutKDEPage

void AbstractKirigamiApplication::openAboutKDEPage ( )

signal

Used by StatefulApp.StatefulWindow

openAboutPage

void AbstractKirigamiApplication::openAboutPage ( )

signal

Used by StatefulApp.StatefulWindow

openKCommandBarAction

void AbstractKirigamiApplication::openKCommandBarAction ( )

signal

Used by StatefulApp.StatefulWindow

readSettings()

void AbstractKirigamiApplication::readSettings ( )

protected

Read the configured settings for the action.

Definition at line 74 of file abstractkirigamiapplication.cpp.

setConfigurationView()

void AbstractKirigamiApplication::setConfigurationView

(

QObject *

configurationView

)

Setter for the configurationView property.

Definition at line 193 of file abstractkirigamiapplication.cpp.

setupActions()

void AbstractKirigamiApplication::setupActions ( )

protectedvirtual

Entry points to declare your actions.

Don't forget to call the parent implementation to get the following actions setup for you:

• CommandBar
• About page for your application
• About page for KDE

Once the actions are setup, call readSettings to read the configured shortcuts.

Definition at line 140 of file abstractkirigamiapplication.cpp.

shortcutsEditorAction

void AbstractKirigamiApplication::shortcutsEditorAction ( )

signal

Used by StatefulApp.StatefulWindow

shortcutsModel()

QAbstractListModel * AbstractKirigamiApplication::shortcutsModel

(

)

Used by the shortcuts editor

---

The documentation for this class was generated from the following files:

• abstractkirigamiapplication.h
• abstractkirigamiapplication.cpp