#include <KisSessionResource.h>

Inheritance diagram for KisSessionResource:

Classes
struct	Private

Public Member Functions
KoResourceSP	clone () const override

QString	defaultFileExtension () const override

	KisSessionResource (const KisSessionResource &rhs)

	KisSessionResource (const QString &filename)

KisSessionResource &	operator= (const KisSessionResource &rhs)=delete

void	storeCurrentWindows ()

	~KisSessionResource ()

Public Member Functions inherited from KisWindowLayoutResource
void	applyLayout ()

KoResourceSP	clone () const override

QString	defaultFileExtension () const override

	KisWindowLayoutResource (const KisWindowLayoutResource &rhs)

	KisWindowLayoutResource (const QString &filename)

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

KisWindowLayoutResource &	operator= (const KisWindowLayoutResource &rhs)=delete

QPair< QString, QString >	resourceType () const override

bool	saveToDevice (QIODevice *dev) const override

	~KisWindowLayoutResource () 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)

Protected Member Functions
void	loadXml (const QDomElement &root) const override

QPair< QString, QString >	resourceType () const override

void	saveXml (QDomDocument &doc, QDomElement &root) const override

Protected Member Functions inherited from KisWindowLayoutResource
void	setWindows (const QList< QPointer< KisMainWindow > > &mainWindows)

Private Member Functions
void	restore ()

Private Attributes
QScopedPointer< Private >	d

Friends
class	KisPart

Additional Inherited Members
Static Public Member Functions inherited from KisWindowLayoutResource
static KisWindowLayoutResourceSP	fromCurrentWindows (const QString &filename, const QList< QPointer< KisMainWindow > > &mainWindows, bool showImageInAllWindows, bool primaryWorkspaceFollowsFocus, KisMainWindow *primaryWindow)

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 14 of file KisSessionResource.h.

Constructor & Destructor Documentation

◆ KisSessionResource() [1/2]

KisSessionResource::KisSessionResource ( const QString & filename )

Definition at line 40 of file KisSessionResource.cpp.

        : KisWindowLayoutResource(filename)
          , d(new Private)
{}

◆ ~KisSessionResource()

KisSessionResource::~KisSessionResource ( )

Definition at line 45 of file KisSessionResource.cpp.

46{}

◆ KisSessionResource() [2/2]

KisSessionResource::KisSessionResource ( const KisSessionResource & rhs )

Definition at line 48 of file KisSessionResource.cpp.

    : KisWindowLayoutResource(rhs)
    , d(new Private(*rhs.d))
{
}

Member Function Documentation

◆ clone()

KoResourceSP KisSessionResource::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 54 of file KisSessionResource.cpp.

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

References KisSessionResource().

◆ defaultFileExtension()

QString KisSessionResource::defaultFileExtension ( ) const

overridevirtual

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

Reimplemented from KoResource.

Definition at line 116 of file KisSessionResource.cpp.

{
    return ".ksn";
}

◆ loadXml()

void KisSessionResource::loadXml ( const QDomElement & root ) const

overrideprotectedvirtual

Reimplemented from KisWindowLayoutResource.

Definition at line 167 of file KisSessionResource.cpp.

{
    KisWindowLayoutResource::loadXml(root);
 
    d->views.clear();
    for (auto viewElement = root.firstChildElement("view");
         !viewElement.isNull();
         viewElement = viewElement.nextSiblingElement("view")) {
        Private::View view;
 
        view.file = QUrl(viewElement.attribute("src")).toLocalFile();
        view.windowId = QUuid(viewElement.attribute("window"));
        view.viewConfig.fromXML(viewElement);
 
        d->views.append(view);
    }
    //Load session
    d->profileName.clear();
    auto sessionElement = root.firstChildElement("session");
    d->profileName = QString(sessionElement.attribute("profile"));
 
}

References d, KisSessionResource::Private::View::file, KisPropertiesConfiguration::fromXML(), KisWindowLayoutResource::loadXml(), KisSessionResource::Private::View::viewConfig, and KisSessionResource::Private::View::windowId.

◆ operator=()

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

delete

◆ resourceType()

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

inlineoverrideprotectedvirtual

Returns: the resource type

Implements KoResource.

Definition at line 33 of file KisSessionResource.h.

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

