KisPart Class Reference

#include <KisPart.h>

Inheritance diagram for KisPart:

Public Slots
void	openExistingFile (const QString &path)
void	openTemplate (const QUrl &url)
void	startCustomDocument (KisDocument *doc)
	startCustomDocument adds the given document to the document list and deletes the sender()

Signals
void	documentClosed (const QString &ref)
void	documentOpened (const QString &ref)
void	playbackEngineChanged (KisPlaybackEngine *newPlaybackEngine)
void	sigDocumentAdded (KisDocument *document)
void	sigDocumentRemoved (const QString &filename)
void	sigDocumentSaved (const QString &url)
void	sigMainWindowCreated ()
void	sigMainWindowIsBeingCreated (KisMainWindow *window)
void	sigViewAdded (KisView *view)
void	sigViewRemoved (KisView *view)

Public Member Functions
void	addDocument (KisDocument *document, bool notify=true)
void	addRecentURLToAllMainWindows (QUrl url, QUrl oldUrl=QUrl())
void	addView (KisView *view)
KisAnimationCachePopulator *	cachePopulator () const
bool	closeSession (bool keepWindows=false)
bool	closingSession () const
KisDocument *	createDocument () const
KisMainWindow *	createMainWindow (QUuid id=QUuid())
KisDocument *	createTemporaryDocument () const
KisView *	createView (KisDocument *document, KisViewManager *viewManager, QWidget *parent)
KisInputManager *	currentInputManager ()
KisMainWindow *	currentMainwindow () const
QWidget *	currentMainwindowAsQWidget () const
int	documentCount () const
QList< QPointer< KisDocument > >	documents () const
KisIdleWatcher *	idleWatcher () const
	KisPart ()
int	mainwindowCount () const
const QList< QPointer< KisMainWindow > > &	mainWindows () const
void	notifyMainWindowIsBeingCreated (KisMainWindow *mainWindow)
	notifyMainWindowIsBeingCreated emits the sigMainWindowCreated signal
class KisPlaybackEngine *	playbackEngine () const
void	prioritizeFrameForCache (KisImageSP image, int frame)
	Private (KisPart *_part)
bool	queryCloseDocument (KisDocument *document)
void	queueAddRecentURLToAllMainWindowsOnFileSaved (QUrl url, QUrl oldUrl=QUrl())
void	removeDocument (KisDocument *document, bool deleteDocument=true)
void	removeMainWindow (KisMainWindow *mainWindow)
void	removeView (KisView *view)
bool	restoreSession (const QString &sessionName)
bool	restoreSession (KisSessionResourceSP session)
void	setCurrentSession (KisSessionResourceSP session)
void	showSessionManager ()
void	startBlankSession ()
void	unloadPlaybackEngine ()
void	upgradeToPlaybackEngineMLT (class KoCanvasBase *canvas)
int	viewCount (KisDocument *doc) const
QList< QPointer< KisView > >	views () const
KisMainWindow *	windowById (QUuid id) const
	~KisPart () override
	~Private ()

Static Public Member Functions
static bool	exists ()
static KisPart *	instance ()

Public Attributes
KisAnimationCachePopulator	animationCachePopulator
bool	closingSession {false}
KisSessionResourceSP	currentSession
QList< QPointer< KisDocument > >	documents
KisIdleWatcher	idleWatcher
QList< QPointer< KisMainWindow > >	mainWindows
KisPart *	part
QMap< QUrl, QUrl >	pendingAddRecentUrlMap
QScopedPointer< KisPlaybackEngine >	playbackEngine
QScopedPointer< KisSessionManagerDialog >	sessionManager
QList< QPointer< KisView > >	views

Private Slots
void	slotDocumentSaved (const QString &filePath)
void	updateIdleWatcherConnections ()
void	updateShortcuts ()

Private Member Functions
void	setPlaybackEngine (KisPlaybackEngine *p_playbackEngine)
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

KisPart a singleton class which provides the main entry point to the application. Krita supports multiple documents, multiple main windows, and multiple components. KisPart manages these resources and provides them to the rest of Krita. It manages lists of Actions and shortcuts as well.

The terminology comes from KParts, which is a system allowing one KDE app to be run from inside another, like pressing F4 inside dolphin to run konsole.

