GamutMaskDock Class Reference

#include <gamutmask_dock.h>

Inheritance diagram for GamutMaskDock:

Signals
void	sigGamutMaskChanged (KoGamutMaskSP mask)
void	sigGamutMaskPreviewUpdate ()
void	sigGamutMaskSet (KoGamutMaskSP mask)
void	sigGamutMaskUnset ()

Public Member Functions
	GamutMaskDock ()
QString	observerName () override
void	removingResource (KoGamutMaskSP resource) override
void	resourceAdded (KoGamutMaskSP) override
void	resourceChanged (KoGamutMaskSP resource) override
void	setCanvas (KoCanvasBase *canvas) override
void	setViewManager (KisViewManager *kisview) override
void	unsetCanvas () override
void	unsetResourceServer () override
	~GamutMaskDock () override
Public Member Functions inherited from KisMainwindowObserver
	KisMainwindowObserver ()
	~KisMainwindowObserver () override
Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()
KoCanvasBase *	observedCanvas () const
void	setObservedCanvas (KoCanvasBase *canvas)
void	unsetObservedCanvas ()
virtual	~KoCanvasObserverBase ()
Public Member Functions inherited from KoResourceServerObserver< KoGamutMask >
virtual	~KoResourceServerObserver ()

Private Slots
void	slotDocumentRemoved (QString filename)
void	slotDocumentSaved ()
void	slotGamutMaskCancelEdit ()
void	slotGamutMaskCreateNew ()
void	slotGamutMaskDelete ()
void	slotGamutMaskDuplicate ()
void	slotGamutMaskEdit ()
void	slotGamutMaskPreview ()
void	slotGamutMaskSave ()
void	slotGamutMaskSelected (KoGamutMaskSP mask)
void	slotViewChanged ()

Private Member Functions
void	cancelMaskEdit ()
void	closeMaskDocument ()
KoGamutMaskSP	createMaskResource (KoGamutMaskSP sourceMask, QString newTitle)
void	deleteMask ()
KisShapeLayerSP	getShapeLayer ()
QList< KoShape * >	getShapesFromLayer ()
int	getUserFeedback (QString text, QString informativeText="", QMessageBox::StandardButtons buttons=QMessageBox::Yes|QMessageBox::No, QMessageBox::StandardButton defaultButton=QMessageBox::Yes, QMessageBox::Icon severity=QMessageBox::Warning)
bool	openMaskEditor ()
QPair< QString, QFileInfo >	resolveMaskTitle (QString suggestedTitle)
int	saveOrCancel (QMessageBox::StandardButton defaultAction=QMessageBox::Save)
bool	saveSelectedMaskResource ()
void	selectMask (KoGamutMaskSP mask, bool notifyItemChooser=true)

Private Attributes
bool	m_creatingNewMask {false}
GamutMaskChooserUI *	m_dockerUI {nullptr}
bool	m_externalTemplateClose {false}
KisResourceItemChooser *	m_maskChooser {nullptr}
KisDocument *	m_maskDocument {nullptr}
KisCanvasResourceProvider *	m_resourceProvider {nullptr}
KoGamutMaskSP	m_selectedMask
bool	m_selfClosingTemplate {false}
bool	m_selfSelectingMask {false}
bool	m_templatePrevSaved {false}
KisView *	m_view {nullptr}

Additional Inherited Members

Detailed Description

Definition at line 30 of file gamutmask_dock.h.

Constructor & Destructor Documentation

GamutMaskDock()

GamutMaskDock::GamutMaskDock

(

)

