KisWorkspaceResource Class Reference

Resource for storing of workspaces. More...

#include <kis_workspace_resource.h>

Inheritance diagram for KisWorkspaceResource:

Public Member Functions
KoResourceSP	clone () const override
QString	defaultFileExtension () const override
QByteArray	dockerState ()
	KisWorkspaceResource (const KisWorkspaceResource &rhs)
	KisWorkspaceResource (const QString &filename)
bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override
KisWorkspaceResource &	operator= (const KisWorkspaceResource &rhs)=delete
QPair< QString, QString >	resourceType () const override
bool	saveToDevice (QIODevice *dev) const override
void	setDockerState (const QByteArray &state)
	~KisWorkspaceResource () override
Public Member Functions inherited from KoResource
bool	active () const
void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource
virtual void	clearSideLoadedResources ()
virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const
QString	filename () const
QImage	image () const
bool	isDirty () const
virtual bool	isEphemeral () const
virtual bool	isSerializable () const
	KoResource ()
	KoResource (const KoResource &rhs)
	KoResource (const QString &filename)
virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const
bool	load (KisResourcesInterfaceSP resourcesInterface)
QString	md5Sum (bool generateIfEmpty=true) const
QMap< QString, QVariant >	metadata () const
	get a map with all the metadata
virtual QString	name () const
KoResource &	operator= (const KoResource &rhs)=delete
bool	permanent () const
virtual QList< int >	requiredCanvasResources () const
QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const
int	resourceId () const
bool	save ()
void	setActive (bool active)
void	setDirty (bool value)
	Mark the preset as modified but not saved.
void	setFilename (const QString &filename)
void	setImage (const QImage &image)
void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.
void	setName (const QString &name)
void	setPermanent (bool permanent)
void	setResourceId (int id)
void	setStorageLocation (const QString &location)
void	setValid (bool valid)
void	setVersion (int version)
virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const
KoResourceSignature	signature () const
QString	storageLocation () const
QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)
virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors
virtual QString	thumbnailPath () const
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.
virtual void	updateThumbnail ()
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.
bool	valid () const
int	version () const
	Get the version of the resource.
virtual	~KoResource ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KisPropertiesConfiguration
void	clearProperties ()
	Clear the map of properties.
virtual bool	compareTo (const KisPropertiesConfiguration *rhs) const
virtual void	dump () const
void	fromXML (const QDomElement &) override
bool	fromXML (const QString &xml, bool clear=true) override
bool	getBool (const QString &name, bool def=false) const
KoColor	getColor (const QString &name, const KoColor &color=KoColor()) const
	getColor fetch the given property as a KoColor.
KisCubicCurve	getCubicCurve (const QString &name, const KisCubicCurve &curve=KisCubicCurve()) const
double	getDouble (const QString &name, double def=0.0) const
float	getFloat (const QString &name, float def=0.0) const
int	getInt (const QString &name, int def=0) const
void	getPrefixedProperties (const QString &prefix, KisPropertiesConfiguration *config) const
void	getPrefixedProperties (const QString &prefix, KisPropertiesConfigurationSP config) const
virtual QMap< QString, QVariant >	getProperties () const
virtual QList< QString >	getPropertiesKeys () const
virtual QVariant	getProperty (const QString &name) const
virtual bool	getProperty (const QString &name, QVariant &value) const
QString	getPropertyLazy (const QString &name, const char *defaultValue) const
QStringList	getPropertyLazy (const QString &name, const QStringList &defaultValue) const
template<typename T >
T	getPropertyLazy (const QString &name, const T &defaultValue) const
QString	getString (const QString &name, const QString &def=QString()) const
QStringList	getStringList (const QString &name, const QStringList &defaultValue=QStringList()) const
virtual bool	hasProperty (const QString &name) const
	KisPropertiesConfiguration ()
	KisPropertiesConfiguration (const KisPropertiesConfiguration &rhs)
KisPropertiesConfiguration &	operator= (const KisPropertiesConfiguration &rhs)
void	removeProperty (const QString &name)
void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfiguration *config)
void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfigurationSP config)
void	setProperty (const QString &name, const QStringList &value)
virtual void	setProperty (const QString &name, const QVariant &value)
void	setPropertyNotSaved (const QString &name)
	Marks a property that should not be saved by toXML.
QString	toXML () const override
void	toXML (QDomDocument &, QDomElement &) const override
	~KisPropertiesConfiguration () override
Public Member Functions inherited from KisSerializableConfiguration
	KisSerializableConfiguration ()
	KisSerializableConfiguration (const KisSerializableConfiguration &rhs)
virtual	~KisSerializableConfiguration ()
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Private Attributes
QByteArray	m_dockerState

Additional Inherited Members
Static Public Member Functions inherited from KisPropertiesConfiguration
static QString	escapeString (const QString &string)
static QString	extractedPrefixKey ()
static QString	unescapeString (const QString &string)
Public Attributes inherited from KoResource
bool	active {true}
QString	filename
QImage	image
QString	md5sum
QMap< QString, QVariant >	metadata
bool	modified {false}
QString	name
bool	permanent {false}
int	resourceId {-1}
QString	storageLocation
bool	valid {false}
int	version {-1}
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame
Public Attributes inherited from KisPropertiesConfiguration
QSet< QString >	notSavedProperties
QMap< QString, QVariant >	properties
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Resource for storing of workspaces.

