KoDockFactoryBase Class Reference

#include <KoDockFactoryBase.h>

Inheritance diagram for KoDockFactoryBase:

Public Types
enum	DockPosition {   DockTornOff , DockTop , DockBottom , DockRight ,   DockLeft , DockMinimized }

Public Member Functions
virtual QDockWidget *	createDockWidget ()=0
virtual DockPosition	defaultDockPosition () const =0
virtual QString	id () const =0
	KoDockFactoryBase ()
virtual	~KoDockFactoryBase ()

Detailed Description

Base class for factories used to create new dock widgets.

See also

KoDockRegistry

KoCanvasObserverBase

Definition at line 21 of file KoDockFactoryBase.h.

Member Enumeration Documentation

DockPosition

enum KoDockFactoryBase::DockPosition

Enumerator
DockTornOff	Floating as its own top level window.
DockTop	Above the central widget.
DockBottom	Below the central widget.
DockRight	Right of the centra widget.
DockLeft	Left of the centra widget.
DockMinimized	Not docked, but reachable via the menu.

Definition at line 24 of file KoDockFactoryBase.h.

                      {
        DockTornOff, 
        DockTop,    
        DockBottom, 
        DockRight,  
        DockLeft,   
        DockMinimized  
    };

Constructor & Destructor Documentation

KoDockFactoryBase()

KoDockFactoryBase::KoDockFactoryBase

(

)

Definition at line 9 of file KoDockFactoryBase.cpp.

{
}

~KoDockFactoryBase()

KoDockFactoryBase::~KoDockFactoryBase ( )

virtual

Definition at line 13 of file KoDockFactoryBase.cpp.

{
}

Member Function Documentation

createDockWidget()

virtual QDockWidget * KoDockFactoryBase::createDockWidget ( )

pure virtual

Creates the dock widget

Returns

the created dock widget

Implemented in ToolDockerFactory, KoToolBoxFactory, ColorSelectorNgDockFactory, TimelineDockerFactory, OnionSkinsDockerFactory, AnimationCurvesDockerFactory, ArrangeDockerDockFactory, ArtisticColorSelectorDockFactory, BrushHudDockerDockFactory, ChannelDockerDockFactory, CompositionDockerDockFactory, DigitalMixerDockFactory, GamutMaskDockFactory, GridDockerDockFactory, HistogramDockerDockFactory, HistoryDockFactory, LayerBoxFactory, LutDockerDockFactory, OverviewDockerDockFactory, PaletteDockerDockFactory, PatternDockerDockFactory, PresetDockerDockFactory, PresetHistoryDockFactory, SmallColorSelectorDockFactory, SnapshotDockFactory, SpecificColorSelectorDockFactory, StoryboardDockerDockFactory, SvgSymbolCollectionDockerFactory, TextPropertiesDockFactory, TouchDockerDockFactory, and WGColorSelectorDockFactory.

defaultDockPosition()

virtual DockPosition KoDockFactoryBase::defaultDockPosition ( ) const

pure virtual

Returns

the dock widget area the widget should appear in by default

Implemented in DockWidgetFactoryBase, ToolDockerFactory, KoToolBoxFactory, ColorSelectorNgDockFactory, TimelineDockerFactory, OnionSkinsDockerFactory, AnimationCurvesDockerFactory, ArrangeDockerDockFactory, ArtisticColorSelectorDockFactory, BrushHudDockerDockFactory, ChannelDockerDockFactory, CompositionDockerDockFactory, DigitalMixerDockFactory, GamutMaskDockFactory, GridDockerDockFactory, HistogramDockerDockFactory, HistoryDockFactory, LayerBoxFactory, LutDockerDockFactory, OverviewDockerDockFactory, PaletteDockerDockFactory, PatternDockerDockFactory, PresetDockerDockFactory, PresetHistoryDockFactory, SmallColorSelectorDockFactory, SnapshotDockFactory, SpecificColorSelectorDockFactory, StoryboardDockerDockFactory, SvgSymbolCollectionDockerFactory, TextPropertiesDockFactory, TouchDockerDockFactory, and WGColorSelectorDockFactory.

id()

virtual QString KoDockFactoryBase::id ( ) const

pure virtual

Returns

the id of the dock widget

Implemented in DockWidgetFactoryBase, ToolDockerFactory, KoToolBoxFactory, ColorSelectorNgDockFactory, TimelineDockerFactory, OnionSkinsDockerFactory, AnimationCurvesDockerFactory, ArrangeDockerDockFactory, ArtisticColorSelectorDockFactory, BrushHudDockerDockFactory, ChannelDockerDockFactory, CompositionDockerDockFactory, DigitalMixerDockFactory, GamutMaskDockFactory, GridDockerDockFactory, HistogramDockerDockFactory, HistoryDockFactory, LayerBoxFactory, LutDockerDockFactory, OverviewDockerDockFactory, PaletteDockerDockFactory, PatternDockerDockFactory, PresetDockerDockFactory, PresetHistoryDockFactory, SmallColorSelectorDockFactory, SnapshotDockFactory, SpecificColorSelectorDockFactory, StoryboardDockerDockFactory, SvgSymbolCollectionDockerFactory, TextPropertiesDockFactory, TouchDockerDockFactory, and WGColorSelectorDockFactory.

---

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

• libs/flake/KoDockFactoryBase.h
• libs/flake/KoDockFactoryBase.cpp