Definition at line 55 of file gamutmask_dock.cpp.

    : QDockWidget(i18n("Gamut Masks"))
{
    m_dockerUI    = new GamutMaskChooserUI();
 
    m_dockerUI->bnMaskEditor->setIcon(KisIconUtils::loadIcon("document-edit"));
    m_dockerUI->bnMaskDelete->setIcon(KisIconUtils::loadIcon("edit-delete"));
    m_dockerUI->bnMaskNew->setIcon(KisIconUtils::loadIcon("list-add"));
    m_dockerUI->bnMaskDuplicate->setIcon(KisIconUtils::loadIcon("duplicateitem"));
 
    m_dockerUI->maskPropertiesBox->setVisible(false);
    m_dockerUI->bnSaveMask->setIcon(KisIconUtils::loadIcon("document-save-16"));
    m_dockerUI->bnCancelMaskEdit->setIcon(KisIconUtils::loadIcon("dialog-cancel"));
    m_dockerUI->bnPreviewMask->setIcon(KisIconUtils::loadIcon("visible"));
 
    QRegularExpression maskTitleRegex("^[-_\\(\\)\\sA-Za-z0-9]+$");
    QRegularExpressionValidator* m_maskTitleValidator = new QRegularExpressionValidator(maskTitleRegex, this);
    m_dockerUI->maskTitleEdit->setValidator(m_maskTitleValidator);
 
    KoResourceServer<KoGamutMask>* rServer = KoResourceServerProvider::instance()->gamutMaskServer();
    rServer->addObserver(this);
 
    // gamut mask connections
    connect(m_dockerUI->bnSaveMask        , SIGNAL(clicked())                        , SLOT(slotGamutMaskSave()));
    connect(m_dockerUI->bnCancelMaskEdit        , SIGNAL(clicked())                        , SLOT(slotGamutMaskCancelEdit()));
    connect(m_dockerUI->bnPreviewMask        , SIGNAL(clicked())                        , SLOT(slotGamutMaskPreview()));
 
    connect(m_dockerUI->bnMaskEditor          , SIGNAL(clicked())               , SLOT(slotGamutMaskEdit()));
    connect(m_dockerUI->maskChooser, SIGNAL(sigGamutMaskSelected(KoGamutMaskSP)), SLOT(slotGamutMaskSelected(KoGamutMaskSP)));
    connect(m_dockerUI->bnMaskNew          , SIGNAL(clicked())               , SLOT(slotGamutMaskCreateNew()));
    connect(m_dockerUI->bnMaskDelete          , SIGNAL(clicked())               , SLOT(slotGamutMaskDelete()));
    connect(m_dockerUI->bnMaskDuplicate       , SIGNAL(clicked())               , SLOT(slotGamutMaskDuplicate()));
 
    setWidget(m_dockerUI);
}

References KoResourceServer< T >::addObserver(), connect(), KoResourceServerProvider::gamutMaskServer, KoResourceServerProvider::instance(), KisIconUtils::loadIcon(), m_dockerUI, slotGamutMaskCancelEdit(), slotGamutMaskCreateNew(), slotGamutMaskDelete(), slotGamutMaskDuplicate(), slotGamutMaskEdit(), slotGamutMaskPreview(), slotGamutMaskSave(), and slotGamutMaskSelected().

~GamutMaskDock()

GamutMaskDock::~GamutMaskDock ( )

override

Definition at line 91 of file gamutmask_dock.cpp.

{
    KoResourceServer<KoGamutMask>* rServer = KoResourceServerProvider::instance()->gamutMaskServer();
    rServer->removeObserver(this);
}

References KoResourceServerProvider::gamutMaskServer, KoResourceServerProvider::instance(), and KoResourceServer< T >::removeObserver().

Member Function Documentation

cancelMaskEdit()

void GamutMaskDock::cancelMaskEdit ( )

private

Definition at line 193 of file gamutmask_dock.cpp.

{
    if (m_creatingNewMask) {
        deleteMask();
    }
 
    if (m_selectedMask) {
        m_selectedMask->clearPreview();
 
        if (m_resourceProvider->currentGamutMask() == m_selectedMask) {
            Q_EMIT sigGamutMaskChanged(m_selectedMask);
        }
    }
 
    closeMaskDocument();
}

References closeMaskDocument(), KisCanvasResourceProvider::currentGamutMask(), deleteMask(), m_creatingNewMask, m_resourceProvider, m_selectedMask, and sigGamutMaskChanged().

closeMaskDocument()

void GamutMaskDock::closeMaskDocument ( )

private

Definition at line 372 of file gamutmask_dock.cpp.

{
    if (m_maskDocument) {
 
        disconnect(m_view->viewManager(), SIGNAL(viewChanged()), this, SLOT(slotViewChanged()));
        disconnect(m_maskDocument, SIGNAL(completed()), this, SLOT(slotDocumentSaved()));
 
        // the template file is meant as temporary, if the user saved it, delete now
        if (QFile::exists(m_maskDocument->localFilePath())) {
            QFile::remove(m_maskDocument->localFilePath());
        }
 
        if (!m_externalTemplateClose) {
            // set the document to not modified to bypass confirmation dialog
            // the close is already confirmed
            m_maskDocument->setModified(false);
 
            m_maskDocument->closePath();
            m_view->closeView();
            m_view->deleteLater();
 
            // set a flag that we are doing it ourselves, so the docker does not react to
            // removing signal from KisPart
            m_selfClosingTemplate = true;
            KisPart::instance()->removeView(m_view);
            KisPart::instance()->removeDocument(m_maskDocument);
            m_selfClosingTemplate = false;
        }
    }
 
    m_dockerUI->maskPropertiesBox->setVisible(false);
    m_dockerUI->editControlsBox->setVisible(true);
    m_dockerUI->editControlsBox->setEnabled(true);
 
    m_maskDocument = nullptr;
    m_view = nullptr;
    m_creatingNewMask = false;
    m_templatePrevSaved = false;
}

