MauiApp

Search for usage in LXR

#include <mauiapp.h>

Inheritance diagram for MauiApp:

Properties

KAboutData about
 
QString donationPage
 
QString iconName
 
QString mauikitVersion
 
QObjectrootComponent
 
- Properties inherited from QObject
 objectName
 

Signals

void currentIconThemeChanged (QString currentIconTheme)
 
void donationPageChanged ()
 
void iconNameChanged ()
 
void rootComponentChanged ()
 

Public Member Functions

Q_INVOKABLE void aboutDialog ()
 
KAboutData getAbout () const
 
QString getDonationPage () const
 
QString getIconName () const
 
QObjectrootComponent ()
 
void setDonationPage (const QString &value)
 
void setIconName (const QString &value)
 
Q_INVOKABLE void setRootComponent (QObject *item)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 

Static Public Member Functions

static KAboutComponent aboutMauiKit ()
 
static QString getMauikitVersion ()
 
static MauiAppinstance ()
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

The MauiApp class The MauiApp is a global singleton instance, can be accessed from QML as an attached property, so it can be used by importing org.mauikit.controls

Warning
It is needed that the first instance creation is made on the application main entry point before the QML engine creates the window surface, so the style and other parts are correctly loaded.

Example:

import org.mauikit.controls as Maui
Maui.ApplicationWindow
{
title: Maui.App.about.name
Maui.CSD.enabled: true
}

Definition at line 51 of file mauiapp.h.

Property Documentation

◆ about

KAboutData MauiApp::about
read

The information metadata about the application.

See the KAboutData documentation for more details.

Note
This is the information parsed for feeding the ApplicationWindow's about dialog.

Definition at line 65 of file mauiapp.h.

◆ donationPage

QString MauiApp::donationPage
readwrite

An URL link to the application donation page.

Definition at line 75 of file mauiapp.h.

◆ iconName

QString MauiApp::iconName
readwrite

The URL to the image asset for the application icon.

Definition at line 70 of file mauiapp.h.

◆ mauikitVersion

QString MauiApp::mauikitVersion
read

The formatted MauiKit string version.

Definition at line 80 of file mauiapp.h.

◆ rootComponent

QObject * MauiApp::rootComponent
readwrite

Definition at line 82 of file mauiapp.h.

Member Function Documentation

◆ aboutDialog()

void MauiApp::aboutDialog ( )

Requests to display the about dialog.

Note
This will only work if the root component is a Maui ApplicationWindow

Definition at line 164 of file mauiapp.cpp.

◆ aboutMauiKit()

KAboutComponent MauiApp::aboutMauiKit ( )
static

Retrieves information of the MauiKit framework wrapped into a KAboutComponent object.

Definition at line 42 of file mauiapp.cpp.

◆ getAbout()

KAboutData MauiApp::getAbout ( ) const

Gather information about this module.

Returns

Definition at line 118 of file mauiapp.cpp.

◆ getDonationPage()

QString MauiApp::getDonationPage ( ) const

Donation web page link.

Returns
URL link

Definition at line 104 of file mauiapp.cpp.

◆ getIconName()

QString MauiApp::getIconName ( ) const

The file URL to the application icon.

Definition at line 90 of file mauiapp.cpp.

◆ getMauikitVersion()

QString MauiApp::getMauikitVersion ( )
static

The formatted MauiKit version string.

Definition at line 85 of file mauiapp.cpp.

◆ instance()

MauiApp * MauiApp::instance ( )
static

Retrieves the single instance of MauiApp.

Definition at line 144 of file mauiapp.cpp.

◆ setDonationPage()

void MauiApp::setDonationPage ( const QString & value)

Set the donation web page link.

Parameters
valuethe URL link

Definition at line 109 of file mauiapp.cpp.

◆ setIconName()

void MauiApp::setIconName ( const QString & value)

Set the file URL to the application icon.

Usually it is a self contained URL

Definition at line 95 of file mauiapp.cpp.

◆ setRootComponent()

void MauiApp::setRootComponent ( QObject * item)

Define the root element of the Maui Application.

Usually the root element is expected to be a QWindow derived element.

See also
ApplicationWindow

Definition at line 149 of file mauiapp.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:16:19 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.