KPageModel Class Reference

#include <KPageModel>

Inheritance diagram for KPageModel:

Public Types
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

Public Member Functions
	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)
virtual int	columnCount (const QModelIndex &parent) const const=0
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)
virtual QVariant	data (const QModelIndex &index, int role) const const=0
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 Qt::ItemFlags	flags (const QModelIndex &index) const const
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)
virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const const=0
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
virtual QModelIndex	parent (const QModelIndex &index) const const=0
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
virtual int	rowCount (const QModelIndex &parent) const const=0
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	setData (const QModelIndex &index, const QVariant &value, int role)
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

Protected Member Functions
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
std::unique_ptr< class KPageModelPrivate > const	d_ptr

Additional Inherited Members
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

Detailed Description

A base class for a model used by KPageView.

This class is an abstract base class which must be used to implement custom models for KPageView. Additional to the standard Qt::ItemDataRoles it provides the two roles

• HeaderRole
• HeaderVisibleRole
• WidgetRole

which are used to return a header string for a page and a QWidget pointer to the page itself.

Example:

KPageView *view = new KPageView( this );
KPageModel *model = new MyPageModel( this );
 
view->setModel( model );

See also

KPageView

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Definition at line 46 of file kpagemodel.h.

Member Enumeration Documentation

Role

enum KPageModel::Role

Additional roles that KPageView uses.

Enumerator
HeaderRole	A string to be rendered as page header.
WidgetRole	A pointer to the page widget. This is the widget that is shown when the item is selected. You can make QVariant take a QWidget using QWidget *myWidget = new QWidget; QVariant v = QVariant::fromValue(myWidget);
HeaderVisibleRole	when true, show the page header, if false don't Since 5.52
ActionsRole	The list of actions associated to the page. Since 6.6

Definition at line 55 of file kpagemodel.h.

Constructor & Destructor Documentation

KPageModel() [1/2]

KPageModel::KPageModel ( QObject * parent = nullptr )

explicit

Constructs a page model with the given parent.

Definition at line 15 of file kpagemodel.cpp.

~KPageModel()

KPageModel::~KPageModel ( )

overridedefault

Destroys the page model.

KPageModel() [2/2]

KPageModel::KPageModel ( KPageModelPrivate & dd, QObject * parent )

protected

Definition at line 21 of file kpagemodel.cpp.

Member Data Documentation

d_ptr

std::unique_ptr<class KPageModelPrivate> const KPageModel::d_ptr

protected

Definition at line 96 of file kpagemodel.h.

---

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

• kpagemodel.h
• kpagemodel.cpp