References KisDocument::closePath(), KisView::closeView(), KisPart::instance(), KisDocument::localFilePath(), m_creatingNewMask, m_dockerUI, m_externalTemplateClose, m_maskDocument, m_selfClosingTemplate, m_templatePrevSaved, m_view, KisPart::removeDocument(), KisPart::removeView(), KisDocument::setModified(), slotDocumentSaved(), slotViewChanged(), and KisView::viewManager.

createMaskResource()

KoGamutMaskSP GamutMaskDock::createMaskResource ( KoGamutMaskSP sourceMask, QString newTitle )

private

Definition at line 337 of file gamutmask_dock.cpp.

{
    m_creatingNewMask = true;
 
    KoGamutMaskSP newMask;
    if (sourceMask) {
        newMask = KoGamutMaskSP(new KoGamutMask(sourceMask.data()));
        newMask->setVersion(-1);
        newMask->setResourceId(-1);
        newMask->setImage(sourceMask->image());
    } else {
        newMask = KoGamutMaskSP(new KoGamutMask());
 
        QString defaultPreviewPath = ":/gamutmasks/empty_mask_preview.png";
        KIS_SAFE_ASSERT_RECOVER_NOOP(!(defaultPreviewPath.isEmpty() || defaultPreviewPath.isNull() || !QFile::exists(defaultPreviewPath)));
 
        newMask->setImage(QImage(defaultPreviewPath, "PNG"));
    }
 
    KoResourceServer<KoGamutMask>* rServer = KoResourceServerProvider::instance()->gamutMaskServer();
 
    QString saveLocation = rServer->saveLocation();
    QString name = newTitle;
 
    QFileInfo fileInfo(saveLocation + "/" + name + newMask->defaultFileExtension());
 
    newMask->setTitle(name);
    newMask->setFilename(fileInfo.fileName());
    newMask->setValid(true);
 
    // don't save just yet; saving will happen when the user presses Save button on editing
 
    return newMask;
}

References KoResourceServerProvider::gamutMaskServer, KoResourceServerProvider::instance(), KIS_SAFE_ASSERT_RECOVER_NOOP, m_creatingNewMask, and KoResourceServer< T >::saveLocation().

deleteMask()

void GamutMaskDock::deleteMask ( )

private

Definition at line 278 of file gamutmask_dock.cpp.

{
    KisResourceModel model(ResourceType::GamutMasks);
    QModelIndex idx = model.indexForResource(m_selectedMask);
    if (idx.isValid()) {
        model.setResourceInactive(idx);
    }
    m_selectedMask = nullptr;
}

References ResourceType::GamutMasks, KisResourceModel::indexForResource(), m_selectedMask, and KisAbstractResourceModel::setResourceInactive().

getShapeLayer()

KisShapeLayerSP GamutMaskDock::getShapeLayer ( )

private

Definition at line 433 of file gamutmask_dock.cpp.

{
    KisNodeSP node = KisLayerUtils::findNodeByName(m_maskDocument->image()->rootLayer(),"maskShapesLayer");
    return KisShapeLayerSP(dynamic_cast<KisShapeLayer*>(node.data()));
}

References KisSharedPtr< T >::data(), KisLayerUtils::findNodeByName(), KisDocument::image, m_maskDocument, and KisImage::rootLayer().

getShapesFromLayer()

QList< KoShape * > GamutMaskDock::getShapesFromLayer ( )

private

Definition at line 412 of file gamutmask_dock.cpp.

{
    KisShapeLayerSP shapeLayer = getShapeLayer();
 
    // create a deep copy of the shapes to save in the mask,
    // otherwise they vanish when the template closes
    QList<KoShape*> newShapes;
 
    if (shapeLayer) {
        for (KoShape* sh: shapeLayer->shapes()) {
            KoShape* newShape = sh->cloneShape();
            KoShapeStrokeSP border(new KoShapeStroke(0.5f, Qt::white));
            newShape->setStroke(border);
            newShape->setBackground(QSharedPointer<KoColorBackground>(new KoColorBackground(QColor(255,255,255,0))));
            newShapes.append(newShape);
        }
    }
 
    return newShapes;
}

