Resource Class Reference

#include <Resource.h>

Inheritance diagram for Resource:

Classes
struct	Private

Public Slots
QString	filename () const
QImage	image () const
QString	name () const
void	setImage (QImage image)
void	setName (QString value)
QString	type () const

Public Member Functions
bool	operator!= (const Resource &other) const
Resource	operator= (const Resource &rhs)
bool	operator== (const Resource &other) const
	Resource (const Resource &rhs)
	Resource (int resourceId, const QString &type, const QString &name, const QString &filename, const QImage &image, QObject *parent=0)
	Resource (KoResourceSP resource, const QString &type, QObject *parent=0)
	~Resource () override

Private Member Functions
KoResourceSP	resource () const

Private Attributes
QScopedPointer< Private >	d

Friends
class	Palette
class	Preset
class	PresetChooser
class	View
	Assistance tools: guides, reference, etc.

Detailed Description

A Resource represents a gradient, pattern, brush tip, brush preset, palette or workspace definition.

allPresets = Application.resources("preset")
for preset in allPresets:
    print(preset.name())

Resources are identified by their type, name and filename. If you want to change the contents of a resource, you should read its data using data(), parse it and write the changed contents back.

Definition at line 30 of file Resource.h.

Constructor & Destructor Documentation

Resource() [1/3]

Resource::Resource	(	int	resourceId,
		const QString &	type,
		const QString &	name,
		const QString &	filename,
		const QImage &	image,
		QObject *	parent = 0 )

Definition at line 28 of file Resource.cpp.

    : QObject(parent)
    , d(new Private())
{
    d->id = resourceId;
    d->type = type;
    d->name = name;
    d->filename = filename;
    d->image = image;
}

References d, filename(), image(), name(), and type().

Resource() [2/3]

Resource::Resource	(	KoResourceSP	resource,
		const QString &	type,
		QObject *	parent = 0 )

Definition at line 39 of file Resource.cpp.

    : QObject(parent)
    , d(new Private())
{
    d->id = resource->resourceId();
    d->type = type;
    d->name = resource->name();
    d->filename = resource->filename();
    d->image = resource->image();
}

References d, resource(), and type().

~Resource()

Resource::~Resource ( )

override

Definition at line 50 of file Resource.cpp.

{
}

Resource() [3/3]

Resource::Resource

(

const Resource &

rhs

)

Definition at line 54 of file Resource.cpp.

    : QObject()
    , d(new Private())
{
    d->id = rhs.d->id;
    d->type = rhs.d->type;
    d->name = rhs.d->name;
    d->filename = rhs.d->filename;
    d->image = rhs.d->image;
}

References d.

Member Function Documentation

filename

QString Resource::filename ( ) const

slot

The filename of the resource, if present. Not all resources are loaded from files.

Definition at line 100 of file Resource.cpp.

{
    return d->filename;
}

References d.

image

QImage Resource::image ( ) const

slot

An image that can be used to represent the resource in the user interface. For some resources, like patterns, the image is identical to the resource, for others it's a mere icon.

Definition at line 106 of file Resource.cpp.

{
    return d->image;
}

References d.

name

QString Resource::name ( ) const

slot

The user-visible name of the resource.

Definition at line 90 of file Resource.cpp.

{
    return d->name;
}

References d.

operator!=()

bool Resource::operator!=

(

const Resource &

other

)

const

Definition at line 70 of file Resource.cpp.

{
    return !(operator==(other));
}

References operator==().

operator=()

Resource Resource::operator=

(

const Resource &

rhs

)

Definition at line 75 of file Resource.cpp.

{
    Resource res(rhs.d->id,
                 rhs.d->type,
                 rhs.d->name,
                 rhs.d->filename,
                 rhs.d->image);
    return res;
}

References d.

operator==()

bool Resource::operator==

(

const Resource &

other

)

const

Definition at line 65 of file Resource.cpp.

{
    return (d->id == other.d->id);
}

References d.

resource()

KoResourceSP Resource::resource ( ) const

private

Definition at line 116 of file Resource.cpp.

{
    KoResourceSP res = KisResourceLocator::instance()->resourceForId(d->id);
    Q_ASSERT(res);
    return res;
}

References d, KisResourceLocator::instance(), and KisResourceLocator::resourceForId().

setImage

void Resource::setImage ( QImage image )

slot

Change the image for this resource.

Definition at line 111 of file Resource.cpp.

{
    d->image = image;
}

References d, and image().

setName

void Resource::setName ( QString value )

slot

setName changes the user-visible name of the current resource.

Definition at line 95 of file Resource.cpp.

{
    d->name = value;
}

References d, and value().

type

QString Resource::type ( ) const

slot

Return the type of this resource. Valid types are:

• pattern: a raster image representing a pattern
• gradient: a gradient
• brush: a brush tip
• preset: a brush preset
• palette: a color set
• workspace: a workspace definition.

Definition at line 85 of file Resource.cpp.

{
    return d->type;
}

References d.

Friends And Related Symbol Documentation

Palette

friend class Palette

friend

Definition at line 93 of file Resource.h.

Preset

friend class Preset

friend

Definition at line 94 of file Resource.h.

PresetChooser

friend class PresetChooser

friend

Definition at line 91 of file Resource.h.

View

friend class View

friend

Assistance tools: guides, reference, etc.

Definition at line 92 of file Resource.h.

Member Data Documentation

d

QScopedPointer<Private> Resource::d

private

Definition at line 98 of file Resource.h.

---

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

• libs/libkis/Resource.h
• libs/libkis/Resource.cpp