GridDockerDock Class Reference

#include <griddocker_dock.h>

Inheritance diagram for GridDockerDock:

Public Slots
void	slotGridConfigUpdateRequested (const KisGridConfig &config)
void	slotGuidesConfigUpdateRequested (const KisGuidesConfig &config)
void	slotGuiGridConfigChanged ()
void	slotGuiGuidesConfigChanged ()

Public Member Functions
	GridDockerDock ()
QString	observerName () override
void	setCanvas (KoCanvasBase *canvas) override
void	unsetCanvas () override
	~GridDockerDock () override
Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()
KoCanvasBase *	observedCanvas () const
void	setObservedCanvas (KoCanvasBase *canvas)
void	unsetObservedCanvas ()
virtual	~KoCanvasObserverBase ()

Private Attributes
QPointer< KisCanvas2 >	m_canvas
KisSignalAutoConnectionsStore	m_canvasConnections
GridConfigWidget *	m_configWidget

Additional Inherited Members

Detailed Description

Definition at line 22 of file griddocker_dock.h.

Constructor & Destructor Documentation

GridDockerDock()

GridDockerDock::GridDockerDock

(

)

Definition at line 30 of file griddocker_dock.cpp.

    : QDockWidget(i18n("Grid and Guides"))
    , m_canvas(0)
{
    m_configWidget = new GridConfigWidget(this);
    connect(m_configWidget, SIGNAL(gridValueChanged()), SLOT(slotGuiGridConfigChanged()));
    connect(m_configWidget, SIGNAL(guidesValueChanged()), SLOT(slotGuiGuidesConfigChanged()));
    setWidget(m_configWidget);
    setEnabled(m_canvas);
}

References connect(), m_canvas, m_configWidget, slotGuiGridConfigChanged(), and slotGuiGuidesConfigChanged().

~GridDockerDock()

GridDockerDock::~GridDockerDock ( )

override

Definition at line 41 of file griddocker_dock.cpp.

{
}

Member Function Documentation

observerName()

QString GridDockerDock::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 27 of file griddocker_dock.h.

{ return "GridDockerDock"; }

setCanvas()

void GridDockerDock::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 45 of file griddocker_dock.cpp.

{
    if(canvas && m_canvas == canvas)
        return;
 
    if (m_canvas) {
        m_canvasConnections.clear();
        m_canvas->disconnectCanvasObserver(this);
        m_canvas->image()->disconnect(this);
    }
 
    m_canvas = canvas ? dynamic_cast<KisCanvas2*>(canvas) : 0;
    setEnabled(m_canvas);
 
    if (m_canvas && m_canvas->viewManager() && m_canvas->viewManager()->document()) {
        m_canvasConnections.addConnection(
            m_canvas->viewManager()->gridManager(),
            SIGNAL(sigRequestUpdateGridConfig(KisGridConfig)),
            this,
            SLOT(slotGridConfigUpdateRequested(KisGridConfig)));
 
        slotGridConfigUpdateRequested(m_canvas->viewManager()->document()->gridConfig());
 
        KisAction* action = m_canvas->viewManager()->actionManager()->actionByName("view_ruler");
 
        m_canvasConnections.addConnection(m_configWidget,SIGNAL(showRulersChanged(bool)),action,SLOT(setChecked(bool)));
        m_canvasConnections.addConnection(action,SIGNAL(toggled(bool)),m_configWidget,SLOT(setShowRulers(bool)));
        m_configWidget->setShowRulers(action->isChecked());
 
        m_canvasConnections.addConnection(
            m_canvas->viewManager()->guidesManager(),
            SIGNAL(sigRequestUpdateGuidesConfig(KisGuidesConfig)),
            this,
            SLOT(slotGuidesConfigUpdateRequested(KisGuidesConfig)));
        slotGuidesConfigUpdateRequested(m_canvas->viewManager()->document()->guidesConfig());
 
        // isometric (legacy) grid only available with OpenGL
        if (m_canvas->canvasIsOpenGL()) {
            m_configWidget->enableIsometricLegacyGrid(true);
        } else {
            m_configWidget->enableIsometricLegacyGrid(false);
        }
 
    }
}

References KisSignalAutoConnectionsStore::addConnection(), KisSignalAutoConnectionsStore::clear(), GridConfigWidget::enableIsometricLegacyGrid(), m_canvas, m_canvasConnections, m_configWidget, GridConfigWidget::setShowRulers(), slotGridConfigUpdateRequested(), and slotGuidesConfigUpdateRequested().

slotGridConfigUpdateRequested

void GridDockerDock::slotGridConfigUpdateRequested ( const KisGridConfig & config )

slot

Definition at line 102 of file griddocker_dock.cpp.

{
    m_configWidget->setGridConfig(config);
}

References m_configWidget, and GridConfigWidget::setGridConfig().

slotGuidesConfigUpdateRequested

void GridDockerDock::slotGuidesConfigUpdateRequested ( const KisGuidesConfig & config )

slot

Definition at line 113 of file griddocker_dock.cpp.

{
    m_configWidget->setGuidesConfig(config);
}

References m_configWidget, and GridConfigWidget::setGuidesConfig().

slotGuiGridConfigChanged

void GridDockerDock::slotGuiGridConfigChanged ( )

slot

Definition at line 96 of file griddocker_dock.cpp.

{
    if (!m_canvas) return;
    m_canvas->viewManager()->gridManager()->setGridConfig(m_configWidget->gridConfig());
}

References GridConfigWidget::gridConfig(), m_canvas, and m_configWidget.

slotGuiGuidesConfigChanged

void GridDockerDock::slotGuiGuidesConfigChanged ( )

slot

Definition at line 107 of file griddocker_dock.cpp.

{
    if (!m_canvas) return;
    m_canvas->viewManager()->guidesManager()->setGuidesConfig(m_configWidget->guidesConfig());
}

References GridConfigWidget::guidesConfig(), m_canvas, and m_configWidget.

unsetCanvas()

void GridDockerDock::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 91 of file griddocker_dock.cpp.

{
    setCanvas(0);
}

References setCanvas().

Member Data Documentation

m_canvas

QPointer<KisCanvas2> GridDockerDock::m_canvas

private

Definition at line 40 of file griddocker_dock.h.

m_canvasConnections

KisSignalAutoConnectionsStore GridDockerDock::m_canvasConnections

private

Definition at line 41 of file griddocker_dock.h.

m_configWidget

GridConfigWidget* GridDockerDock::m_configWidget

private

Definition at line 39 of file griddocker_dock.h.

---

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

• plugins/dockers/griddocker/griddocker_dock.h
• plugins/dockers/griddocker/griddocker_dock.cpp