Needless to say, KisPart hasn't got much to do with KParts anymore.

Definition at line 89 of file KisPart.cpp.

Constructor & Destructor Documentation

~Private()

KisPart::~Private ( )

inline

Definition at line 100 of file KisPart.cpp.

    {
    }

KisPart()

KisPart::KisPart ( )

explicit

Constructor.

Parameters

parent

may be another KisDocument, or anything else. Usually passed by KPluginFactory::create.

Definition at line 147 of file KisPart.cpp.

    : d(new Private(this))
{
    // Preload all the resources in the background
    Q_UNUSED(KoResourceServerProvider::instance());
    Q_UNUSED(KisResourceServerProvider::instance());
    Q_UNUSED(KisColorManager::instance());
 
    connect(this, SIGNAL(documentOpened(QString)),
            this, SLOT(updateIdleWatcherConnections()));
 
    connect(this, SIGNAL(documentClosed(QString)),
            this, SLOT(updateIdleWatcherConnections()));
 
    connect(KisActionRegistry::instance(), SIGNAL(shortcutsUpdated()),
            this, SLOT(updateShortcuts()));
    connect(&d->idleWatcher, SIGNAL(startedIdleMode()),
            &d->animationCachePopulator, SLOT(slotRequestRegeneration()));
    connect(&d->idleWatcher, SIGNAL(startedIdleMode()),
            KisMemoryStatisticsServer::instance(), SLOT(tryForceUpdateMemoryStatisticsWhileIdle()));
 
    // We start by loading the simple QTimer-based anim playback engine first.
    // To save RAM, the MLT-based engine will be loaded later, once the KisImage in question becomes animated.
    setPlaybackEngine(new KisPlaybackEngineQT(this));
 
    d->animationCachePopulator.slotRequestRegeneration();
    KisBusyWaitBroker::instance()->setFeedbackCallback(&busyWaitWithFeedback);
}

References connect(), d, documentClosed(), documentOpened(), KisColorManager::instance(), KisMemoryStatisticsServer::instance(), KisBusyWaitBroker::instance(), KisResourceServerProvider::instance(), KoResourceServerProvider::instance(), KisActionRegistry::instance(), KisBusyWaitBroker::setFeedbackCallback(), setPlaybackEngine(), updateIdleWatcherConnections(), and updateShortcuts().

~KisPart()

KisPart::~KisPart ( )

override

Destructor.

The destructor does not delete any attached KisView objects and it does not delete the attached widget as returned by widget().

Definition at line 176 of file KisPart.cpp.

{
    while (!d->documents.isEmpty()) {
        delete d->documents.takeFirst();
    }
 
    while (!d->views.isEmpty()) {
        delete d->views.takeFirst();
    }
 
    while (!d->mainWindows.isEmpty()) {
        delete d->mainWindows.takeFirst();
    }
 
    delete d;
}

References d.

Member Function Documentation

addDocument()

void KisPart::addDocument	(	KisDocument *	document,
		bool	notify = true )

Add the specified document to the list of documents this KisPart manages.

Definition at line 211 of file KisPart.cpp.

{
    //dbgUI << "Adding document to part list" << document;
    Q_ASSERT(document);
    if (!d->documents.contains(document)) {
        d->documents.append(document);
        if (notify){
            Q_EMIT documentOpened('/'+ objectName());
            Q_EMIT sigDocumentAdded(document);
        }
        connect(document, SIGNAL(sigSavingFinished(QString)), SLOT(slotDocumentSaved(QString)));
    }
}

References connect(), d, documentOpened(), sigDocumentAdded(), and slotDocumentSaved().

addRecentURLToAllMainWindows()

void KisPart::addRecentURLToAllMainWindows	(	QUrl	url,
		QUrl	oldUrl = QUrl() )

Definition at line 598 of file KisPart.cpp.

