Settings Class Reference

#include <settings.h>

Inheritance diagram for Settings:

Properties
QVariant	applicationWindowIcon
bool	hasPlatformMenuBar
bool	hasTransientTouchInput
QStringList	information
bool	isMobile
int	mouseWheelScrollLines
QString	style
bool	tabletMode
bool	tabletModeAvailable
Properties inherited from QObject
	objectName

Signals
void	hasTransientTouchInputChanged ()
void	isMobileChanged ()
void	tabletModeAvailableChanged ()
void	tabletModeChanged ()

Public Member Functions
	Settings (QObject *parent=nullptr)
QVariant	applicationWindowIcon () const
bool	hasPlatformMenuBar () const
bool	hasTransientTouchInput () const
QStringList	information () const
bool	isMobile () const
bool	isTabletModeAvailable () const
int	mouseWheelScrollLines () const
void	setIsMobile (bool mobile)
void	setStyle (const QString &style)
void	setTabletMode (bool tablet)
void	setTabletModeAvailable (bool mobile)
void	setTransientTouchInput (bool touch)
QString	style () const
bool	tabletMode () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, 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
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
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_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	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	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
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	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static Settings *	self ()
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)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
bool	eventFilter (QObject *watched, QEvent *event) override
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 Attributes inherited from QObject
typedef	QObjectList

Detailed Description

This class contains global kirigami settings about the current device setup It is exposed to QML as the singleton "Settings".

Definition at line 16 of file settings.h.

Property Documentation

applicationWindowIcon

QVariant Settings::applicationWindowIcon

read

This property holds the name of the application window icon.

See also

QGuiApplication::windowIcon()

Since

5.62

org.kde.kirigami 2.10

Definition at line 86 of file settings.h.

hasPlatformMenuBar

bool Settings::hasPlatformMenuBar

read

This property holds whether the system has a platform menu bar; e.g.

a user is on macOS or has a global menu on KDE Plasma.

Warning

Android has a platform menu bar; which may not be what you expected.

Definition at line 51 of file settings.h.

hasTransientTouchInput

bool Settings::hasTransientTouchInput

read

This property holds whether the user in this moment is interacting with the app with the touch screen.

Definition at line 57 of file settings.h.

information

QStringList Settings::information

read

This property holds the runtime information about the libraries in use.

Since

5.52

org.kde.kirigami 2.6

Definition at line 77 of file settings.h.

isMobile

bool Settings::isMobile

read

This property holds whether the application is running on a small mobile device such as a mobile phone.

This is used when we want to do specific adaptations to the UI for small screen form factors, such as having bigger touch areas.

Definition at line 33 of file settings.h.

mouseWheelScrollLines

int Settings::mouseWheelScrollLines

read

This property holds the number of lines of text the mouse wheel should scroll.

Definition at line 69 of file settings.h.

style

QString Settings::style

read

This property holds the name of the QtQuickControls2 style the application is using, for instance org.kde.desktop, Plasma, Material, Universal etc.

Definition at line 63 of file settings.h.

tabletMode

bool Settings::tabletMode

read

This property holds whether the application is running on a device that is behaving like a tablet.

Note

This doesn't mean exactly a tablet form factor, but that the preferred input mode for the device is the touch screen and that pointer and keyboard are either secondary or not available.

Definition at line 43 of file settings.h.

tabletModeAvailable

bool Settings::tabletModeAvailable

read

This property holds whether the system can dynamically enter and exit tablet mode (or the device is actually a tablet).

This is the case for foldable convertibles and transformable laptops that support keyboard detachment.

Definition at line 26 of file settings.h.

---

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

• settings.h
• settings.cpp