A generic class the defines methods for settings containers. More...

#include <qsettingscontainer.h>

Inheritance diagram for QSettingsContainer:

Public Slots
virtual int	appendEntry (QSettingsEntry *entry)=0
	Appends the entry to the containers children. More...

virtual int	prependEntry (QSettingsEntry *entry)=0
	Prepends the entry to the containers children. More...

virtual int	insertEntry (int index, QSettingsEntry *entry)=0
	Inserts the entry to the containers children at the given index. More...

virtual int	insertEntry (int index, QSharedPointer< QSettingsEntry > entry)=0
	Appends the entry to the containers children at the given index.

virtual bool	removeEntry (int id)=0
	Removes the entry with the given id. More...

virtual bool	removeElementFromIndex (int index)=0
	Removes the element at the given index. More...

virtual void	moveElement (int indexFrom, int indexTo)=0
	Moves the element from the old to the new index.

Public Member Functions
virtual QSettingsDialog *	dialog () const =0
	Returns the dialog this container belongs to.

virtual QString	containerPath () const =0
	Returns the container path this container has.

virtual int	elementCount () const =0
	Returns the number of elements in this container.

virtual bool	isEntry (int index) const =0
	Checks whether the element at the given index is an entry or not.

virtual int	getEntryIndex (int id) const =0
	Searches for entries index. More...

virtual int	getEntryId (int index) const =0
	Returns the id for the entry at the index. More...

virtual QSharedPointer< QSettingsEntry >	getEntry (int id) const =0
	Returns the entry with the given id. More...

virtual QSharedPointer< QSettingsEntry >	getEntryFromIndex (int index) const =0
	Returns the entry at the given index. More...

virtual bool	transferElement (int indexFrom, QSettingsContainer *targetContainer, int indexTo)=0
	Tries to transfer the element at index to the target container. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

virtual const QMetaObject *	metaObject () const

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const

bool	blockSignals (bool block)

QThread *	thread () const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectTree ()

void	dumpObjectInfo ()

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

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

bool	inherits (const char *className) const

void	deleteLater ()

Protected Member Functions
	QSettingsContainer (QObject *parent=nullptr)
	Protected constructor.

virtual bool	acceptEntry (int index, int id, QSharedPointer< QSettingsEntry > entry)=0
	Will be called to insert the given entry from a transfer. More...

bool	doAccept (QSettingsContainer *target, int index, int id, QSharedPointer< QSettingsEntry > entry)
	`[INTERNAL USE]` Helper function

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Additional Inherited Members
Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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 QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Properties inherited from QObject
	objectName

Detailed Description

A generic class the defines methods for settings containers.

Member Function Documentation

QSettingsContainer::acceptEntry	(	int	index,
		int	id,
		QSharedPointer< QSettingsEntry >	entry
	)

protectedpure virtual

Will be called to insert the given entry from a transfer.

Parameters

index	The target index to insert the entry at
id	The id of the entry to be inserted
entry	The entry itself to insert

Returns: true, if the entry was accepted and taken, false if not

This function will be called internally to insert an entry from a QSettingsContainer::transferElement. It will be called on the target container with the given parameters. If true is returned, the original container assumes the element was taken and will remove it from itself. If false is returned, it's expected that the target container did not accept the element and the original one will keep the entry.

Implemented in QSectionSettingsContainer, QGroupSettingsContainer, and QAsyncSettingsContainer.

virtual int QSettingsContainer::appendEntry ( QSettingsEntry * entry )

pure virtualslot

Appends the entry to the containers children.

Note: The dialog will take ownership of the entry

QSettingsContainer::getEntry ( int id ) const

pure virtual

Returns the entry with the given id.

Parameters

id	The id of the entry to be found

Returns: The entry, or nullptr, if the entry is not in there

Implemented in QSectionSettingsContainer, QGroupSettingsContainer, and QAsyncSettingsContainer.

QSettingsContainer::getEntryFromIndex ( int index ) const

pure virtual

Returns the entry at the given index.

Parameters

index The index of the entry

Returns: The entry at that index, if it is an entry. If not, nullptr

Implemented in QSectionSettingsContainer, QGroupSettingsContainer, and QAsyncSettingsContainer.

QSettingsContainer::getEntryId ( int index ) const

pure virtual

Returns the id for the entry at the index.

Parameters

index The index of the entry

Returns: The id of the entry at that index, if it is an entry. If not, -1

Implemented in QSectionSettingsContainer, QGroupSettingsContainer, and QAsyncSettingsContainer.

QSettingsContainer::getEntryIndex ( int id ) const

pure virtual

Searches for entries index.

Parameters

id	The id of the entry to be found

Returns: The index within this container, or -1, if the entry is not in there

Implemented in QSectionSettingsContainer, QGroupSettingsContainer, and QAsyncSettingsContainer.

virtual int QSettingsContainer::insertEntry	(	int	index,
		QSettingsEntry *	entry
	)

pure virtualslot

Inserts the entry to the containers children at the given index.

Note: The dialog will take ownership of the entry

virtual int QSettingsContainer::prependEntry ( QSettingsEntry * entry )

pure virtualslot

Prepends the entry to the containers children.

Note: The dialog will take ownership of the entry

QSettingsContainer::removeElementFromIndex ( int index )

pure virtualslot

Removes the element at the given index.

Parameters

index The index of the element to be removed

Returns: true, if the entry was removed, false if not

QSettingsContainer::removeEntry ( int id )

pure virtualslot

Removes the entry with the given id.

Parameters

id	The id of an entry with that id was removed, `false` if not

QSettingsContainer::transferElement	(	int	indexFrom,
		QSettingsContainer *	targetContainer,
		int	indexTo
	)

pure virtual

Tries to transfer the element at index to the target container.

Parameters

indexFrom	The index of the element to be transfered
targetContainer	The container to transfer the element to
indexTo	The index to insert the element at in the target container

Returns: true, if the transfer was successful, false if not

The function will first check if the target container accepts the element at indexFrom. If it does, it will be transfered. If not, nothign happens and false is returned.

Implemented in QSectionSettingsContainer, QGroupSettingsContainer, and QAsyncSettingsContainer.

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

D:/felix/linked/Qworkplace/QSettingsDialog/QSettingsDialog/core/qsettingscontainer.h
D:/felix/linked/Qworkplace/QSettingsDialog/QSettingsDialog/core/qsettingscontainer.dox

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation