SnapshotDocker Class Reference

#include <SnapshotDocker.h>

Inheritance diagram for SnapshotDocker:

Classes
struct	Private

Public Member Functions
QString	observerName () override
void	setCanvas (KoCanvasBase *canvas) override
void	setViewManager (KisViewManager *viewManager) override
	SnapshotDocker ()
void	unsetCanvas () override
	~SnapshotDocker () 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 ()

Private Slots
void	slotBnAddClicked ()
void	slotBnRemoveClicked ()
void	slotBnSwitchToClicked ()

Private Attributes
QScopedPointer< Private >	m_d

Additional Inherited Members

Detailed Description

Definition at line 18 of file SnapshotDocker.h.

Constructor & Destructor Documentation

SnapshotDocker()

SnapshotDocker::SnapshotDocker

(

)

Definition at line 52 of file SnapshotDocker.cpp.

    : QDockWidget()
    , m_d(new Private)
{
    QWidget *widget = new QWidget(this);
    QVBoxLayout *mainLayout = new QVBoxLayout(widget);
    m_d->view->setModel(m_d->model.data());
    mainLayout->addWidget(m_d->view);
    QHBoxLayout *buttonsLayout = new QHBoxLayout();
    m_d->bnAdd->setIcon(KisIconUtils::loadIcon("list-add"));
    m_d->bnAdd->setToolTip(i18nc("@info:tooltip", "Create snapshot"));
    m_d->bnAdd->setAutoRaise(true);
 
    connect(m_d->bnAdd, &QToolButton::clicked, this, &SnapshotDocker::slotBnAddClicked);
    buttonsLayout->addWidget(m_d->bnAdd);
    m_d->bnSwitchTo->setIcon(KisIconUtils::loadIcon("snapshot-load"));
    m_d->bnSwitchTo->setToolTip(i18nc("@info:tooltip", "Switch to selected snapshot"));
    m_d->bnSwitchTo->setAutoRaise(true);
    connect(m_d->bnSwitchTo, &QToolButton::clicked, this, &SnapshotDocker::slotBnSwitchToClicked);
 
    buttonsLayout->addWidget(m_d->bnSwitchTo);
    m_d->bnRemove->setIcon(KisIconUtils::loadIcon("edit-delete"));
    m_d->bnRemove->setToolTip(i18nc("@info:tooltip", "Remove selected snapshot"));
    m_d->bnRemove->setAutoRaise(true);
    connect(m_d->bnRemove, &QToolButton::clicked, this, &SnapshotDocker::slotBnRemoveClicked);
    buttonsLayout->addWidget(m_d->bnRemove);
    mainLayout->addLayout(buttonsLayout);
 
    setWidget(widget);
    setWindowTitle(i18n("Snapshot Docker"));
    setEnabled(false);
}

References connect(), KisIconUtils::loadIcon(), m_d, slotBnAddClicked(), slotBnRemoveClicked(), and slotBnSwitchToClicked().

~SnapshotDocker()

SnapshotDocker::~SnapshotDocker ( )

override

Definition at line 85 of file SnapshotDocker.cpp.

{
}

Member Function Documentation

observerName()

QString SnapshotDocker::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 25 of file SnapshotDocker.h.

{ return "SnapshotDocker"; }

setCanvas()

void SnapshotDocker::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 103 of file SnapshotDocker.cpp.

{
    KisCanvas2 *c = dynamic_cast<KisCanvas2 *>(canvas);
    if (c) {
        if (m_d->canvas == c) {
            return;
        }
    }
    setEnabled(canvas != 0);
    m_d->canvas = c;
    m_d->model->setCanvas(c);
}

References m_d.

setViewManager()

void SnapshotDocker::setViewManager ( KisViewManager * viewManager )

overridevirtual

Implements KisMainwindowObserver.

Definition at line 89 of file SnapshotDocker.cpp.

{
    m_d->connections.clear();
    KisAction *action = viewManager->actionManager()->createAction("create_snapshot");
    m_d->connections.addConnection(action, &KisAction::triggered,
                                   m_d->model.data(), &KisSnapshotModel::slotCreateSnapshot);
    action = viewManager->actionManager()->createAction("switchto_snapshot");
    m_d->connections.addConnection(action, &KisAction::triggered,
                                   m_d->view, &KisSnapshotView::slotSwitchToSelectedSnapshot);
    action = viewManager->actionManager()->createAction("remove_snapshot");
    m_d->connections.addConnection(action, &KisAction::triggered,
                                   m_d->view, &KisSnapshotView::slotRemoveSelectedSnapshot);
}

References KisViewManager::actionManager(), KisActionManager::createAction(), m_d, KisSnapshotModel::slotCreateSnapshot(), KisSnapshotView::slotRemoveSelectedSnapshot(), and KisSnapshotView::slotSwitchToSelectedSnapshot().

slotBnAddClicked

void SnapshotDocker::slotBnAddClicked ( )

privateslot

Definition at line 121 of file SnapshotDocker.cpp.

{
    if (m_d->canvas) {
        KisAction *action = m_d->canvas->viewManager()->actionManager()->actionByName("create_snapshot");
        action->trigger();
    }
}

References KisActionManager::actionByName(), KisViewManager::actionManager(), Private::canvas, m_d, and KisCanvas2::viewManager().

slotBnRemoveClicked

void SnapshotDocker::slotBnRemoveClicked ( )

privateslot

Definition at line 137 of file SnapshotDocker.cpp.

{
    if (m_d->canvas) {
        KisAction *action = m_d->canvas->viewManager()->actionManager()->actionByName("remove_snapshot");
        action->trigger();
    }
}

References KisActionManager::actionByName(), KisViewManager::actionManager(), Private::canvas, m_d, and KisCanvas2::viewManager().

slotBnSwitchToClicked

void SnapshotDocker::slotBnSwitchToClicked ( )

privateslot

Definition at line 129 of file SnapshotDocker.cpp.

{
    if (m_d->canvas) {
        KisAction *action = m_d->canvas->viewManager()->actionManager()->actionByName("switchto_snapshot");
        action->trigger();
    }
}

References KisActionManager::actionByName(), KisViewManager::actionManager(), Private::canvas, m_d, and KisCanvas2::viewManager().

unsetCanvas()

void SnapshotDocker::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 116 of file SnapshotDocker.cpp.

{
    setCanvas(0);
}

References setCanvas().

Member Data Documentation

m_d

QScopedPointer<Private> SnapshotDocker::m_d

private

Definition at line 38 of file SnapshotDocker.h.

---

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

• plugins/dockers/snapshotdocker/SnapshotDocker.h
• plugins/dockers/snapshotdocker/SnapshotDocker.cpp