KisPaintOpConfigWidget Class Reference

#include <kis_paintop_config_widget.h>

Inheritance diagram for KisPaintOpConfigWidget:

Public Member Functions
virtual lager::reader< qreal >	effectiveBrushSize () const =0
	KisPaintOpConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())
virtual KisPaintopLodLimitations	lodLimitations () const =0
virtual lager::reader< KisPaintopLodLimitations >	lodLimitationsReader () const =0
KisResourcesInterfaceSP	resourcesInterface () const
void	setConfigurationSafe (const KisPropertiesConfigurationSP config)
virtual void	setImage (KisImageWSP image)
virtual void	setNode (KisNodeWSP node)
virtual void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)
void	setView (KisViewManager *view) override
virtual bool	supportScratchBox ()
void	writeConfigurationSafe (KisPropertiesConfigurationSP config) const
	~KisPaintOpConfigWidget () override
Public Member Functions inherited from KisConfigWidget
virtual KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const
virtual KisPropertiesConfigurationSP	configuration () const =0
virtual void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)
	~KisConfigWidget () override

Protected Member Functions
void	setConfiguration (const KisPropertiesConfigurationSP config) override=0
virtual void	writeConfiguration (KisPropertiesConfigurationSP config) const =0
Protected Member Functions inherited from KisConfigWidget
	KisConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags(), int delay=200)

Protected Attributes
KisImageWSP	m_image
int	m_isInsideUpdateCall
KisNodeWSP	m_node
KisResourcesInterfaceSP	m_resourcesInterface

Friends
class	CompositeOpModel

Additional Inherited Members
Signals inherited from KisConfigWidget
void	sigConfigurationItemChanged ()
void	sigConfigurationUpdated ()
void	sigDropLockedConfig (KisPropertiesConfigurationSP p)
void	sigSaveLockedConfig (KisPropertiesConfigurationSP p)

Detailed Description

Base class for widgets that are used to edit and display paintop settings.

Definition at line 26 of file kis_paintop_config_widget.h.

Constructor & Destructor Documentation

KisPaintOpConfigWidget()

KisPaintOpConfigWidget::KisPaintOpConfigWidget	(	QWidget *	parent = 0,
		Qt::WindowFlags	f = Qt::WindowFlags() )

Definition at line 16 of file kis_paintop_config_widget.cpp.

    : KisConfigWidget(parent, f, 100),
      m_isInsideUpdateCall(0)
{
}

~KisPaintOpConfigWidget()

KisPaintOpConfigWidget::~KisPaintOpConfigWidget ( )

override

Definition at line 22 of file kis_paintop_config_widget.cpp.

                                                {
}

Member Function Documentation

effectiveBrushSize()

virtual lager::reader< qreal > KisPaintOpConfigWidget::effectiveBrushSize ( ) const

pure virtual

Implemented in KisPaintOpSettingsWidget, KisBrushBasedPaintopOptionWidget, and KisMyPaintOpSettingsWidget.

lodLimitations()

virtual KisPaintopLodLimitations KisPaintOpConfigWidget::lodLimitations ( ) const

pure virtual

Implemented in KisPaintOpSettingsWidget, and KisDuplicateOpSettingsWidget.

lodLimitationsReader()

virtual lager::reader< KisPaintopLodLimitations > KisPaintOpConfigWidget::lodLimitationsReader ( ) const

pure virtual

Implemented in KisPaintOpSettingsWidget.

resourcesInterface()

KisResourcesInterfaceSP KisPaintOpConfigWidget::resourcesInterface

(

)

const

Definition at line 57 of file kis_paintop_config_widget.cpp.

{
    return m_resourcesInterface;
}

References m_resourcesInterface.

setConfiguration()

void KisPaintOpConfigWidget::setConfiguration ( const KisPropertiesConfigurationSP config )

overrideprotectedpure virtual

Parameters

config

the configuration for this configuration widget.

Implements KisConfigWidget.

Implemented in KisPaintOpSettingsWidget.

setConfigurationSafe()

void KisPaintOpConfigWidget::setConfigurationSafe

