#include <qqmlsettings_p.h>

Inheritance diagram for QQmlSettings:

Collaboration diagram for QQmlSettings:

Signals
void	categoryChanged (const QString &arg)

void	locationChanged (const QUrl &arg)

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
	QQmlSettings (QObject *parent=nullptr)

	~QQmlSettings () override

QString	category () const
	\qmlproperty string Settings::category

void	setCategory (const QString &category)

QUrl	location () const
	\qmlproperty url Settings::location

void	setLocation (const QUrl &location)

Q_INVOKABLE QVariant	value (const QString &key, const QVariant &defaultValue={}) const
	\qmlmethod var Settings::value(string key, var defaultValue)

Q_INVOKABLE void	setValue (const QString &key, const QVariant &value)
	\qmlmethod Settings::setValue(string key, var value)

Q_INVOKABLE void	sync ()
	\qmlmethod Settings::sync()

	QQmlSettings (QObject *parent=nullptr)

	~QQmlSettings ()

QString	category () const

void	setCategory (const QString &category)

QString	fileName () const
	\qmlproperty string Settings::fileName

void	setFileName (const QString &fileName)

Q_INVOKABLE QVariant	value (const QString &key, const QVariant &defaultValue=QVariant()) const

Q_INVOKABLE void	setValue (const QString &key, const QVariant &value)