{
    // Add entry to recent documents list
    // (call coming from KisDocument because it must work with cmd line, template dlg, file/open, etc.)
    if (!url.isEmpty()) {
        bool ok = true;
        if (url.isLocalFile()) {
            QString path = url.adjusted(QUrl::StripTrailingSlash).toLocalFile();
            const QStringList tmpDirs = QStandardPaths::locateAll(QStandardPaths::TempLocation, "", QStandardPaths::LocateDirectory);
            for (QStringList::ConstIterator it = tmpDirs.begin() ; ok && it != tmpDirs.end() ; ++it) {
                if (path.contains(*it)) {
                    ok = false; // it's in the tmp resource
                }
            }
 
            const QStringList templateDirs = KoResourcePaths::findDirs("templates");
            for (QStringList::ConstIterator it = templateDirs.begin() ; ok && it != templateDirs.end() ; ++it) {
                if (path.contains(*it)) {
                    ok = false; // it's in the templates directory.
                    break;
                }
            }
        }
        if (ok) {
            if (!oldUrl.isEmpty()) {
                KisRecentFilesManager::instance()->remove(oldUrl);
            }
            KisRecentFilesManager::instance()->add(url);
        }
    }
}

References KisRecentFilesManager::add(), KoResourcePaths::findDirs(), KisRecentFilesManager::instance(), and KisRecentFilesManager::remove().

addView()

void KisPart::addView

(

KisView *

view

)

Adds a view to the document. If the part doesn't know yet about the document, it is registered.

This calls KisView::updateReadWrite to tell the new view whether the document is readonly or not.

Definition at line 332 of file KisPart.cpp.

{
    if (!view)
        return;
 
    if (!d->views.contains(view)) {
        d->views.append(view);
    }
 
    Q_EMIT sigViewAdded(view);
}

References d, and sigViewAdded().

cachePopulator()

KisAnimationCachePopulator * KisPart::cachePopulator

(

)

const

Returns

the application-wide AnimationCachePopulator.

Definition at line 520 of file KisPart.cpp.

{
    return &d->animationCachePopulator;
}

References d.

closeSession()

bool KisPart::closeSession

(

bool

keepWindows = false

)

Attempts to save the session and close all windows. This may involve asking the user to save open files.

Returns

false, if closing was cancelled by the user

Definition at line 406 of file KisPart.cpp.

{
    d->closingSession = true;
 
    Q_FOREACH(auto document, d->documents) {
        if (!d->queryCloseDocument(document.data())) {
            d->closingSession = false;
            return false;
        }
    }
 
    if (d->currentSession) {
        KisConfig kisCfg(false);
        if (kisCfg.saveSessionOnQuit(false)) {
 
            d->currentSession->storeCurrentWindows();
            KisResourceModel model(ResourceType::Sessions);
            bool result = model.updateResource(d->currentSession);
            Q_UNUSED(result);
 
            KConfigGroup cfg = KSharedConfig::openConfig()->group("session");
            cfg.writeEntry("previousSession", d->currentSession->name());
        }
 
        d->currentSession = nullptr;
    }
 
    if (!keepWindows) {
        Q_FOREACH (auto window, d->mainWindows) {
            window->close();
        }
 
        if (d->sessionManager) {
            d->sessionManager->close();
        }
    }
 
    d->closingSession = false;
    return true;
}

References d, KisConfig::saveSessionOnQuit(), ResourceType::Sessions, and KisResourceModel::updateResource().

closingSession()

bool KisPart::closingSession

(

)

const

Are we in the process of closing the application through closeSession().

createDocument()

KisDocument * KisPart::createDocument

(

)

const

create an empty document. The document is not automatically registered with the part.

Definition at line 230 of file KisPart.cpp.

{
    KisDocument *doc = new KisDocument();
    return doc;
}

createMainWindow()

KisMainWindow * KisPart::createMainWindow

(

QUuid

id = QUuid()

)

Create a new main window.

Definition at line 260 of file KisPart.cpp.

{
    KisMainWindow *mw = new KisMainWindow(id);
    dbgUI <<"mainWindow" << (void*)mw << "added to view" << this;
    d->mainWindows.append(mw);
 
    // Add all actions with a menu property to the main window
    Q_FOREACH(QAction *action, mw->actionCollection()->actions()) {
        QString menuLocation = action->property("menulocation").toString();
        if (!menuLocation.isEmpty()) {
            QAction *found = 0;
            QList<QAction *> candidates = mw->menuBar()->actions();
            Q_FOREACH(const QString &name, menuLocation.split("/")) {
                Q_FOREACH(QAction *candidate, candidates) {
                    if (candidate->objectName().toLower() == name.toLower()) {
                        found = candidate;
                        candidates = candidate->menu()->actions();
                        break;
                    }
                }
                if (candidates.isEmpty()) {
                    break;
                }
            }
 
            if (found && found->menu()) {
                found->menu()->addAction(action);
            }
        }
    }
 
 
    return mw;
}

