TasksetResource Class Reference

#include <taskset_resource.h>

Inheritance diagram for TasksetResource:

Public Member Functions
QStringList	actionList ()
KoResourceSP	clone () const override
QString	defaultFileExtension () const override
bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override
TasksetResource &	operator= (const TasksetResource &rhs)=delete
QPair< QString, QString >	resourceType () const override
bool	saveToDevice (QIODevice *dev) const override
void	setActionList (const QStringList actions)
	TasksetResource (const QString &filename)
	TasksetResource (const TasksetResource &rhs)
	~TasksetResource () 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)

Private Attributes
QStringList	m_actions

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

Detailed Description

Definition at line 15 of file taskset_resource.h.

Constructor & Destructor Documentation

TasksetResource() [1/2]

TasksetResource::TasksetResource

(

const QString &

filename

)

Definition at line 19 of file taskset_resource.cpp.

    : KoResource(f)
{
}

~TasksetResource()

TasksetResource::~TasksetResource ( )

override

Definition at line 24 of file taskset_resource.cpp.

{
}

TasksetResource() [2/2]

TasksetResource::TasksetResource

(

const TasksetResource &

rhs

)

Definition at line 28 of file taskset_resource.cpp.

    : KoResource(rhs),
      m_actions(rhs.m_actions)
{
}

Member Function Documentation

actionList()

QStringList TasksetResource::actionList

(

)

Definition at line 71 of file taskset_resource.cpp.

{
    return m_actions;
}

References m_actions.

clone()

KoResourceSP TasksetResource::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 34 of file taskset_resource.cpp.

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

References TasksetResource().

defaultFileExtension()

QString TasksetResource::defaultFileExtension ( ) const

overridevirtual

Returns

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

Reimplemented from KoResource.

Definition at line 61 of file taskset_resource.cpp.

{
    return QString(".kts");
}

loadFromDevice()

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

overridevirtual

Implements KoResource.

Definition at line 39 of file taskset_resource.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    QDomDocument doc;
    if (!doc.setContent(dev)) {
        return false;
    }
    QDomElement element = doc.documentElement();
    setName(element.attribute("name"));
    QDomNode node = element.firstChild();
    while (!node.isNull()) {
        QDomElement child = node.toElement();
        if (!child.isNull() && child.tagName() == "action") {
                m_actions.append(child.text());
        }
        node = node.nextSibling();
    }
    setValid(true);
    return true;
}

References m_actions, KoResource::setName(), and KoResource::setValid().

operator=()

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

delete

resourceType()

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

inlineoverridevirtual

Returns

the resource type

Implements KoResource.

Definition at line 31 of file taskset_resource.h.

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

References ResourceType::TaskSets.

saveToDevice()

bool TasksetResource::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KoResource.

Definition at line 76 of file taskset_resource.cpp.

{
 
    QDomDocument doc;
    QDomElement root = doc.createElement("Taskset");
    root.setAttribute("name", name() );
    root.setAttribute("version", TASKSET_VERSION);
    Q_FOREACH (const QString& action, m_actions) {
        QDomElement element = doc.createElement("action");
        element.appendChild(doc.createTextNode(action));
        root.appendChild(element);
    }
    doc.appendChild(root);
 
    QTextStream textStream(io);
    KisPortingUtils::setUtf8OnStream(textStream);
    doc.save(textStream, 4);
 
    KoResource::saveToDevice(io);
 
    return true;
}

References m_actions, KoResource::name, KoResource::saveToDevice(), KisPortingUtils::setUtf8OnStream(), and TASKSET_VERSION.

setActionList()

void TasksetResource::setActionList

(

const QStringList

actions

)

Definition at line 66 of file taskset_resource.cpp.

{
    m_actions = actions;
}

References m_actions.

Member Data Documentation

m_actions

QStringList TasksetResource::m_actions

private

Definition at line 41 of file taskset_resource.h.

---

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

• plugins/dockers/tasksetdocker/taskset_resource.h
• plugins/dockers/tasksetdocker/taskset_resource.cpp