Q_INVOKABLE void	sync ()

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`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

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

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

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

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

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

Properties
QString	category

QUrl	location

QString	fileName

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 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 29 of file qqmlsettings_p.h.

Constructor & Destructor Documentation

◆ QQmlSettings() [1/2]

QQmlSettings::QQmlSettings ( QObject * parent = nullptr )

explicit

Definition at line 368 of file qqmlsettings.cpp.

References d.

◆ ~QQmlSettings() [1/2]

QQmlSettings::~QQmlSettings ( )

override

Definition at line 375 of file qqmlsettings.cpp.

References d.

◆ QQmlSettings() [2/2]

QQmlSettings::QQmlSettings ( QObject * parent = nullptr )

explicit

◆ ~QQmlSettings() [2/2]

QQmlSettings::~QQmlSettings ( )

Member Function Documentation

◆ category() [1/2]

QString QQmlSettings::category ( ) const

\qmlproperty string Settings::category

This property holds the name of the settings category.

Categories can be used to group related settings together.

See also: QSettings::group

This property holds the name of the settings category.

Categories can be used to group related settings together.

Definition at line 390 of file qqmlsettings.cpp.

References d.

◆ category() [2/2]

QString QQmlSettings::category ( ) const

◆ categoryChanged

void QQmlSettings::categoryChanged ( const QString & arg )

signal

Referenced by setCategory().

Here is the caller graph for this function:

◆ classBegin() [1/2]

void QQmlSettings::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 485 of file qqmlsettings.cpp.

◆ classBegin() [2/2]

void QQmlSettings::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

◆ componentComplete() [1/2]

void QQmlSettings::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 489 of file qqmlsettings.cpp.

References d.

◆ componentComplete() [2/2]

void QQmlSettings::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

◆ fileName()

QString QQmlSettings::fileName ( ) const

\qmlproperty string Settings::fileName

This property holds the path to the settings file. If the file doesn't already exist, it is created.

Since: Qt 5.12

See also: QSettings::fileName, QSettings::IniFormat

Definition at line 409 of file qqmlsettings.cpp.

References d.

◆ location()

QUrl QQmlSettings::location ( ) const

\qmlproperty url Settings::location

This property holds the path to the settings file. If the file doesn't already exist, it will be created.

If this property is empty (the default), then QSettings::defaultFormat() will be used. Otherwise, QSettings::IniFormat will be used.

See also: QSettings::fileName, QSettings::defaultFormat, QSettings::IniFormat

Definition at line 419 of file qqmlsettings.cpp.

References d.

◆ locationChanged

void QQmlSettings::locationChanged ( const QUrl & arg )

signal

Referenced by setLocation().

Here is the caller graph for this function:

◆ setCategory() [1/2]

void QQmlSettings::setCategory ( const QString & category )

Definition at line 396 of file qqmlsettings.cpp.

References category, categoryChanged(), d, and Q_EMIT.

Here is the call graph for this function:

◆ setCategory() [2/2]

void QQmlSettings::setCategory ( const QString & category )

◆ setFileName()

void QQmlSettings::setFileName ( const QString & fileName )

Definition at line 415 of file qqmlsettings.cpp.

References d, and fileName.

◆ setLocation()

void QQmlSettings::setLocation ( const QUrl & location )

Definition at line 425 of file qqmlsettings.cpp.

References d, location, locationChanged(), and Q_EMIT.

Here is the call graph for this function:

◆ setValue() [1/2]

void QQmlSettings::setValue	(	const QString &	key,
		const QVariant &	value )

\qmlmethod Settings::setValue(string key, var value)

Sets the value of setting key to value. If the key already exists, the previous value is overwritten.

See also: QSettings::setValue

Sets the value of setting key to value. If the key already exists, the previous value is overwritten.

Since: Qt 5.12

See also: QSettings::setValue

Definition at line 459 of file qqmlsettings.cpp.

References d, and qCDebug.

◆ setValue() [2/2]

Q_INVOKABLE void QQmlSettings::setValue	(	const QString &	key,
		const QVariant &	value )

◆ sync() [1/2]

void QQmlSettings::sync ( )

\qmlmethod Settings::sync()

Writes any unsaved changes to permanent storage, and reloads any settings that have been changed in the meantime by another application.

This function is called automatically from QSettings's destructor and by the event loop at regular intervals, so you normally don't need to call it yourself.

See also: QSettings::sync

Definition at line 479 of file qqmlsettings.cpp.

References d.

◆ sync() [2/2]

Q_INVOKABLE void QQmlSettings::sync ( )

◆ timerEvent() [1/2]

void QQmlSettings::timerEvent ( QTimerEvent * event )

overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also: startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 495 of file qqmlsettings.cpp.

References d, QObject::killTimer(), and QObject::timerEvent().

Here is the call graph for this function:

◆ timerEvent() [2/2]

void QQmlSettings::timerEvent ( QTimerEvent * event )

overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also: startTimer(), killTimer(), event()

Reimplemented from QObject.

◆ value() [1/2]

Q_INVOKABLE QVariant QQmlSettings::value	(	const QString &	key,
		const QVariant &	defaultValue = QVariant() ) const

◆ value() [2/2]

QVariant QQmlSettings::value	(	const QString &	key,
		const QVariant &	defaultValue = {} ) const

\qmlmethod var Settings::value(string key, var defaultValue)

Returns the value for setting key. If the setting doesn't exist, returns defaultValue.

See also: QSettings::value

Returns the value for setting key. If the setting doesn't exist, returns defaultValue.

Since: Qt 5.12

See also: QSettings::value

Definition at line 445 of file qqmlsettings.cpp.

References d.

Property Documentation

◆ category

QString QQmlSettings::category

readwrite

Definition at line 37 of file qqmlsettings_p.h.

Referenced by setCategory().

◆ fileName

QString QQmlSettings::fileName

readwrite

Definition at line 34 of file qqmlsettings_p.h.

Referenced by setFileName().

◆ location

QUrl QQmlSettings::location

readwrite

Definition at line 38 of file qqmlsettings_p.h.

Referenced by setLocation().

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

qtdeclarative/src/core/qqmlsettings_p.h (2e458639ffa0a01d81d5ede4b67d10f8338e5902)
qtdeclarative/src/labs/settings/qqmlsettings_p.h (b119723c471cb93a7b210c268e15e8896868bd5f)
qtdeclarative/src/core/qqmlsettings.cpp (16002e56fd1cdef9ebc9b71e8c685177178647e4)
qtdeclarative/src/labs/settings/qqmlsettings.cpp (87115131e7444259cf118dbc86be914b66a1d1b7)

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQmlSettings() [1/2]

◆ ~QQmlSettings() [1/2]

◆ QQmlSettings() [2/2]

◆ ~QQmlSettings() [2/2]

Member Function Documentation

◆ category() [1/2]

◆ category() [2/2]

◆ categoryChanged

◆ classBegin() [1/2]

◆ classBegin() [2/2]

◆ componentComplete() [1/2]

◆ componentComplete() [2/2]

◆ fileName()

◆ location()

◆ locationChanged

◆ setCategory() [1/2]

◆ setCategory() [2/2]

◆ setFileName()

◆ setLocation()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ sync() [1/2]

◆ sync() [2/2]

◆ timerEvent() [1/2]

◆ timerEvent() [2/2]

◆ value() [1/2]

◆ value() [2/2]

Property Documentation

◆ category

◆ fileName

◆ location