KModelIndexProxyMapper Class Reference

#include <KModelIndexProxyMapper>

Inheritance diagram for KModelIndexProxyMapper:

Properties
bool	isConnected
Properties inherited from QObject
	objectName

Signals
void	isConnectedChanged ()

Public Member Functions
	KModelIndexProxyMapper (const QAbstractItemModel *leftModel, const QAbstractItemModel *rightModel, QObject *parent=nullptr)
bool	isConnected () const
QModelIndex	mapLeftToRight (const QModelIndex &index) const
QModelIndex	mapRightToLeft (const QModelIndex &index) const
QItemSelection	mapSelectionLeftToRight (const QItemSelection &selection) const
QItemSelection	mapSelectionRightToLeft (const QItemSelection &selection) 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
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 QObject
typedef	QObjectList
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)

Detailed Description

This class facilitates easy mapping of indexes and selections through proxy models.

In a complex system of proxy models there can be a need to map indexes and selections between them, and sometimes to do so without knowledge of the path from one model to another.

For example,

*     Root model
*         |
*       /    \
*   Proxy 1   Proxy 3
*      |       |
*   Proxy 2   Proxy 4
* 

If there is a need to map indexes between proxy 2 and proxy 4, a KModelIndexProxyMapper can be created to facilitate mapping of indexes between them.

 m_indexMapper = new KModelIndexProxyMapper(proxy2, proxy4, this);
 
...
 
 const QModelIndex proxy4Index = m_mapLeftToRight(proxy2->index(0, 0));
 Q_ASSERT(proxy4Index.model() == proxy4);

Note that the aim is to achieve black box connections so that there is no need for application code to know the structure of proxy models in the path between left and right and attempt to manually map them.

*     Root model
*         |
*   ---------------
*   |  Black Box  |
*   ---------------
*      |       |
*   Proxy 2   Proxy 4
* 

The isConnected property indicates whether there is a path from the left side to the right side.

Author

Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 74 of file kmodelindexproxymapper.h.

Property Documentation

isConnected

bool KModelIndexProxyMapper::isConnected

read

Indicates whether there is a chain that can be followed from leftModel to rightModel.

This value can change if the sourceModel of an intermediate proxy is changed.

Definition at line 83 of file kmodelindexproxymapper.h.

Constructor & Destructor Documentation

KModelIndexProxyMapper()

KModelIndexProxyMapper::KModelIndexProxyMapper	(	const QAbstractItemModel *	leftModel,
		const QAbstractItemModel *	rightModel,
		QObject *	parent = nullptr )

Constructor.

Definition at line 160 of file kmodelindexproxymapper.cpp.

Member Function Documentation

isConnected()

bool KModelIndexProxyMapper::isConnected

(

)

const

Definition at line 281 of file kmodelindexproxymapper.cpp.

mapLeftToRight()

QModelIndex KModelIndexProxyMapper::mapLeftToRight

(

const QModelIndex &

index

)

const

Maps the index from the left model to the right model.

Definition at line 168 of file kmodelindexproxymapper.cpp.

mapRightToLeft()

QModelIndex KModelIndexProxyMapper::mapRightToLeft

(

const QModelIndex &

index

)

const

Maps the index from the right model to the left model.

Definition at line 178 of file kmodelindexproxymapper.cpp.

mapSelectionLeftToRight()

QItemSelection KModelIndexProxyMapper::mapSelectionLeftToRight

(

const QItemSelection &

selection

)

const

Maps the selection from the left model to the right model.

Definition at line 188 of file kmodelindexproxymapper.cpp.

mapSelectionRightToLeft()

QItemSelection KModelIndexProxyMapper::mapSelectionRightToLeft

(

const QItemSelection &

selection

)

const

Maps the selection from the right model to the left model.

Definition at line 236 of file kmodelindexproxymapper.cpp.

---

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

• kmodelindexproxymapper.h
• kmodelindexproxymapper.cpp