References KoShape::cloneShape(), getShapeLayer(), KoShape::setBackground(), KoShape::setStroke(), and KoShapeContainer::shapes().

getUserFeedback()

int GamutMaskDock::getUserFeedback ( QString text, QString informativeText = "", QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No, QMessageBox::StandardButton defaultButton = QMessageBox::Yes, QMessageBox::Icon severity = QMessageBox::Warning )

private

Definition at line 288 of file gamutmask_dock.cpp.

{
    QMessageBox msgBox;
    msgBox.setWindowTitle(i18nc("@title:window", "Krita"));
    msgBox.setText(QString("<p><b>%1</b></p>").arg(text));
    msgBox.setInformativeText(informativeText);
    msgBox.setStandardButtons(buttons);
    msgBox.setDefaultButton(defaultButton);
    msgBox.setIcon(severity);
    int res = msgBox.exec();
 
    return res;
}

References buttons().

observerName()

QString GamutMaskDock::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 37 of file gamutmask_dock.h.

{ return "GamutMaskDock"; }

openMaskEditor()

bool GamutMaskDock::openMaskEditor ( )

private

Definition at line 118 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask) {
        return false;
    }
 
    // find the template resource first, so we can abort the action early on
    QString maskTemplateFile = ":/gamutmasks/GamutMaskTemplate.kra";
    if (maskTemplateFile.isEmpty() || maskTemplateFile.isNull() || !QFile::exists(maskTemplateFile)) {
        dbgPlugins << "GamutMaskDock::openMaskEditor(): maskTemplateFile (" << maskTemplateFile << ") was not found on the system";
        getUserFeedback(i18n("Could not open gamut mask for editing."),
                        i18n("The editor template was not found."),
                        QMessageBox::Ok, QMessageBox::Ok, QMessageBox::Critical);
        return false;
    }
 
    m_dockerUI->maskChooser->setEnabled(false);
    m_dockerUI->maskPropertiesBox->setVisible(true);
    m_dockerUI->maskPropertiesBox->setEnabled(true);
    m_dockerUI->editControlsBox->setEnabled(false);
    m_dockerUI->editControlsBox->setVisible(false);
 
    m_dockerUI->maskTitleEdit->setText(m_selectedMask->title());
    m_dockerUI->maskDescriptionEdit->setPlainText(m_selectedMask->description());
 
    m_maskDocument = KisPart::instance()->createDocument();
    KisPart::instance()->addDocument(m_maskDocument);
    m_maskDocument->openPath(maskTemplateFile, KisDocument::DontAddToRecent);
 
    // template document needs a proper autogenerated filename,
    // to avoid collision with other documents,
    // otherwise bugs happen when slotDocumentRemoved is called
    // (e.g. user closes another view, the template stays open, but the edit operation is canceled)
    m_maskDocument->setInfiniteAutoSaveInterval();
    QString maskPath =
        QString("%1%2%3_%4.kra")
            .arg(QDir::tempPath(), "/", "GamutMaskTemplate", QString::number(std::time(nullptr)));
    m_maskDocument->setPath(maskPath);
    m_maskDocument->setLocalFilePath(maskPath);
 
    KisShapeLayerSP shapeLayer = getShapeLayer();
 
    // pass only copies of shapes to the layer,
    // so the originals don't disappear from the mask later
    for (KoShape *shape: m_selectedMask->koShapes()) {
        KoShape* newShape = shape->cloneShape();
        newShape->setStroke(KoShapeStrokeModelSP());
        newShape->setBackground(QSharedPointer<KoColorBackground>(new KoColorBackground(QColor(255,255,255))));
        shapeLayer->addShape(newShape);
    }
 
    m_maskDocument->setPreActivatedNode(shapeLayer);
 
    // set document as active
    KisMainWindow* mainWindow = KisPart::instance()->currentMainwindow();
    KIS_ASSERT(mainWindow);
 
    m_view = mainWindow->addViewAndNotifyLoadingCompleted(m_maskDocument);
    KIS_ASSERT(m_view);
 
    for(KisView *view: KisPart::instance()->views()) {
        if (view->document() == m_maskDocument) {
            view->activateWindow();
            break;
        }
    }
 
    connect(m_view->viewManager(), SIGNAL(viewChanged()), this, SLOT(slotViewChanged()));
    connect(m_maskDocument, SIGNAL(completed()), this, SLOT(slotDocumentSaved()));
 
    m_dockerUI->maskChooser->setEnabled(true);
 
    return true;
}

