AbstractSingleRoleSerialiser Class Reference

The interface for model serialisers saving only one role. More...

Inheritance diagram for AbstractSingleRoleSerialiser:

Public Member Functions
	AbstractSingleRoleSerialiser (const QAbstractItemModel *model, QObject *parent)
	AbstractSingleRoleSerialiser (QAbstractItemModel *model, QObject *parent)
	AbstractSingleRoleSerialiser (QObject *parent=Q_NULLPTR)
	~AbstractSingleRoleSerialiser ()=0
void	addRoleToSave (int role) Q_DECL_OVERRIDE
void	clearRoleToSave () Q_DECL_OVERRIDE
void	removeRoleToSave (int role) Q_DECL_OVERRIDE
void	resetRoleToSave () Q_DECL_OVERRIDE
int	roleToSave () const
void	setRoleToSave (const QList< int > &val) Q_DECL_OVERRIDE
void	setRoleToSave (int val)
Public Member Functions inherited from AbstractStringSerialiser
	AbstractStringSerialiser (const QAbstractItemModel *model, QObject *parent)
	AbstractStringSerialiser (QAbstractItemModel *model, QObject *parent)
	AbstractStringSerialiser (QObject *parent=Q_NULLPTR)
virtual	~AbstractStringSerialiser ()=0
Q_INVOKABLE bool	loadModel (const QString &source)
virtual Q_INVOKABLE bool	loadModel (QString *source)=0
virtual Q_INVOKABLE bool	saveModel (QString *destination) const =0
Public Member Functions inherited from AbstractModelSerialiser
	AbstractModelSerialiser (const QAbstractItemModel *model, QObject *parent)
	AbstractModelSerialiser (QAbstractItemModel *model, QObject *parent)
	AbstractModelSerialiser (QObject *parent=Q_NULLPTR)
virtual	~AbstractModelSerialiser ()=0
virtual const QAbstractItemModel *	constModel () const
virtual Q_INVOKABLE bool	loadModel (const QByteArray &source)=0
virtual Q_INVOKABLE bool	loadModel (QIODevice *source)=0
virtual QAbstractItemModel *	model () const
virtual const QList< int > &	rolesToSave () const
virtual Q_INVOKABLE bool	saveModel (QByteArray *destination) const =0
virtual Q_INVOKABLE bool	saveModel (QIODevice *destination) const =0
void	setModel (const QAbstractItemModel *val)
void	setModel (QAbstractItemModel *val)
Q_INVOKABLE QDataStream::Version	streamVersion () const
	The datastream version used to serialise binary data. More...

Protected Member Functions
	AbstractSingleRoleSerialiser (AbstractSingleRoleSerialiserPrivate &d, QObject *parent)
Protected Member Functions inherited from AbstractStringSerialiser
	AbstractStringSerialiser (AbstractStringSerialiserPrivate &d, QObject *parent)
Protected Member Functions inherited from AbstractModelSerialiser
	AbstractModelSerialiser (AbstractModelSerialiserPrivate &d, QObject *parent)

Properties
int	roleToSave
	The role that will be serialised. More...
Properties inherited from AbstractModelSerialiser
const QAbstractItemModel *	constModel
	The model over which the serialiser will operate in read mode. More...
QAbstractItemModel *	model
	The model over which the serialiser will operate for reading/writing. More...
QList< int >	rolesToSave
	The roles that will be serialised. More...

Additional Inherited Members
Public Slots inherited from AbstractModelSerialiser
void	setStreamVersion (QDataStream::Version ver)
	Set the datastream version used to serialise binary data. More...
Static Public Member Functions inherited from AbstractModelSerialiser
static QList< int >	modelDefaultRoles ()

Detailed Description

The interface for model serialisers saving only one role.

Constructor & Destructor Documentation

AbstractSingleRoleSerialiser() [1/4]

AbstractSingleRoleSerialiser::AbstractSingleRoleSerialiser ( QObject *  parent = Q_NULLPTR )

explicit

Construct a serialiser

AbstractSingleRoleSerialiser() [2/4]

AbstractSingleRoleSerialiser::AbstractSingleRoleSerialiser	(	QAbstractItemModel *	model,
		QObject *	parent
	)

Construct a read/write serialiser

AbstractSingleRoleSerialiser() [3/4]

AbstractSingleRoleSerialiser::AbstractSingleRoleSerialiser	(	const QAbstractItemModel *	model,
		QObject *	parent
	)

Construct a write-only serialiser

~AbstractSingleRoleSerialiser()

AbstractSingleRoleSerialiser::~AbstractSingleRoleSerialiser ( )

pure virtualdefault

Destructor

AbstractSingleRoleSerialiser() [4/4]

AbstractSingleRoleSerialiser::AbstractSingleRoleSerialiser ( AbstractSingleRoleSerialiserPrivate &  d, QObject *  parent  )

protected

Constructor used only while subclassing the private class. Not part of the public API

Member Function Documentation

addRoleToSave()

void AbstractSingleRoleSerialiser::addRoleToSave ( int  role )

virtual

Reimplemented from base class Equivalent to setRoleToSave

Reimplemented from AbstractModelSerialiser.

clearRoleToSave()

void AbstractSingleRoleSerialiser::clearRoleToSave ( )

virtual

Reimplemented from base class Resets the role to save to Qt::DisplayRole

Reimplemented from AbstractModelSerialiser.

removeRoleToSave()

void AbstractSingleRoleSerialiser::removeRoleToSave ( int  role )

virtual

Reimplemented from base class If role is the currently saved role, resets the role to save to Qt::DisplayRole

Reimplemented from AbstractModelSerialiser.

resetRoleToSave()

void AbstractSingleRoleSerialiser::resetRoleToSave ( )

virtual

Reimplemented from base class Resets the role to save to Qt::DisplayRole

Reimplemented from AbstractModelSerialiser.

setRoleToSave()

void AbstractSingleRoleSerialiser::setRoleToSave ( const QList< int > &  val )

virtual

Reimplemented from base class If val contains more than one value only the first one is considered

Reimplemented from AbstractModelSerialiser.

Property Documentation

roleToSave

AbstractSingleRoleSerialiser::roleToSave

readwrite

The role that will be serialised.

Access functions: roleToSave(), setRoleToSave()

By default this property is set to Qt::DisplayRole