References ResourceType::Sessions.

◆ restore()

void KisSessionResource::restore ( )

private

Definition at line 59 of file KisSessionResource.cpp.

{
    auto *kisPart = KisPart::instance();
 
    applyLayout();
 
    QMap<QString, KisDocument *> documents;
 
    // Find documents which are already open so we don't need to reload them
    QList<QPointer<KisView>> oldViews = kisPart->views();
    Q_FOREACH(const QPointer<KisView> view, oldViews) {
        KisDocument *document = view->document();
        const QString path = document->path();
        documents.insert(path, document);
    }
 
    Q_FOREACH(auto &viewData, d->views) {
        QString path = viewData.file;
 
        KisMainWindow *window = viewData.getWindow();
 
        if (!window) {
            qDebug() << "Warning: session file contains inconsistent data.";
        } else {
            KisDocument *document = documents.value(path);
 
            if (!document) {
                document = kisPart->createDocument();
 
                bool ok = document->openPath(path);
                if (!ok) {
                    delete document;
                    continue;
                }
 
                kisPart->addDocument(document);
                documents.insert(path, document);
            }
            //update profile
            QString profileName;
            profileName = d->profileName;
            window->viewManager()->changeAuthorProfile(profileName);
            window->viewManager()->slotUpdateAuthorProfileActions();
 
 
            KisView *view = window->newView(document);
            view->restoreViewState(viewData.viewConfig);
        }
    }
 
    Q_FOREACH(QPointer<KisView> view, oldViews) {
        view->closeView();
    }
 
}

References KisWindowLayoutResource::applyLayout(), KisViewManager::changeAuthorProfile(), d, KisPart::instance(), KisMainWindow::newView(), KisDocument::openPath(), KisView::restoreViewState(), KisViewManager::slotUpdateAuthorProfileActions(), and KisMainWindow::viewManager.

◆ saveXml()

void KisSessionResource::saveXml	(	QDomDocument &	doc,
		QDomElement &	root ) const

overrideprotectedvirtual

Reimplemented from KisWindowLayoutResource.

Definition at line 141 of file KisSessionResource.cpp.

{
    KisWindowLayoutResource::saveXml(doc, root);
 
    Q_FOREACH(const auto view, d->views) {
        QDomElement elem = doc.createElement("view");
 
        elem.setAttribute("window", view.windowId.toString());
        // we convert to QUrl to maintain compatibility with Krita 4.4
        elem.setAttribute("src", QUrl::fromLocalFile(view.file).toString());
        view.viewConfig.toXML(doc, elem);
 
        root.appendChild(elem);
 
        // Save profile
        KConfigGroup appAuthorGroup(KSharedConfig::openConfig(), "Author");
        QString profileName = appAuthorGroup.readEntry("active-profile", "");
 
        QDomElement session = doc.createElement("session");
        session.setAttribute("profile", profileName);
        root.appendChild(session);
 
    }
 
}

References d, and KisWindowLayoutResource::saveXml().

◆ storeCurrentWindows()

void KisSessionResource::storeCurrentWindows ( )

Definition at line 121 of file KisSessionResource.cpp.

{
    KisPart *kisPart = KisPart::instance();
    const auto &windows = kisPart->mainWindows();
    setWindows(windows);
 
    d->views.clear();
    Q_FOREACH(const KisView *view, kisPart->views()) {
        if (view->document()->path().isEmpty()) continue;
 
        auto viewData = Private::View();
        viewData.windowId = view->mainWindow()->id();
        viewData.file = view->document()->path();
        view->saveViewState(viewData.viewConfig);
        d->views.append(viewData);
    }
 
    setValid(true);
}

References d, KisView::document, KisMainWindow::id, KisPart::instance(), KisView::mainWindow(), KisPart::mainWindows, KisView::saveViewState(), KoResource::setValid(), KisWindowLayoutResource::setWindows(), and KisPart::views.

Friends And Related Symbol Documentation

◆ KisPart

friend class KisPart

friend

Definition at line 42 of file KisSessionResource.h.

Member Data Documentation

◆ d

QScopedPointer<Private> KisSessionResource::d

private

Definition at line 45 of file KisSessionResource.h.

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

libs/ui/KisSessionResource.h
libs/ui/KisSessionResource.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members