References KisKXMLGUIClient::actionCollection(), KisKActionCollection::actions(), d, and dbgUI.

createTemporaryDocument()

KisDocument * KisPart::createTemporaryDocument

(

)

const

create a throwaway empty document. The document does not register a resource storage

Definition at line 236 of file KisPart.cpp.

{
    KisDocument *doc = new KisDocument(false);
    return doc;
}

createView()

KisView * KisPart::createView	(	KisDocument *	document,
		KisViewManager *	viewManager,
		QWidget *	parent )

Create a new view for the document. The view is added to the list of views, and if the document wasn't known yet, it's registered as well.

Definition at line 301 of file KisPart.cpp.

{
    // If creating the canvas fails, record this and disable OpenGL next time
    KisConfig cfg(false);
    KConfigGroup grp( KSharedConfig::openConfig(), "crashprevention");
    if (grp.readEntry("CreatingCanvas", false)) {
        cfg.disableOpenGL();
    }
    if (cfg.canvasState() == "OPENGL_FAILED") {
        cfg.disableOpenGL();
    }
    grp.writeEntry("CreatingCanvas", true);
    grp.sync();
 
    KisView *view = nullptr;
    {
        KisCursorOverrideLock cursorLock(Qt::WaitCursor);
        view = new KisView(document,  viewManager, parent);
    }
 
    // Record successful canvas creation
    grp.writeEntry("CreatingCanvas", false);
    grp.sync();
 
    addView(view);
 
    return view;
}

References addView(), KisConfig::canvasState(), and KisConfig::disableOpenGL().

currentInputManager()

KisInputManager * KisPart::currentInputManager

(

)

Definition at line 643 of file KisPart.cpp.

{
    KisMainWindow *mw = currentMainwindow();
    KisViewManager *manager = mw ? mw->viewManager() : 0;
    return manager ? manager->inputManager() : 0;
}

References currentMainwindow(), KisViewManager::inputManager(), and KisMainWindow::viewManager.

currentMainwindow()

KisMainWindow * KisPart::currentMainwindow

(

)

const

Returns

the currently active main window.

Definition at line 483 of file KisPart.cpp.

{
    QWidget *widget = qApp->activeWindow();
    KisMainWindow *mainWindow = qobject_cast<KisMainWindow*>(widget);
    while (!mainWindow && widget) {
        widget = widget->parentWidget();
        mainWindow = qobject_cast<KisMainWindow*>(widget);
    }
 
    if (!mainWindow && mainWindows().size() > 0) {
        mainWindow = mainWindows().first();
    }
    return mainWindow;
 
}

References mainWindows.

currentMainwindowAsQWidget()

QWidget * KisPart::currentMainwindowAsQWidget

(

)

const

Gets the currently active KisMainWindow as a QWidget, useful when you just need it to be used as a parent to a dialog or window without needing to include KisMainWindow.h.

Definition at line 499 of file KisPart.cpp.

{
    return currentMainwindow();
}

References currentMainwindow().

documentClosed

void KisPart::documentClosed ( const QString & ref )

signal

emitted when an old document is closed. (for the idle watcher)

documentCount()

int KisPart::documentCount

(

)

const

Returns

number of documents this part manages.

Definition at line 243 of file KisPart.cpp.

{
    return d->documents.size();
}

References d.

documentOpened

void KisPart::documentOpened ( const QString & ref )

signal

emitted when a new document is opened. (for the idle watcher)

documents()

QList< QPointer< KisDocument > > KisPart::documents

(

)

const

Returns

a list of all documents this part manages

exists()

bool KisPart::exists ( )

static

This function returns true if the instance has already been initialized, false otherwise. This to prevent premature initialization that causes crash on android see 1fbb25506a

