#include <qquickapplication_p.h>

Inheritance diagram for QQuickApplication:

Collaboration diagram for QQuickApplication:

Signals
void	activeChanged ()

void	displayNameChanged ()

void	layoutDirectionChanged ()

void	stateChanged (Qt::ApplicationState state)

void	screensChanged ()

Signals inherited from QQmlApplication
void	aboutToQuit ()

void	nameChanged ()

void	versionChanged ()

void	organizationChanged ()

void	domainChanged ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickApplication (QObject *parent=nullptr)
	\qmlproperty bool Application::active

virtual	~QQuickApplication ()

bool	active () const

Qt::LayoutDirection	layoutDirection () const

bool	supportsMultipleWindows () const

Qt::ApplicationState	state () const

QFont	font () const

QQmlListProperty< QQuickScreenInfo >	screens ()

QString	displayName () const

void	setDisplayName (const QString &displayName)

QStyleHints *	styleHints ()

Public Member Functions inherited from QQmlApplication
	QQmlApplication (QObject *parent=nullptr)

QStringList	args ()

QString	name () const

QString	version () const

QString	organization () const

QString	domain () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Properties
bool	active

Qt::LayoutDirection	layoutDirection

bool	supportsMultipleWindows

Qt::ApplicationState	state

QFont	font

QString	displayName

QQmlListProperty< QQuickScreenInfo >	screens

QStyleHints *	styleHints

Properties inherited from QQmlApplication
QStringList	arguments

QString	name

QString	version

QString	organization

QString	domain

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QQmlApplication
void	setName (const QString &arg)

void	setVersion (const QString &arg)

void	setOrganization (const QString &arg)