References KisPart::addDocument(), KoShapeContainer::addShape(), KisMainWindow::addViewAndNotifyLoadingCompleted(), KoShape::cloneShape(), connect(), KisPart::createDocument(), KisPart::currentMainwindow(), dbgPlugins, KisDocument::DontAddToRecent, getShapeLayer(), getUserFeedback(), KisPart::instance(), KIS_ASSERT, m_dockerUI, m_maskDocument, m_selectedMask, m_view, KisDocument::openPath(), KoShape::setBackground(), KisDocument::setInfiniteAutoSaveInterval(), KisDocument::setLocalFilePath(), KisDocument::setPath(), KisDocument::setPreActivatedNode(), KoShape::setStroke(), slotDocumentSaved(), slotViewChanged(), KisView::viewManager, and KisPart::views.

removingResource()

void GamutMaskDock::removingResource ( KoGamutMaskSP resource )

overridevirtual

Will be called by the resource server before a resource will be removed

Parameters

resource

the resource which is going to be removed

Implements KoResourceServerObserver< KoGamutMask >.

Definition at line 513 of file gamutmask_dock.cpp.

{
    // if deleting previously set mask, notify selectors to unset their mask
    if (resource == m_resourceProvider->currentGamutMask()) {
        Q_EMIT sigGamutMaskUnset();
        m_selectedMask = nullptr;
    }
}

References KisCanvasResourceProvider::currentGamutMask(), m_resourceProvider, m_selectedMask, and sigGamutMaskUnset().

resolveMaskTitle()

QPair< QString, QFileInfo > GamutMaskDock::resolveMaskTitle ( QString suggestedTitle )

private

resourceAdded()

void GamutMaskDock::resourceAdded ( KoGamutMaskSP resource )

inlineoverridevirtual

Will be called by the resource server after a resource is added

Parameters

resource

the added resource

Implements KoResourceServerObserver< KoGamutMask >.

Definition at line 44 of file gamutmask_dock.h.

{}

resourceChanged()

void GamutMaskDock::resourceChanged ( KoGamutMaskSP resource )

overridevirtual

Will be called by the resource server when a resource is changed

Parameters

resource

the resource which is going to be removed

Implements KoResourceServerObserver< KoGamutMask >.

Definition at line 522 of file gamutmask_dock.cpp.

{
    // if currently set mask has been changed, notify selectors
    if (resource == m_resourceProvider->currentGamutMask()) {
        selectMask(resource);
    }
}

References KisCanvasResourceProvider::currentGamutMask(), m_resourceProvider, and selectMask().

saveOrCancel()

int GamutMaskDock::saveOrCancel ( QMessageBox::StandardButton defaultAction = QMessageBox::Save )

private

Definition at line 304 of file gamutmask_dock.cpp.

{
    int response = 0;
 
    if (m_maskDocument->isModified()) {
        response = getUserFeedback(i18n("Gamut mask <b>'%1'</b> has been modified.", m_selectedMask->title()),
                                   i18n("Do you want to save it?"),
                                   QMessageBox::Cancel | QMessageBox::Close | QMessageBox::Save, defaultAction);
 
    } else if (m_templatePrevSaved && defaultAction != QMessageBox::Close) {
        response = QMessageBox::Save;
 
    } else if (!m_templatePrevSaved) {
        response = QMessageBox::Close;
 
    } else {
        response = defaultAction;
    }
 
    switch (response) {
        case QMessageBox::Save : {
            slotGamutMaskSave();
            break;
    }
        case QMessageBox::Close : {
            cancelMaskEdit();
            break;
        }
    }
 
    return response;
}

References cancelMaskEdit(), getUserFeedback(), KisDocument::isModified(), m_maskDocument, m_selectedMask, m_templatePrevSaved, and slotGamutMaskSave().

saveSelectedMaskResource()

bool GamutMaskDock::saveSelectedMaskResource ( )

private