See also

QGlobalStatic::exists()

Definition at line 401 of file KisPart.cpp.

{
    return s_instance.exists();
}

idleWatcher()

KisIdleWatcher * KisPart::idleWatcher

(

)

const

Returns

the application-wide KisIdleWatcher.

instance()

KisPart * KisPart::instance ( )

static

Definition at line 131 of file KisPart.cpp.

{
    return s_instance;
}

mainwindowCount()

int KisPart::mainwindowCount

(

)

const

Returns

the number of shells for the main window

Definition at line 477 of file KisPart.cpp.

{
    return d->mainWindows.count();
}

References d.

mainWindows()

const QList< QPointer< KisMainWindow > > & KisPart::mainWindows

(

)

const

Returns

the list of main windows.

notifyMainWindowIsBeingCreated()

void KisPart::notifyMainWindowIsBeingCreated

(

KisMainWindow *

mainWindow

)

notifyMainWindowIsBeingCreated emits the sigMainWindowCreated signal

Parameters

mainWindow

Definition at line 295 of file KisPart.cpp.

{
    Q_EMIT sigMainWindowIsBeingCreated(mainWindow);
}

References sigMainWindowIsBeingCreated().

openExistingFile

void KisPart::openExistingFile ( const QString & path )

slot

This slot loads an existing file.

Parameters

path	the file to load

Definition at line 537 of file KisPart.cpp.

{
    // TODO: refactor out this method!
 
    KisMainWindow *mw = currentMainwindow();
    KIS_SAFE_ASSERT_RECOVER_RETURN(mw);
 
    mw->openDocument(path, KisMainWindow::None);
}