void	setDomain (const QString &arg)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QQmlApplication
	QQmlApplication (QQmlApplicationPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 31 of file qquickapplication_p.h.

Constructor & Destructor Documentation

◆ QQuickApplication()

QT_BEGIN_NAMESPACE QQuickApplication::QQuickApplication ( QObject * parent = nullptr )

explicit

\qmlproperty bool Application::active

\qmltype Application
\instantiates QQuickApplication
\inqmlmodule QtQuick

! once exposed: \inherits CoreApplication? ! TODO:?

\brief Provides access to global application
state properties shared by many QML components.

The Application singleton exposes a subset of QApplication's properties to
QML applications.

It also provides an aboutToQuit() signal, which is the same as
QCoreApplication::aboutToQuit().

\qml
import QtQuick

Window {
    id: root
    visible: true
    width: 800
    height: 680

    title: `${Application.name} (${Application.version})`

    Connections {
        target: Application
        function onAboutToQuit() {
            console.log("Bye!")
        }
    }
}
\endqml

\sa SystemPalette

Deprecated: [5.2]

Returns whether the application is active. Use Application.state == Qt.ApplicationActive instead

\qmlproperty Qt::ApplicationState Application::state

This property represents the current state of the application.

\qml Timer { interval: 1000; repeat: true active: Application.state === Qt.Qt.ApplicationActive onTriggered: imageFetcher.fetchLatestImages() } \endqml

\qmlproperty Qt::LayoutDirection Application::layoutDirection

This read-only property can be used to query the default layout direction of the application. On system start-up, the default layout direction depends on the application's language. The property has a value of Qt.RightToLeft in locales where text and graphic elements are read from right to left, and Qt.LeftToRight where the reading direction flows from left to right. You can bind to this property to customize your application layouts to support both layout directions.

\qml RowLayout { layoutDirection: Application.layoutDirection } \endqml

\qmlproperty bool Application::supportsMultipleWindows

Returns true if the platform supports multiple windows. Some embedded platforms do not support multiple windows, for example.

\qmlproperty QFont Application::font Returns the default application font as returned by \l QGuiApplication::font().

\qmlproperty QString Application::displayName

This property represents the application display name set on the QGuiApplication instance. This property can be written to in order to set the application display name.

\qml Binding { target: Application property: "displayName" value: "My Awesome Application" } \endqml

\qmlproperty QQmlListProperty<QQuickScreenInfo> Application::screens

An array containing the descriptions of all connected screens. The elements of the array are objects with the same properties as the \l{Screen} attached object. In practice the array corresponds to the screen list returned by QGuiApplication::screens(). In addition to examining properties like name, width, height, etc., the array elements can also be assigned to the screen property of Window items, thus serving as an alternative to the C++ side's QWindow::setScreen().

See also: Screen, Window, {Window::screen}{Window.screen}

\qmlproperty QStringList Application::arguments

This is a string list of the arguments the executable was invoked with.

\qmlproperty QString Application::name

This is the application name set on the QCoreApplication instance. This property can be written to in order to set the application name.

\qmlproperty QString Application::version

This is the application version set on the QCoreApplication instance. This property can be written to in order to set the application version.

\qmlproperty QString Application::organization

This is the organization name set on the QCoreApplication instance. This property can be written to in order to set the organization name.

\qmlproperty QString Application::domain

This is the organization domain set on the QCoreApplication instance. This property can be written to in order to set the organization domain.

\qmlproperty StyleHints Application::styleHints

The styleHints property provides platform-specific style hints and settings. See the \l QStyleHints documentation for further details.

The following example uses styleHints to determine whether an item should gain focus on mouse press or touch release:

import QtQuick
 
MouseArea {
    id: button
 
    onPressed: {
        if (!Application.styleHints.setFocusOnTouchRelease)
            button.forceActiveFocus()
    }
    onReleased: {
        if (Application.styleHints.setFocusOnTouchRelease)
            button.forceActiveFocus()
    }
}

\qmlsignal Application::aboutToQuit()

This signal is emitted when the application is about to quit the main event loop. The signal is particularly useful if your application has to do some last-second cleanup. User interaction is not possible in this state. For more information, see \l {Window::closing()}{Window.closing}.

See also: QCoreApplication::aboutToQuit

Definition at line 214 of file qquickapplication.cpp.

References activeChanged(), app, QGuiApplication::applicationDisplayNameChanged(), QGuiApplication::applicationStateChanged(), QObject::connect(), displayNameChanged(), QCoreApplication::instance(), layoutDirectionChanged(), QGuiApplication::layoutDirectionChanged(), QGuiApplication::primaryScreenChanged(), QGuiApplication::screenAdded(), QGuiApplication::screenRemoved(), and stateChanged().

Here is the call graph for this function:

◆ ~QQuickApplication()

QQuickApplication::~QQuickApplication ( )

virtual

Definition at line 235 of file qquickapplication.cpp.

Member Function Documentation

◆ active()

bool QQuickApplication::active ( ) const

Definition at line 239 of file qquickapplication.cpp.

References Qt::ApplicationActive, and QGuiApplication::applicationState().

Here is the call graph for this function:

◆ activeChanged

void QQuickApplication::activeChanged ( )

signal

Referenced by QQuickApplication().

Here is the caller graph for this function:

◆ displayName()

QString QQuickApplication::displayName ( ) const

Definition at line 264 of file qquickapplication.cpp.

References QGuiApplication::applicationDisplayName.

◆ displayNameChanged

void QQuickApplication::displayNameChanged ( )

signal

Referenced by QQuickApplication().

Here is the caller graph for this function:

◆ font()

QFont QQuickApplication::font ( ) const

Definition at line 259 of file qquickapplication.cpp.

References QGuiApplication::font().

Here is the call graph for this function:

◆ layoutDirection()

Qt::LayoutDirection QQuickApplication::layoutDirection ( ) const

Definition at line 244 of file qquickapplication.cpp.

References QGuiApplication::layoutDirection.

◆ layoutDirectionChanged

void QQuickApplication::layoutDirectionChanged ( )

signal

Referenced by QQuickApplication().

Here is the caller graph for this function:

◆ screens()

QQmlListProperty< QQuickScreenInfo > QQuickApplication::screens ( )

◆ screensChanged

void QQuickApplication::screensChanged ( )

signal

◆ setDisplayName()

void QQuickApplication::setDisplayName ( const QString & displayName )

Definition at line 274 of file qquickapplication.cpp.

References displayName, and QGuiApplication::setApplicationDisplayName().

Here is the call graph for this function:

◆ state()

Qt::ApplicationState QQuickApplication::state ( ) const

Definition at line 254 of file qquickapplication.cpp.

References QGuiApplication::applicationState().

Here is the call graph for this function:

◆ stateChanged

void QQuickApplication::stateChanged ( Qt::ApplicationState state )

signal

Referenced by QQuickApplication().

Here is the caller graph for this function:

◆ styleHints()

QStyleHints * QQuickApplication::styleHints ( )

◆ supportsMultipleWindows()

bool QQuickApplication::supportsMultipleWindows ( ) const

Definition at line 249 of file qquickapplication.cpp.

References QPlatformIntegration::MultipleWindows, and QGuiApplicationPrivate::platformIntegration().

Here is the call graph for this function:

Property Documentation

◆ active

bool QQuickApplication::active

read

Definition at line 34 of file qquickapplication_p.h.

◆ displayName

QString QQuickApplication::displayName

readwrite

Definition at line 39 of file qquickapplication_p.h.

Referenced by setDisplayName().

◆ font

QFont QQuickApplication::font

read

Definition at line 38 of file qquickapplication_p.h.

◆ layoutDirection

Qt::LayoutDirection QQuickApplication::layoutDirection

read

Definition at line 35 of file qquickapplication_p.h.

◆ screens

QQmlListProperty< QQuickScreenInfo > QQuickApplication::screens

read

Definition at line 40 of file qquickapplication_p.h.

◆ state

Qt::ApplicationState QQuickApplication::state

read

Definition at line 37 of file qquickapplication_p.h.

◆ styleHints

QStyleHints * QQuickApplication::styleHints

read

Definition at line 41 of file qquickapplication_p.h.

◆ supportsMultipleWindows

bool QQuickApplication::supportsMultipleWindows

read

Definition at line 36 of file qquickapplication_p.h.

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

qtdeclarative/src/quick/util/qquickapplication_p.h (9dd45fff835a7c261dacc9ee6239d42ef1a74bbe)
qtdeclarative/src/quick/util/qquickapplication.cpp (214f7f89042ca12b8ff1b50f19ce3a994b8b13ab)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickApplication()

◆ ~QQuickApplication()

Member Function Documentation

◆ active()

◆ activeChanged

◆ displayName()

◆ displayNameChanged

◆ font()

◆ layoutDirection()

◆ layoutDirectionChanged

◆ screens()

◆ screensChanged

◆ setDisplayName()

◆ state()

◆ stateChanged

◆ styleHints()

◆ supportsMultipleWindows()

Property Documentation

◆ active

◆ displayName

◆ font

◆ layoutDirection

◆ screens

◆ state

◆ styleHints

◆ supportsMultipleWindows