#include <KoCanvasObserverBase.h>

Inheritance diagram for KoCanvasObserverBase:

Public Member Functions
	KoCanvasObserverBase ()

KoCanvasBase *	observedCanvas () const

virtual QString	observerName ()

void	setObservedCanvas (KoCanvasBase *canvas)

void	unsetObservedCanvas ()

virtual	~KoCanvasObserverBase ()

Protected Member Functions
virtual void	setCanvas (KoCanvasBase *canvas)=0

virtual void	unsetCanvas ()=0

Private Attributes
KoCanvasObserverBasePrivate *const	d

Detailed Description

An abstract canvas observer interface class. Dockers that want to be notified of active canvas changes should implement that interface so that the tool controller can give them the active canvas.

Definition at line 23 of file KoCanvasObserverBase.h.

Constructor & Destructor Documentation

◆ KoCanvasObserverBase()

KoCanvasObserverBase::KoCanvasObserverBase ( )

Definition at line 24 of file KoCanvasObserverBase.cpp.

    : d(new KoCanvasObserverBasePrivate)
{
}

◆ ~KoCanvasObserverBase()

KoCanvasObserverBase::~KoCanvasObserverBase ( )

virtual

Definition at line 29 of file KoCanvasObserverBase.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ observedCanvas()

KoCanvasBase * KoCanvasObserverBase::observedCanvas ( ) const

the currently observed canvas

Returns: observed canvas, can be 0

Definition at line 46 of file KoCanvasObserverBase.cpp.

{
    return d->canvas;
}

References KoCanvasObserverBasePrivate::canvas, and d.

◆ observerName()

virtual QString KoCanvasObserverBase::observerName ( )

inlinevirtual

◆ setCanvas()

virtual void KoCanvasObserverBase::setCanvas ( KoCanvasBase * canvas )

protectedpure virtual

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.

Implemented in KisPlaybackEngineQT, KoToolBoxDocker, KoToolDocker, KisColorSelectorNgDock, KisAnimCurvesDocker, KisAnimTimelineDocker, KisOnionSkinsDocker, ArrangeDockerDock, ArtisticColorSelectorDock, BrushHudDock, ChannelDockerDock, CompositionDockerDock, DigitalMixerDock, GamutMaskDock, GridDockerDock, HistogramDockerDock, HistoryDock, LayerBox, LogDockerDock, LutDockerDock, OverviewDockerDock, PaletteDockerDock, PatternDockerDock, PresetDockerDock, PresetHistoryDock, RecorderDockerDock, SmallColorSelectorDock, SnapshotDocker, SpecificColorSelectorDock, StoryboardDockerDock, SvgSymbolCollectionDocker, TasksetDockerDock, TextPropertiesCanvasObserver, TextPropertiesDock, TouchDockerDock, and WGColorSelectorDock.

◆ setObservedCanvas()

void KoCanvasObserverBase::setObservedCanvas ( KoCanvasBase * canvas )

set observed canvas

Parameters

canvas canvas to observe. Can be 0.

Definition at line 34 of file KoCanvasObserverBase.cpp.

{
    d->canvas = canvas;
    setCanvas(canvas);
}

References KoCanvasObserverBasePrivate::canvas, d, and setCanvas().

◆ unsetCanvas()

virtual void KoCanvasObserverBase::unsetCanvas ( )

protectedpure virtual

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.

Implemented in KisPlaybackEngineQT, KoToolBoxDocker, KoToolDocker, KisColorSelectorNgDock, KisAnimCurvesDocker, KisAnimTimelineDocker, KisOnionSkinsDocker, ArrangeDockerDock, ArtisticColorSelectorDock, BrushHudDock, ChannelDockerDock, CompositionDockerDock, DigitalMixerDock, GamutMaskDock, GridDockerDock, HistogramDockerDock, HistoryDock, LayerBox, LogDockerDock, LutDockerDock, OverviewDockerDock, PaletteDockerDock, PatternDockerDock, PresetDockerDock, PresetHistoryDock, RecorderDockerDock, SmallColorSelectorDock, SnapshotDocker, SpecificColorSelectorDock, StoryboardDockerDock, SvgSymbolCollectionDocker, TasksetDockerDock, TextPropertiesCanvasObserver, TextPropertiesDock, TouchDockerDock, and WGColorSelectorDock.

◆ unsetObservedCanvas()

void KoCanvasObserverBase::unsetObservedCanvas ( )

notify the observer that canvas is gone

Definition at line 40 of file KoCanvasObserverBase.cpp.

{
    d->canvas = 0;
    unsetCanvas();
}

References KoCanvasObserverBasePrivate::canvas, d, and unsetCanvas().

Member Data Documentation

◆ d

KoCanvasObserverBasePrivate* const KoCanvasObserverBase::d

private

Definition at line 72 of file KoCanvasObserverBase.h.

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

libs/flake/KoCanvasObserverBase.h
libs/flake/KoCanvasObserverBase.cpp

Public Member Functions

Protected Member Functions

Private Attributes