Qt Model Utilities  2.0.3
A set of utilities for the model/view framework of Qt
Public Member Functions | Protected Member Functions | List of all members
AbstractStringSerialiser Class Referenceabstract

The interface for model serialisers saving to strings. More...

Inheritance diagram for AbstractStringSerialiser:
AbstractModelSerialiser AbstractSingleRoleSerialiser HtmlModelSerialiser JsonModelSerialiser XmlModelSerialiser CsvModelSerialiser

Public Member Functions

 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 Q_INVOKABLE void addRoleToSave (int role)
 Appends role to the list of roles to save. More...
 
virtual Q_INVOKABLE void clearRoleToSave ()
 empties the list of roles to save More...
 
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 Q_INVOKABLE void removeRoleToSave (int role)
 Removes role from the list of roles to save. More...
 
virtual void resetRoleToSave ()
 resetter of rolesToSave property More...
 
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)
 
virtual void setRoleToSave (const QList< int > &val)
 
Q_INVOKABLE QDataStream::Version streamVersion () const
 The datastream version used to serialise binary data. More...
 

Protected Member Functions

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

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

Detailed Description

The interface for model serialisers saving to strings.

Constructor & Destructor Documentation

◆ AbstractStringSerialiser() [1/4]

AbstractStringSerialiser::AbstractStringSerialiser ( QObject *  parent = Q_NULLPTR)
explicit

Construct a serialiser

◆ AbstractStringSerialiser() [2/4]

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

Construct a read/write serialiser

◆ AbstractStringSerialiser() [3/4]

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

Construct a write-only serialiser

◆ ~AbstractStringSerialiser()

AbstractStringSerialiser::~AbstractStringSerialiser ( )
pure virtualdefault

Destructor

◆ AbstractStringSerialiser() [4/4]

AbstractStringSerialiser::AbstractStringSerialiser ( AbstractStringSerialiserPrivate &  d,
QObject *  parent 
)
protected

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

Member Function Documentation

◆ loadModel() [1/2]

bool AbstractStringSerialiser::loadModel ( const QString &  source)

Loads the model from the given source

Data previously stored in the model will be removed

◆ loadModel() [2/2]

bool AbstractStringSerialiser::loadModel ( QString *  source)
pure virtual

Loads the model from the given source

Data previously stored in the model will be removed

Implemented in XmlModelSerialiser, JsonModelSerialiser, HtmlModelSerialiser, and CsvModelSerialiser.

◆ saveModel()

bool AbstractStringSerialiser::saveModel ( QString *  destination) const
pure virtual

Saves the model to the given destination

Implemented in XmlModelSerialiser, JsonModelSerialiser, HtmlModelSerialiser, and CsvModelSerialiser.