Definition at line 227 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask || !m_maskDocument) {
        return false;
    }
 
    bool maskSaved = false;
 
    if (m_selectedMask) {
        QList<KoShape*> shapes = getShapesFromLayer();
 
        if (shapes.count() > 0) {
            m_selectedMask->setMaskShapes(shapes);
 
            m_selectedMask->setImage(
                        m_maskDocument->image()->convertToQImage(m_maskDocument->image()->bounds()
                                                                 , m_maskDocument->image()->profile()
                                                                 )
                        );
 
            m_selectedMask->setDescription(m_dockerUI->maskDescriptionEdit->toPlainText());
 
            m_selectedMask->clearPreview();
            KisResourceModel model(ResourceType::GamutMasks);
            QModelIndex idx = model.indexForResourceId(m_selectedMask->resourceId());
            bool r = true;
            if (idx.isValid()) {
                // don't add, only update
                r = KisResourceUserOperations::updateResourceWithUserInput(this, m_selectedMask);
            } else {
                r = KisResourceUserOperations::addResourceWithUserInput(this, m_selectedMask);
            }
 
            maskSaved = r;
        } else {
            getUserFeedback(i18n("Saving of gamut mask '%1' was aborted.", m_selectedMask->title()),
                            i18n("<p>The mask template is invalid.</p>"
                                 "<p>Please check that:"
                                 "<ul>"
                                 "<li>your template contains a vector layer named 'maskShapesLayer'</li>"
                                 "<li>there are one or more vector shapes on the 'maskShapesLayer'</li>"
                                 "</ul></p>"
                                 ),
                            QMessageBox::Ok, QMessageBox::Ok);
        }
    }
 
 
    return maskSaved;
}

References KisResourceUserOperations::addResourceWithUserInput(), KisImage::bounds(), KisImage::convertToQImage(), ResourceType::GamutMasks, getShapesFromLayer(), getUserFeedback(), KisDocument::image, KisResourceModel::indexForResourceId(), m_dockerUI, m_maskDocument, m_selectedMask, KisImage::profile(), and KisResourceUserOperations::updateResourceWithUserInput().

selectMask()

void GamutMaskDock::selectMask ( KoGamutMaskSP mask, bool notifyItemChooser = true )

private

Definition at line 210 of file gamutmask_dock.cpp.

{
    if (!mask) {
        return;
    }
 
    m_selectedMask = mask;
 
    if (notifyItemChooser) {
        m_selfSelectingMask = true;
        m_dockerUI->maskChooser->setCurrentResource(m_selectedMask);
        m_selfSelectingMask = false;
    }
 
    Q_EMIT sigGamutMaskSet(m_selectedMask);
}

References m_dockerUI, m_selectedMask, m_selfSelectingMask, and sigGamutMaskSet().

setCanvas()

void GamutMaskDock::setCanvas ( KoCanvasBase * canvas )

overridevirtual

re-implement this method in your canvas observer. It will be called whenever a canvas becomes active. Note that you are responsible for not connecting more than one time to the signals of a canvas or any of the QObjects you can access through the canvas.

Implements KoCanvasObserverBase.

Definition at line 496 of file gamutmask_dock.cpp.

{
    setEnabled(canvas != 0);
}

setViewManager()

void GamutMaskDock::setViewManager ( KisViewManager * kisview )

overridevirtual

Implements KisMainwindowObserver.

Definition at line 97 of file gamutmask_dock.cpp.

{
    m_resourceProvider = kisview->canvasResourceProvider();
 
    selectMask(m_resourceProvider->currentGamutMask());
 
    connect(this, SIGNAL(sigGamutMaskSet(KoGamutMaskSP)), m_resourceProvider, SLOT(slotGamutMaskActivated(KoGamutMaskSP)), Qt::UniqueConnection);
    connect(this, SIGNAL(sigGamutMaskChanged(KoGamutMaskSP)), m_resourceProvider, SLOT(slotGamutMaskActivated(KoGamutMaskSP)), Qt::UniqueConnection);
    connect(this, SIGNAL(sigGamutMaskUnset()), m_resourceProvider, SLOT(slotGamutMaskUnset()), Qt::UniqueConnection);
    connect(this, SIGNAL(sigGamutMaskPreviewUpdate()), m_resourceProvider, SLOT(slotGamutMaskPreviewUpdate()), Qt::UniqueConnection);
    connect(KisPart::instance(), SIGNAL(sigDocumentRemoved(QString)), this, SLOT(slotDocumentRemoved(QString)), Qt::UniqueConnection);
}

References KisViewManager::canvasResourceProvider(), connect(), KisCanvasResourceProvider::currentGamutMask(), KisPart::instance(), m_resourceProvider, selectMask(), sigGamutMaskChanged(), sigGamutMaskPreviewUpdate(), sigGamutMaskSet(), sigGamutMaskUnset(), and slotDocumentRemoved().

sigGamutMaskChanged

void GamutMaskDock::sigGamutMaskChanged ( KoGamutMaskSP mask )

