Preset Class Reference

The Preset class Preset is a resource object that stores brush preset data. More...

#include <Preset.h>

Inheritance diagram for Preset:

Classes
struct	Private

Public Member Functions
void	fromXML (const QString &xml)
	fromXML convert the preset settings into a preset formatted xml.
	Preset (Resource *resource)
QString	toXML () const
	toXML convert the preset settings into a preset formatted xml.
	~Preset () override

Private Member Functions
KisPaintOpPresetSP	paintOpPreset ()
	paintOpPreset

Private Attributes
Private *const	d

Detailed Description

The Preset class Preset is a resource object that stores brush preset data.

An example for printing the current brush preset and all its settings:

from krita import *
 
view = Krita.instance().activeWindow().activeView()
preset = Preset(view.currentBrushPreset())
 
print ( preset.toXML() )

Definition at line 34 of file Preset.h.

Constructor & Destructor Documentation

Preset()

Preset::Preset

(

Resource *

resource

)

Definition at line 13 of file Preset.cpp.

                                : d(new Private()) {
    d->preset = resource->resource().dynamicCast<KisPaintOpPreset>();
}

References d, Preset::Private::preset, and Resource::resource().

~Preset()

Preset::~Preset ( )

override

Definition at line 17 of file Preset.cpp.

{
    delete d;
}

References d.

Member Function Documentation

fromXML()

void Preset::fromXML

(

const QString &

xml

)

fromXML convert the preset settings into a preset formatted xml.

Parameters

xml	valid xml preset string.

Definition at line 35 of file Preset.cpp.

{
    QDomDocument xmlDoc;
 
    if (!xmlDoc.setContent(xml)) {
        qWarning() << "XML string format is invalid!";
        return;
    }
 
    d->preset->fromXML(xmlDoc.documentElement(),d->preset->resourcesInterface());
    d->preset->setDirty(true);
}

References d, and Preset::Private::preset.

paintOpPreset()

KisPaintOpPresetSP Preset::paintOpPreset ( )

private

paintOpPreset

Returns

gives a KisPaintOpPreset object back

toXML()

QString Preset::toXML

(

)

const

toXML convert the preset settings into a preset formatted xml.

Returns

the xml in a string.

Definition at line 23 of file Preset.cpp.

{
    QDomDocument xmlDoc;
    QDomElement root = xmlDoc.createElement("Preset");
 
    d->preset->toXML(xmlDoc,root);
 
    xmlDoc.appendChild(root);
 
    return xmlDoc.toString();
}

References d, and Preset::Private::preset.

Member Data Documentation

d

Private* const Preset::d

private

Definition at line 56 of file Preset.h.

---

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

• libs/libkis/Preset.h
• libs/libkis/Preset.cpp