KPageWidgetModel

#include <KPageWidgetModel>

Inheritance diagram for KPageWidgetModel:

[legend]

Signals
void	toggled (KPageWidgetItem *page, bool checked)

Public Member Functions
	KPageWidgetModel (QObject *parent=nullptr)

	~KPageWidgetModel () override

void	addPage (KPageWidgetItem *item)

KPageWidgetItem *	addPage (QWidget *widget, const QString &name)

void	addSubPage (KPageWidgetItem parent, KPageWidgetItem item)

KPageWidgetItem *	addSubPage (KPageWidgetItem parent, QWidget widget, const QString &name)

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

Qt::ItemFlags	flags (const QModelIndex &index) const override

QModelIndex	index (const KPageWidgetItem *item) const

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override

void	insertPage (KPageWidgetItem before, KPageWidgetItem item)

KPageWidgetItem *	insertPage (KPageWidgetItem before, QWidget widget, const QString &name)

KPageWidgetItem *	item (const QModelIndex &index) const

QModelIndex	parent (const QModelIndex &index) const override

void	removePage (KPageWidgetItem *item)

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

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

	~KPageModel () override

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

virtual QModelIndex	buddy (const QModelIndex &index) const const

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const

virtual bool	canFetchMore (const QModelIndex &parent) const const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

virtual bool	clearItemData (const QModelIndex &index)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

virtual void	fetchMore (const QModelIndex &parent)

virtual bool	hasChildren (const QModelIndex &parent) const const

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const

virtual QStringList	mimeTypes () const const

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual void	revert ()

virtual QHash< int, QByteArray >	roleNames () const const

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual QModelIndex	sibling (int row, int column, const QModelIndex &index) const const

virtual void	sort (int column, Qt::SortOrder order)

virtual QSize	span (const QModelIndex &index) const const

virtual bool	submit ()

virtual Qt::DropActions	supportedDragActions () const const

virtual Qt::DropActions	supportedDropActions () const const

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

QBindable< QString >	bindableObjectName ()

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

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	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 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_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

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

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from KPageModel
enum	Role { HeaderRole = Qt::UserRole + 1 , WidgetRole , HeaderVisibleRole , ActionsRole }

Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

typedef	CheckIndexOptions

enum	LayoutChangeHint

Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

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)

Public Attributes inherited from QAbstractItemModel
	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Protected Member Functions inherited from KPageModel
KWIDGETSADDONS_NO_EXPORT	KPageModel (KPageModelPrivate &dd, QObject *parent)

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

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)

Protected Attributes inherited from KPageModel
std::unique_ptr< class KPageModelPrivate > const	d_ptr

Detailed Description

This page model is used by KPageWidget to provide a hierarchical layout of pages.

Definition at line 218 of file kpagewidgetmodel.h.

Constructor & Destructor Documentation

◆ KPageWidgetModel()

KPageWidgetModel::KPageWidgetModel ( QObject * parent = nullptr )

explicit

Creates a new page widget model.

Parameters

parent The parent object.

Definition at line 273 of file kpagewidgetmodel.cpp.

◆ ~KPageWidgetModel()

KPageWidgetModel::~KPageWidgetModel ( )

override

Destroys the page widget model.

Definition at line 278 of file kpagewidgetmodel.cpp.

Member Function Documentation

◆ addPage() [1/2]

void KPageWidgetModel::addPage ( KPageWidgetItem * item )

Adds a new top level page to the model.

Parameters

item	The KPageWidgetItem which describes the page.

Definition at line 427 of file kpagewidgetmodel.cpp.

◆ addPage() [2/2]

KPageWidgetItem * KPageWidgetModel::addPage	(	QWidget *	widget,
		const QString &	name )

Adds a new top level page to the model.

Parameters

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated KPageWidgetItem.

Definition at line 418 of file kpagewidgetmodel.cpp.

◆ addSubPage() [1/2]