signal

sigGamutMaskPreviewUpdate

void GamutMaskDock::sigGamutMaskPreviewUpdate ( )

signal

sigGamutMaskSet

void GamutMaskDock::sigGamutMaskSet ( KoGamutMaskSP mask )

signal

sigGamutMaskUnset

void GamutMaskDock::sigGamutMaskUnset ( )

signal

slotDocumentRemoved

void GamutMaskDock::slotDocumentRemoved ( QString filename )

privateslot

Definition at line 570 of file gamutmask_dock.cpp.

{
    if (!m_maskDocument) {
        return;
    }
 
    m_externalTemplateClose = true;
 
    // we do not want to run this if it is we who close the file
    if (!m_selfClosingTemplate) {
        // KisPart called, that a document will be removed
        // if it's ours, cancel the mask edit operation
        if (m_maskDocument->path() == filename) {
            m_maskDocument->waitForSavingToComplete();
            saveOrCancel();
        }
    }
 
    m_externalTemplateClose = false;
}

References m_externalTemplateClose, m_maskDocument, m_selfClosingTemplate, KisDocument::path(), saveOrCancel(), and KisDocument::waitForSavingToComplete().

slotDocumentSaved

void GamutMaskDock::slotDocumentSaved ( )

privateslot

Definition at line 604 of file gamutmask_dock.cpp.

{
    m_templatePrevSaved = true;
}

References m_templatePrevSaved.

slotGamutMaskCancelEdit

void GamutMaskDock::slotGamutMaskCancelEdit ( )

privateslot

Definition at line 463 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask) {
        return;
    }
 
    saveOrCancel(QMessageBox::Close);
}

References m_selectedMask, and saveOrCancel().

slotGamutMaskCreateNew

void GamutMaskDock::slotGamutMaskCreateNew ( )

privateslot

Definition at line 530 of file gamutmask_dock.cpp.

{
    KoGamutMaskSP newMask = createMaskResource(nullptr, "new mask");
    selectMask(newMask);
 
    bool editorOpened = openMaskEditor();
    if (!editorOpened) {
        deleteMask();
    }
}

References createMaskResource(), deleteMask(), openMaskEditor(), and selectMask().

slotGamutMaskDelete

void GamutMaskDock::slotGamutMaskDelete ( )

privateslot

Definition at line 556 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask) {
        return;
    }
 
    int res = getUserFeedback(i18n("Are you sure you want to delete mask <b>'%1'</b>?"
                                   , m_selectedMask->title()));
 
    if (res == QMessageBox::Yes) {
        deleteMask();
    }
}

References deleteMask(), getUserFeedback(), and m_selectedMask.

slotGamutMaskDuplicate

void GamutMaskDock::slotGamutMaskDuplicate ( )

privateslot

Definition at line 541 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask) {
        return;
    }
 
    KoGamutMaskSP newMask = createMaskResource(m_selectedMask, m_selectedMask->title() + QString(" (Copy)"));
    selectMask(newMask);
 
    bool editorOpened = openMaskEditor();
    if (!editorOpened) {
        deleteMask();
    }
}

References createMaskResource(), deleteMask(), m_selectedMask, openMaskEditor(), and selectMask().

slotGamutMaskEdit

void GamutMaskDock::slotGamutMaskEdit ( )

privateslot

Definition at line 110 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask) {
        return;
    }
    openMaskEditor();
}

References m_selectedMask, and openMaskEditor().

slotGamutMaskPreview

void GamutMaskDock::slotGamutMaskPreview ( )

privateslot

Definition at line 472 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask) {
        return;
    }
 
    m_selectedMask->setPreviewMaskShapes(getShapesFromLayer());
    Q_EMIT sigGamutMaskPreviewUpdate();
}

References getShapesFromLayer(), m_selectedMask, and sigGamutMaskPreviewUpdate().

slotGamutMaskSave

void GamutMaskDock::slotGamutMaskSave ( )

privateslot

Definition at line 439 of file gamutmask_dock.cpp.

{
    if (!m_selectedMask || !m_maskDocument) {
        return;
    }
 
    QString newTitle = m_dockerUI->maskTitleEdit->text();
 
    if (m_selectedMask->title() != newTitle) {
        // title has changed, rename
        KoGamutMaskSP newMask = createMaskResource(m_selectedMask, newTitle);
 
        // delete old mask and select new
        deleteMask();
        selectMask(newMask);
    }
 
    bool maskSaved = saveSelectedMaskResource();
    if (maskSaved) {
        Q_EMIT sigGamutMaskSet(m_selectedMask);
        closeMaskDocument();
    }
}