Definition at line 15 of file kis_workspace_resource.h.

Constructor & Destructor Documentation

KisWorkspaceResource() [1/2]

KisWorkspaceResource::KisWorkspaceResource

(

const QString &

filename

)

Definition at line 18 of file kis_workspace_resource.cpp.

                                                                 : KoResource(filename)
{
}

~KisWorkspaceResource()

KisWorkspaceResource::~KisWorkspaceResource ( )

override

Definition at line 22 of file kis_workspace_resource.cpp.

{
}

KisWorkspaceResource() [2/2]

KisWorkspaceResource::KisWorkspaceResource

(

const KisWorkspaceResource &

rhs

)

Definition at line 26 of file kis_workspace_resource.cpp.

    : KoResource(rhs)
    , KisPropertiesConfiguration(rhs)
    , m_dockerState(rhs.m_dockerState)
{
}

Member Function Documentation

clone()

KoResourceSP KisWorkspaceResource::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 33 of file kis_workspace_resource.cpp.

{
    return KoResourceSP(new KisWorkspaceResource(*this));
}

References KisWorkspaceResource().

defaultFileExtension()

QString KisWorkspaceResource::defaultFileExtension ( ) const

overridevirtual

Returns

the default file extension which should be used when saving the resource

Reimplemented from KoResource.

Definition at line 107 of file kis_workspace_resource.cpp.

{
    return QString(".kws");
}

dockerState()

QByteArray KisWorkspaceResource::dockerState

(

)

Definition at line 117 of file kis_workspace_resource.cpp.

{
    return m_dockerState;
}

References m_dockerState.

loadFromDevice()

bool KisWorkspaceResource::loadFromDevice ( QIODevice * dev, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KoResource.

Definition at line 73 of file kis_workspace_resource.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    QDomDocument doc;
    if (!doc.setContent(dev)) {
        return false;
    }
 
    QDomElement element = doc.documentElement();
    setName(element.attribute("name"));
 
    QDomElement state = element.firstChildElement("state");
 
    if (!state.isNull()) {
        m_dockerState = QByteArray::fromBase64(state.text().toLatin1());
    }
 
    QDomElement settings = element.firstChildElement("settings");
    if (!settings.isNull()) {
        KisPropertiesConfiguration::fromXML(settings);
    }
 
    QDomElement thumb = element.firstChildElement("image");
    if (!thumb.isNull()) {
        QImage img;
        img.loadFromData(QByteArray::fromBase64(thumb.text().toLatin1()));
        this->setImage(img);
    }
 
    setValid(true);
    return true;
}

References KisPropertiesConfiguration::fromXML(), m_dockerState, KoResource::setImage(), KoResource::setName(), and KoResource::setValid().

operator=()

KisWorkspaceResource & KisWorkspaceResource::operator= ( const KisWorkspaceResource & rhs )

delete

resourceType()

QPair< QString, QString > KisWorkspaceResource::resourceType ( ) const

inlineoverridevirtual

Returns

the resource type

Implements KoResource.

Definition at line 28 of file kis_workspace_resource.h.

    {
        return QPair<QString, QString>(ResourceType::Workspaces, "");
    }

References ResourceType::Workspaces.

saveToDevice()

bool KisWorkspaceResource::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KoResource.

Definition at line 38 of file kis_workspace_resource.cpp.

{
    QDomDocument doc;
    QDomElement root = doc.createElement("Workspace");
    root.setAttribute("name", name() );
    root.setAttribute("version", WORKSPACE_VERSION);
    QDomElement state = doc.createElement("state");
    state.appendChild(doc.createCDATASection(m_dockerState.toBase64()));
    root.appendChild(state);
 
    // Save KisPropertiesConfiguration settings
    QDomElement settings = doc.createElement("settings");
    KisPropertiesConfiguration::toXML(doc, settings);
    root.appendChild(settings);
 
    if (!image().isNull()) {
        QDomElement thumb = doc.createElement("image");
        QBuffer buffer;
        buffer.open(QIODevice::WriteOnly);
        image().save(&buffer, "PNG");
        buffer.close();
        thumb.appendChild(doc.createCDATASection(buffer.data().toBase64()));
        root.appendChild(thumb);
    }
 
    doc.appendChild(root);
 
    QTextStream textStream(dev);
    KisPortingUtils::setUtf8OnStream(textStream);
    doc.save(textStream, 4);
 
    return true;
 
}

References KoResource::image, m_dockerState, KoResource::name, KisPortingUtils::setUtf8OnStream(), KisPropertiesConfiguration::toXML(), and WORKSPACE_VERSION.

setDockerState()

void KisWorkspaceResource::setDockerState

(

const QByteArray &

state

)

Definition at line 112 of file kis_workspace_resource.cpp.

{
    m_dockerState = state;
}

References m_dockerState.

Member Data Documentation

m_dockerState

QByteArray KisWorkspaceResource::m_dockerState

private

Definition at line 37 of file kis_workspace_resource.h.

---

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

• libs/ui/kis_workspace_resource.h
• libs/ui/kis_workspace_resource.cpp