void KPageWidgetModel::addSubPage	(	KPageWidgetItem *	parent,
		KPageWidgetItem *	item )

Inserts a new sub page in the model.

Parameters

parent	The new page will be insert as child of this KPageWidgetItem.
item	The KPageWidgetItem which describes the page.

Definition at line 500 of file kpagewidgetmodel.cpp.

◆ addSubPage() [2/2]

KPageWidgetItem * KPageWidgetModel::addSubPage	(	KPageWidgetItem *	parent,
		QWidget *	widget,
		const QString &	name )

Inserts a new sub page in the model.

Parameters

parent	The new page will be insert as child of this KPageWidgetItem.
widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated KPageWidgetItem.

Definition at line 491 of file kpagewidgetmodel.cpp.

◆ columnCount()

int KPageWidgetModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

These methods are reimplemented from QAbstractItemModel.

Implements QAbstractItemModel.

Definition at line 282 of file kpagewidgetmodel.cpp.

◆ data()

QVariant KPageWidgetModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 287 of file kpagewidgetmodel.cpp.

◆ flags()

Qt::ItemFlags KPageWidgetModel::flags ( const QModelIndex & index ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 346 of file kpagewidgetmodel.cpp.

◆ index() [1/2]

QModelIndex KPageWidgetModel::index ( const KPageWidgetItem * item ) const

Returns the index for a given KPageWidgetItem.

The index is invalid if the item can't be found in the model.

Definition at line 584 of file kpagewidgetmodel.cpp.

◆ index() [2/2]

QModelIndex KPageWidgetModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 365 of file kpagewidgetmodel.cpp.

◆ insertPage() [1/2]

void KPageWidgetModel::insertPage	(	KPageWidgetItem *	before,
		KPageWidgetItem *	item )

Inserts a new page in the model.

Parameters

before	The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
item	The KPageWidgetItem which describes the page.

Definition at line 457 of file kpagewidgetmodel.cpp.

◆ insertPage() [2/2]

KPageWidgetItem * KPageWidgetModel::insertPage	(	KPageWidgetItem *	before,
		QWidget *	widget,
		const QString &	name )

Inserts a new page in the model.

Parameters

before	The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated KPageWidgetItem.

Definition at line 448 of file kpagewidgetmodel.cpp.

◆ item()

KPageWidgetItem * KPageWidgetModel::item ( const QModelIndex & index ) const

Returns the KPageWidgetItem for a given index or a null pointer if the index is invalid.

Definition at line 570 of file kpagewidgetmodel.cpp.

◆ parent()

QModelIndex KPageWidgetModel::parent ( const QModelIndex & index ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 385 of file kpagewidgetmodel.cpp.

◆ removePage()

void KPageWidgetModel::removePage ( KPageWidgetItem * item )

Removes the page associated with the given KPageWidgetItem.

Definition at line 533 of file kpagewidgetmodel.cpp.

◆ rowCount()

int KPageWidgetModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 403 of file kpagewidgetmodel.cpp.

◆ setData()

bool KPageWidgetModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = Qt::EditRole )

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 318 of file kpagewidgetmodel.cpp.

◆ toggled

void KPageWidgetModel::toggled	(	KPageWidgetItem *	page,
		bool	checked )

signal

This signal is emitted whenever a checkable page changes its state.

Parameters

checked is true when the page is checked, or false if the page is unchecked.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KPageWidgetModel

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KPageWidgetModel()

◆ ~KPageWidgetModel()

Member Function Documentation

◆ addPage() [1/2]

◆ addPage() [2/2]

◆ addSubPage() [1/2]

◆ addSubPage() [2/2]

◆ columnCount()

◆ data()

◆ flags()

◆ index() [1/2]

◆ index() [2/2]

◆ insertPage() [1/2]

◆ insertPage() [2/2]

◆ item()

◆ parent()

◆ removePage()

◆ rowCount()

◆ setData()

◆ toggled