The DockWidgetFactoryBase class is the base class for plugins that want to add a dock widget to every window. You do not need to implement this class yourself, but create a DockWidget implementation and then add the DockWidgetFactory to the Krita instance like this: More...

#include <DockWidgetFactoryBase.h>

Inheritance diagram for DockWidgetFactoryBase:

Public Member Functions
DockPosition	defaultDockPosition () const override

	DockWidgetFactoryBase (const QString &_id, DockPosition _dockPosition)

QString	id () const override

	~DockWidgetFactoryBase () override

Public Member Functions inherited from KoDockFactoryBase
virtual QDockWidget *	createDockWidget ()=0

	KoDockFactoryBase ()

virtual	~KoDockFactoryBase ()

Private Attributes
DockPosition	m_dockPosition

QString	m_id

Additional Inherited Members
Public Types inherited from KoDockFactoryBase
enum	DockPosition { DockTornOff , DockTop , DockBottom , DockRight , DockLeft , DockMinimized }

Detailed Description

The DockWidgetFactoryBase class is the base class for plugins that want to add a dock widget to every window. You do not need to implement this class yourself, but create a DockWidget implementation and then add the DockWidgetFactory to the Krita instance like this:

class HelloDocker(DockWidget):
  def __init__(self):
      super().__init__()
      label = QLabel("Hello", self)
      self.setWidget(label)
      self.label = label
 
def canvasChanged(self, canvas):
      self.label.setText("Hellodocker: canvas changed");
 
Application.addDockWidgetFactory(DockWidgetFactory("hello", DockWidgetFactoryBase.DockRight, HelloDocker))

Definition at line 36 of file DockWidgetFactoryBase.h.

Constructor & Destructor Documentation

◆ DockWidgetFactoryBase()

DockWidgetFactoryBase::DockWidgetFactoryBase	(	const QString &	_id,
		KoDockFactoryBase::DockPosition	_dockPosition )

Definition at line 10 of file DockWidgetFactoryBase.cpp.

    : m_id(_id),
    m_dockPosition(_dockPosition)
{
 
}

◆ ~DockWidgetFactoryBase()

DockWidgetFactoryBase::~DockWidgetFactoryBase ( )

override

Definition at line 17 of file DockWidgetFactoryBase.cpp.

18{

19}

Member Function Documentation

◆ defaultDockPosition()

KoDockFactoryBase::DockPosition DockWidgetFactoryBase::defaultDockPosition ( ) const

overridevirtual

Returns: the dock widget area the widget should appear in by default

Implements KoDockFactoryBase.

Definition at line 21 of file DockWidgetFactoryBase.cpp.

{
    return m_dockPosition;
}

References m_dockPosition.

◆ id()

QString DockWidgetFactoryBase::id ( ) const

overridevirtual

Returns: the id of the dock widget

Implements KoDockFactoryBase.

Definition at line 26 of file DockWidgetFactoryBase.cpp.

{
    return m_id;
}

References m_id.

Member Data Documentation

◆ m_dockPosition

DockPosition DockWidgetFactoryBase::m_dockPosition

private

Definition at line 45 of file DockWidgetFactoryBase.h.

◆ m_id

QString DockWidgetFactoryBase::m_id

private

Definition at line 44 of file DockWidgetFactoryBase.h.

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

libs/libkis/DockWidgetFactoryBase.h
libs/libkis/DockWidgetFactoryBase.cpp

Public Member Functions

Private Attributes

Additional Inherited Members