References closeMaskDocument(), createMaskResource(), deleteMask(), m_dockerUI, m_maskDocument, m_selectedMask, saveSelectedMaskResource(), selectMask(), and sigGamutMaskSet().

slotGamutMaskSelected

void GamutMaskDock::slotGamutMaskSelected ( KoGamutMaskSP mask )

privateslot

Definition at line 482 of file gamutmask_dock.cpp.

{
    if (!m_selfSelectingMask) {
        if (m_maskDocument) {
            int res = saveOrCancel();
            if (res == QMessageBox::Cancel) {
                return;
            }
        }
 
        selectMask(mask, false);
    }
}

References m_maskDocument, m_selfSelectingMask, saveOrCancel(), and selectMask().

slotViewChanged

void GamutMaskDock::slotViewChanged ( )

privateslot

Definition at line 591 of file gamutmask_dock.cpp.

{
    if (!m_maskDocument || !m_view) {
        return;
    }
 
    if (m_view->viewManager()->document() == m_maskDocument) {
        m_dockerUI->maskPropertiesBox->setEnabled(true);
    } else {
        m_dockerUI->maskPropertiesBox->setEnabled(false);
    }
}

References KisViewManager::document(), m_dockerUI, m_maskDocument, m_view, and KisView::viewManager.

unsetCanvas()

void GamutMaskDock::unsetCanvas ( )

overridevirtual

Re-implement to notify the observer that its canvas is no longer among the living. The daisies, it is pushing up. This means you don't have to disconnect, it's dead.

The old canvas should be deleted already, so if you stored a pointer to it, don't touch!

Note that currently there is a bug where in certain specific circumstances unsetCanvas can be called when it shouldn't, see for example KWStatisticsDocker for a workaround for this problem.

Implements KoCanvasObserverBase.

Definition at line 501 of file gamutmask_dock.cpp.

{
    setEnabled(false);
}

unsetResourceServer()

void GamutMaskDock::unsetResourceServer ( )

overridevirtual

Implements KoResourceServerObserver< KoGamutMask >.

Definition at line 507 of file gamutmask_dock.cpp.

{
    KoResourceServer<KoGamutMask>* rServer = KoResourceServerProvider::instance()->gamutMaskServer();
    rServer->removeObserver(this);
}

References KoResourceServerProvider::gamutMaskServer, KoResourceServerProvider::instance(), and KoResourceServer< T >::removeObserver().

Member Data Documentation

m_creatingNewMask

bool GamutMaskDock::m_creatingNewMask {false}

private

Definition at line 93 of file gamutmask_dock.h.

{false};

m_dockerUI

GamutMaskChooserUI* GamutMaskDock::m_dockerUI {nullptr}

private

Definition at line 97 of file gamutmask_dock.h.

{nullptr};

m_externalTemplateClose

bool GamutMaskDock::m_externalTemplateClose {false}

private

Definition at line 92 of file gamutmask_dock.h.

{false};

m_maskChooser

KisResourceItemChooser* GamutMaskDock::m_maskChooser {nullptr}

private

Definition at line 98 of file gamutmask_dock.h.

{nullptr};

m_maskDocument

KisDocument* GamutMaskDock::m_maskDocument {nullptr}

private

Definition at line 102 of file gamutmask_dock.h.

{nullptr};

m_resourceProvider

KisCanvasResourceProvider* GamutMaskDock::m_resourceProvider {nullptr}

private

Definition at line 89 of file gamutmask_dock.h.

{nullptr};

m_selectedMask

KoGamutMaskSP GamutMaskDock::m_selectedMask

private

Definition at line 100 of file gamutmask_dock.h.

m_selfClosingTemplate

bool GamutMaskDock::m_selfClosingTemplate {false}

private

Definition at line 91 of file gamutmask_dock.h.

{false};

m_selfSelectingMask

bool GamutMaskDock::m_selfSelectingMask {false}

private

Definition at line 95 of file gamutmask_dock.h.

{false};

m_templatePrevSaved

bool GamutMaskDock::m_templatePrevSaved {false}

private

Definition at line 94 of file gamutmask_dock.h.

{false};

m_view

KisView* GamutMaskDock::m_view {nullptr}

private

Definition at line 103 of file gamutmask_dock.h.

{nullptr};

---

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

• plugins/dockers/gamutmask/gamutmask_dock.h
• plugins/dockers/gamutmask/gamutmask_dock.cpp