libs/flake

KoDockFactory Class Reference

Base class for factories used to create new dock widgets. More...

#include <KoDockFactory.h>

List of all members.

Public Types

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

Public Member Functions

 KoDockFactory ()
virtual ~KoDockFactory ()
virtual QDockWidget * createDockWidget ()=0
virtual bool defaultCollapsed () const
virtual DockPosition defaultDockPosition () const =0
virtual QString id () const =0
virtual bool isCollapsable () const

Detailed Description

Base class for factories used to create new dock widgets.

See also:
KoDockRegistry
KoCanvasObserver

Definition at line 34 of file KoDockFactory.h.

Member Enumeration Documentation

enum KoDockFactory::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 37 of file KoDockFactory.h.

Constructor & Destructor Documentation

KoDockFactory::KoDockFactory (  )  [inline]

Definition at line 46 of file KoDockFactory.h.

virtual KoDockFactory::~KoDockFactory (  )  [inline, virtual]

Definition at line 47 of file KoDockFactory.h.

Member Function Documentation

virtual QDockWidget* KoDockFactory::createDockWidget (  )  [pure virtual]

Creates the dock widget.

Returns:
the created dock widget
virtual bool KoDockFactory::defaultCollapsed (  )  const [inline, virtual]

In case the docker is collapsable, returns true if the dock widget will start collapsed by default.

Definition at line 64 of file KoDockFactory.h.

virtual DockPosition KoDockFactory::defaultDockPosition (  )  const [pure virtual]
Returns:
the dock widget area the widget should appear in by default
virtual QString KoDockFactory::id (  )  const [pure virtual]
Returns:
the id of the dock widget
virtual bool KoDockFactory::isCollapsable (  )  const [inline, virtual]

Returns true if the dock widget should get a collapsable header.

Definition at line 56 of file KoDockFactory.h.

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