(

const KisPropertiesConfigurationSP

config

)

Definition at line 35 of file kis_paintop_config_widget.cpp.

{
    if (m_isInsideUpdateCall) return;
 
    m_isInsideUpdateCall++;
    setConfiguration(config);
    m_isInsideUpdateCall--;
}

References m_isInsideUpdateCall, and setConfiguration().

setImage()

void KisPaintOpConfigWidget::setImage ( KisImageWSP image )

virtual

Reimplemented in KisPaintOpSettingsWidget.

Definition at line 44 of file kis_paintop_config_widget.cpp.

                                                       {
    m_image = image;
}

References m_image.

setNode()

void KisPaintOpConfigWidget::setNode ( KisNodeWSP node )

virtual

Reimplemented in KisPaintOpSettingsWidget.

Definition at line 48 of file kis_paintop_config_widget.cpp.

                                                    {
    m_node = node;
}

References m_node.

setResourcesInterface()

void KisPaintOpConfigWidget::setResourcesInterface ( KisResourcesInterfaceSP resourcesInterface )

virtual

Reimplemented in KisPaintOpSettingsWidget.

Definition at line 52 of file kis_paintop_config_widget.cpp.

{
    m_resourcesInterface = resourcesInterface;
}

References m_resourcesInterface, and resourcesInterface().

setView()

void KisPaintOpConfigWidget::setView ( KisViewManager * view )

overridevirtual

Sets the view object that can be used by the configuration widget for richer functionality

TODO: remove this method from KisConfigWidget, since KisViewManager is from kritaui, but we are in kritaimage

Reimplemented from KisConfigWidget.

Definition at line 62 of file kis_paintop_config_widget.cpp.

{
    Q_UNUSED(view);
    KIS_SAFE_ASSERT_RECOVER_NOOP(0 && "setView() is not expected to be used in PaintOp widgets, please use setCanvasResourcesInterface() instead!");
}

References KIS_SAFE_ASSERT_RECOVER_NOOP.

supportScratchBox()

bool KisPaintOpConfigWidget::supportScratchBox ( )

virtual

Some paintops are more complicated and require full canvas with layers, projections and KisImage etc. Example is duplicate paintop. In this case simple canvas like scratchbox does not work. Every paintop supports the scratchbox by default, override and return false if paintop does not.

Reimplemented in KisDuplicateOpSettingsWidget.

Definition at line 68 of file kis_paintop_config_widget.cpp.

                                               {
    return true;
}

writeConfiguration()

virtual void KisPaintOpConfigWidget::writeConfiguration ( KisPropertiesConfigurationSP config ) const

protectedpure virtual

Implemented in KisPaintOpSettingsWidget.

writeConfigurationSafe()

void KisPaintOpConfigWidget::writeConfigurationSafe

(

KisPropertiesConfigurationSP

config

)

const

Definition at line 26 of file kis_paintop_config_widget.cpp.

{
    if (m_isInsideUpdateCall) return;
 
    m_isInsideUpdateCall++;
    writeConfiguration(config);
    m_isInsideUpdateCall--;
}

References m_isInsideUpdateCall, and writeConfiguration().

Friends And Related Symbol Documentation

CompositeOpModel

friend class CompositeOpModel

friend

Definition at line 39 of file kis_paintop_config_widget.h.

Member Data Documentation

m_image

KisImageWSP KisPaintOpConfigWidget::m_image

protected

Definition at line 67 of file kis_paintop_config_widget.h.

m_isInsideUpdateCall

int KisPaintOpConfigWidget::m_isInsideUpdateCall

mutableprotected

Definition at line 72 of file kis_paintop_config_widget.h.

m_node

KisNodeWSP KisPaintOpConfigWidget::m_node

protected

Definition at line 68 of file kis_paintop_config_widget.h.

m_resourcesInterface

KisResourcesInterfaceSP KisPaintOpConfigWidget::m_resourcesInterface

protected

Definition at line 70 of file kis_paintop_config_widget.h.

---

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

• libs/image/brushengine/kis_paintop_config_widget.h
• libs/image/brushengine/kis_paintop_config_widget.cpp