References currentMainwindow(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisMainWindow::None, and KisMainWindow::openDocument().

openTemplate

void KisPart::openTemplate ( const QUrl & url )

slot

This slot loads a template and deletes the sender.

Parameters

url	the template to load

Definition at line 558 of file KisPart.cpp.

{
    KisCursorOverrideLock cursorLock(Qt::BusyCursor);
 
    KisDocument *document = createDocument();
 
    bool ok = document->loadNativeFormat(url.toLocalFile());
    document->setModified(false);
    document->undoStack()->clear();
    document->documentInfo()->resetMetaData();
 
    if (ok) {
        QString mimeType = KisMimeDatabase::mimeTypeForFile(url.toLocalFile());
        // in case this is a open document template remove the -template from the end
        mimeType.remove( QRegularExpression( "-template$" ) );
        document->setMimeTypeAfterLoading(mimeType);
        document->resetPath();
        document->setReadWrite(true);
    }
    else {
        if (document->errorMessage().isEmpty()) {
            QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita"), i18n("Could not create document from template\n%1", document->localFilePath()));
        }
        else {
            QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita"), i18n("Could not create document from template\n%1\nReason: %2", document->localFilePath(), document->errorMessage()));
        }
        delete document;
        return;
    }
    QMap<QString, QString> dictionary;
    // XXX: fill the dictionary from the desktop file
    KisTranslateLayerNamesVisitor v(dictionary);
    document->image()->rootLayer()->accept(v);
 
    addDocument(document);
 
    KisMainWindow *mw = currentMainwindow();
    mw->addViewAndNotifyLoadingCompleted(document);
}

References addDocument(), KisMainWindow::addViewAndNotifyLoadingCompleted(), createDocument(), currentMainwindow(), KisMimeDatabase::mimeTypeForFile(), and v.

playbackEngine()

class KisPlaybackEngine * KisPart::playbackEngine

(

)

const

playbackEngineChanged

void KisPart::playbackEngineChanged ( KisPlaybackEngine * newPlaybackEngine )

signal

Emitted when the animation PlaybackEngine is changed. GUI objects that want to control playback should watch this signal and connect to the new playbackEgine as needed.

prioritizeFrameForCache()

void KisPart::prioritizeFrameForCache	(	KisImageSP	image,
		int	frame )

Adds a frame time index to a priority stack, which should be cached immediately and irregardless of whether it is the the currently occupied frame. The process of regeneration is started immediately.

Definition at line 530 of file KisPart.cpp.

                                                                 {
    KisImageAnimationInterface* animInterface = image->animationInterface();
    if ( animInterface && animInterface->documentPlaybackRange().contains(frame)) {
        d->animationCachePopulator.requestRegenerationWithPriorityFrame(image, frame);
    }
}

References KisImage::animationInterface(), KisTimeSpan::contains(), d, and KisImageAnimationInterface::documentPlaybackRange().

Private()

KisPart::Private ( KisPart * _part )

inline

Definition at line 92 of file KisPart.cpp.

        : part(_part)
        , idleWatcher(2500)
        , animationCachePopulator(_part)
        , playbackEngine(nullptr)
    {
    }

queryCloseDocument()

bool KisPart::queryCloseDocument ( KisDocument * document )

inline

Definition at line 119 of file KisPart.cpp.

                                                   {
        Q_FOREACH(auto view, views) {
            if (view && view->isVisible() && view->document() == document) {
                return view->queryClose();
            }
        }
 
        return true;
    }

queueAddRecentURLToAllMainWindowsOnFileSaved()

void KisPart::queueAddRecentURLToAllMainWindowsOnFileSaved	(	QUrl	url,
		QUrl	oldUrl = QUrl() )

Registers a file path to be added to the recents list, but do not apply until the file has finished saving.

Definition at line 630 of file KisPart.cpp.

{
    d->pendingAddRecentUrlMap.insert(url, oldUrl);
}

References d.

removeDocument()

void KisPart::removeDocument	(	KisDocument *	document,
		bool	deleteDocument = true )

Definition at line 248 of file KisPart.cpp.

{
    if (document) {
        d->documents.removeAll(document);
        Q_EMIT documentClosed('/' + objectName());
        Q_EMIT sigDocumentRemoved(document->path());
        if (deleteDocument) {
            document->deleteLater();
        }
    }
}

References d, documentClosed(), and sigDocumentRemoved().

removeMainWindow()

void KisPart::removeMainWindow

(

KisMainWindow *

mainWindow

)

Removes a main window from the list of managed windows.

This is called by the MainWindow after it finishes its shutdown routine.

Definition at line 464 of file KisPart.cpp.

{
    dbgUI <<"mainWindow" << (void*)mainWindow <<"removed from doc" << this;
    if (mainWindow) {
        d->mainWindows.removeAll(mainWindow);
    }
}

References d, and dbgUI.

removeView()

void KisPart::removeView

(

KisView *

view

)

Removes a view of the document.

HACK ALERT: we check here explicitly if the document (or main window), is saving the stuff. If we close the document before the saving is completed, a crash will happen.

Definition at line 344 of file KisPart.cpp.

{
    if (!view) return;
 
    KIS_ASSERT_RECOVER_RETURN(!view->mainWindow()->hackIsSaving());
 
    Q_EMIT sigViewRemoved(view);
 
    QPointer<KisDocument> doc = view->document();
    d->views.removeAll(view);
 
    if (doc) {
        bool found = false;
        Q_FOREACH (QPointer<KisView> view, d->views) {
            if (view && view->document() == doc) {
                found = true;
                break;
            }
        }
        if (!found) {
            removeDocument(doc);
        }
    }
}

References d, KisView::document, KisMainWindow::hackIsSaving(), KIS_ASSERT_RECOVER_RETURN, KisView::mainWindow(), removeDocument(), and sigViewRemoved().

restoreSession() [1/2]

bool KisPart::restoreSession

(

const QString &

sessionName

)

Restores a saved session by name

Definition at line 668 of file KisPart.cpp.

{
    if (sessionName.isNull()) return false;
 
    KoResourceServer<KisSessionResource> *rserver = KisResourceServerProvider::instance()->sessionServer();
    KisSessionResourceSP session = rserver->resource("", "", sessionName);
    if (!session || !session->valid()) return false;
 
    return restoreSession(session);
}

References KisResourceServerProvider::instance(), KoResourceServer< T >::resource(), restoreSession(), and KisResourceServerProvider::sessionServer().

restoreSession() [2/2]

bool KisPart::restoreSession

(

KisSessionResourceSP

session

)

Definition at line 679 of file KisPart.cpp.

{
    session->restore();
    d->currentSession = session;
    return true;
}

References d.

setCurrentSession()

void KisPart::setCurrentSession

(

KisSessionResourceSP

session

)

Definition at line 686 of file KisPart.cpp.

{
    d->currentSession = session;
}

References d.

setPlaybackEngine()

void KisPart::setPlaybackEngine ( KisPlaybackEngine * p_playbackEngine )

private

Definition at line 719 of file KisPart.cpp.

{
    // make sure that the old engine is still alive until the end
    // of the emitted signal
    QScopedPointer backup(p_playbackEngine);
    d->playbackEngine.swap(backup);
 
    // Log all changes to playback engine for easier debugging.
    // (See `krita.log` or `Help > Show Krita log for bug reports`.)
    KisUsageLogger::log("Audio Playback Engine: " + QString(p_playbackEngine->metaObject()->className()));
 
    Q_EMIT playbackEngineChanged(p_playbackEngine);
}

References d, KisUsageLogger::log(), and playbackEngineChanged().

showSessionManager()

void KisPart::showSessionManager

(

)

Definition at line 650 of file KisPart.cpp.

{
    if (d->sessionManager.isNull()) {
        d->sessionManager.reset(new KisSessionManagerDialog());
    }
 
    d->sessionManager->show();
    d->sessionManager->activateWindow();
}

References d.

sigDocumentAdded

void KisPart::sigDocumentAdded ( KisDocument * document )

signal

sigDocumentRemoved

void KisPart::sigDocumentRemoved ( const QString & filename )

signal

sigDocumentSaved

void KisPart::sigDocumentSaved ( const QString & url )

signal

sigMainWindowCreated

void KisPart::sigMainWindowCreated ( )

signal

sigMainWindowIsBeingCreated

void KisPart::sigMainWindowIsBeingCreated ( KisMainWindow * window )

signal

sigViewAdded

void KisPart::sigViewAdded ( KisView * view )

signal

sigViewRemoved

void KisPart::sigViewRemoved ( KisView * view )

signal

slotDocumentSaved

void KisPart::slotDocumentSaved ( const QString & filePath )

privateslot

Definition at line 447 of file KisPart.cpp.

{
    // We used to use doc->path(), but it does not contain the correct output
    // file path when doing an export, therefore we now pass it directly from
    // the sigSavingFinished signal.
    // KisDocument *doc = qobject_cast<KisDocument*>(sender());
    Q_EMIT sigDocumentSaved(filePath);
 
    QUrl url = QUrl::fromLocalFile(filePath);
    KisRecentFileIconCache::instance()->reloadFileIcon(url);
    if (!d->pendingAddRecentUrlMap.contains(url)) {
        return;
    }
    QUrl oldUrl = d->pendingAddRecentUrlMap.take(url);
    addRecentURLToAllMainWindows(url, oldUrl);
}

References addRecentURLToAllMainWindows(), d, KisRecentFileIconCache::instance(), KisRecentFileIconCache::reloadFileIcon(), and sigDocumentSaved().

startBlankSession()

void KisPart::startBlankSession

(

)

Definition at line 660 of file KisPart.cpp.

{
    KisMainWindow *window = createMainWindow();
    window->initializeGeometry();
    window->show();
 
}

References createMainWindow(), and KisMainWindow::initializeGeometry().

startCustomDocument

void KisPart::startCustomDocument ( KisDocument * doc )

slot

startCustomDocument adds the given document to the document list and deletes the sender()

Parameters

doc

Definition at line 635 of file KisPart.cpp.

{
    addDocument(doc);
    KisMainWindow *mw = currentMainwindow();
    mw->addViewAndNotifyLoadingCompleted(doc);
 
}

References addDocument(), KisMainWindow::addViewAndNotifyLoadingCompleted(), and currentMainwindow().

unloadPlaybackEngine()

void KisPart::unloadPlaybackEngine

(

)

Called on application to make sure that the engine is unloaded before the MLT library is actually unloaded

Definition at line 710 of file KisPart.cpp.

{
#ifdef HAVE_MLT
 
    d->playbackEngine.reset();
 
#endif //HAVE_MLT
}

References d.

updateIdleWatcherConnections

void KisPart::updateIdleWatcherConnections ( )

privateslot

Update memory stats on changing the amount of images open in Krita

Definition at line 193 of file KisPart.cpp.

{
    QVector<KisImageSP> images;
 
    Q_FOREACH (QPointer<KisDocument> document, documents()) {
        if (document->image()) {
            images << document->image();
        }
    }
 
    d->idleWatcher.setTrackedImages(images);
 
    d->idleWatcher.forceImageModified();
}

References d, and documents.

updateShortcuts

void KisPart::updateShortcuts ( )

privateslot

Definition at line 547 of file KisPart.cpp.

{
    // Update the UI actions. KisActionRegistry also takes care of updating
    // shortcut hints in tooltips.
    Q_FOREACH (KisMainWindow *mainWindow, d->mainWindows) {
        KisKActionCollection *ac = mainWindow->actionCollection();
 
        ac->updateShortcuts();
    }
}

References KisKXMLGUIClient::actionCollection(), d, and KisKActionCollection::updateShortcuts().

upgradeToPlaybackEngineMLT()

void KisPart::upgradeToPlaybackEngineMLT

(

class KoCanvasBase *

canvas

)

Definition at line 691 of file KisPart.cpp.

{
#ifdef HAVE_MLT
 
    // TODO: This is a slightly hacky workaround to loading the MLT engine over itself,
    // as the QT-based engine no longer supports audio. Is there a better way?
    if (d->playbackEngine->supportsAudio()) {
        return;
    }
 
    setPlaybackEngine(new KisPlaybackEngineMLT(this));
 
    if (canvas) {
        d->playbackEngine->setObservedCanvas(canvas);
    }
 
#endif //HAVE_MLT
}

References Private::canvas, d, and setPlaybackEngine().

viewCount()

int KisPart::viewCount

(

KisDocument *

doc

)

const

Returns

number of views this document is displayed in

Definition at line 380 of file KisPart.cpp.

{
    if (!doc) {
        return d->views.count();
    }
    else {
        int count = 0;
        Q_FOREACH (QPointer<KisView> view, d->views) {
            if (view && view->isVisible() && view->document() == doc) {
                count++;
            }
        }
        return count;
    }
}

References d.

views()

QList< QPointer< KisView > > KisPart::views

(

)

const

Returns

a list of views this document is displayed in

windowById()

KisMainWindow * KisPart::windowById

(

QUuid

id

)

const

Definition at line 504 of file KisPart.cpp.

{
    Q_FOREACH(QPointer<KisMainWindow> mainWindow, d->mainWindows) {
        if (mainWindow->id() == id) {
            return mainWindow;
        }
    }
 
    return nullptr;
}

References d.

Member Data Documentation

animationCachePopulator

KisAnimationCachePopulator KisPart::animationCachePopulator

Definition at line 110 of file KisPart.cpp.

closingSession

bool KisPart::closingSession {false}

Definition at line 114 of file KisPart.cpp.

{false};

currentSession

KisSessionResourceSP KisPart::currentSession

Definition at line 113 of file KisPart.cpp.

d

Private* const KisPart::d

private

Definition at line 328 of file KisPart.h.

documents

QList< QPointer< KisDocument > > KisPart::documents

Definition at line 108 of file KisPart.cpp.

idleWatcher

KisIdleWatcher * KisPart::idleWatcher

Definition at line 109 of file KisPart.cpp.

mainWindows

const QList< QPointer< KisMainWindow > > & KisPart::mainWindows

Definition at line 107 of file KisPart.cpp.

part

KisPart* KisPart::part

Definition at line 104 of file KisPart.cpp.

pendingAddRecentUrlMap

QMap<QUrl, QUrl> KisPart::pendingAddRecentUrlMap

Definition at line 117 of file KisPart.cpp.

playbackEngine

KisPlaybackEngine * KisPart::playbackEngine

Definition at line 111 of file KisPart.cpp.

sessionManager

QScopedPointer<KisSessionManagerDialog> KisPart::sessionManager

Definition at line 115 of file KisPart.cpp.

views

QList< QPointer< KisView > > KisPart::views

Definition at line 106 of file KisPart.cpp.

---

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

• libs/ui/KisPart.cpp
• libs/ui/KisPart.h