#include <kis_config_widget.h>

Inheritance diagram for KisConfigWidget:

Signals
void	sigConfigurationItemChanged ()

void	sigConfigurationUpdated ()

void	sigDropLockedConfig (KisPropertiesConfigurationSP p)

void	sigSaveLockedConfig (KisPropertiesConfigurationSP p)

Public Member Functions
virtual KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const

virtual KisPropertiesConfigurationSP	configuration () const =0

virtual void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

virtual void	setConfiguration (const KisPropertiesConfigurationSP config)=0

virtual void	setView (KisViewManager *view)

	~KisConfigWidget () override

Protected Member Functions
	KisConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags(), int delay=200)

Private Slots
void	slotConfigChanged ()

Private Attributes
KoCanvasResourcesInterfaceSP	m_canvasResourcesInterface

KisSignalCompressor	m_compressor

Detailed Description

Empty base class. Configurable resources like filters, paintops etc. can build their own configuration widgets that inherit this class. The configuration widget should Q_EMIT sigConfigurationItemChanged when it wants a preview updated; there is a timer that waits a little time to see if there are more changes coming and then emits sigConfigurationUpdated.

Definition at line 30 of file kis_config_widget.h.

Constructor & Destructor Documentation

◆ KisConfigWidget()

KisConfigWidget::KisConfigWidget	(	QWidget *	parent = 0,
		Qt::WindowFlags	f = Qt::WindowFlags(),
		int	delay = 200 )

protected

Definition at line 10 of file kis_config_widget.cpp.

        : QWidget(parent, f)
        , m_compressor(delay, KisSignalCompressor::FIRST_ACTIVE)
{
    connect(this, SIGNAL(sigConfigurationItemChanged()), SLOT(slotConfigChanged()));
    connect(&m_compressor, SIGNAL(timeout()), SIGNAL(sigConfigurationUpdated()));
}

References connect(), m_compressor, sigConfigurationItemChanged(), sigConfigurationUpdated(), and slotConfigChanged().

◆ ~KisConfigWidget()

KisConfigWidget::~KisConfigWidget ( )

override

Definition at line 18 of file kis_config_widget.cpp.

19{

20}

Member Function Documentation

◆ canvasResourcesInterface()

KoCanvasResourcesInterfaceSP KisConfigWidget::canvasResourcesInterface ( ) const

virtual

Definition at line 44 of file kis_config_widget.cpp.

{
    return m_canvasResourcesInterface;
}

References m_canvasResourcesInterface.

◆ configuration()

virtual KisPropertiesConfigurationSP KisConfigWidget::configuration ( ) const

pure virtual

Returns: the configuration

◆ setCanvasResourcesInterface()

void KisConfigWidget::setCanvasResourcesInterface ( KoCanvasResourcesInterfaceSP canvasResourcesInterface )

virtual

Reimplemented in KisPaintOpSettingsWidget, KisGradientMapFilterConfigWidget, KisHalftoneConfigWidget, and KisGradientGeneratorConfigWidget.

Definition at line 39 of file kis_config_widget.cpp.

{
    m_canvasResourcesInterface = canvasResourcesInterface;
}

References canvasResourcesInterface(), and m_canvasResourcesInterface.

◆ setConfiguration()

virtual void KisConfigWidget::setConfiguration ( const KisPropertiesConfigurationSP config )

pure virtual

Parameters

config the configuration for this configuration widget.

Implemented in KisMultiBoolFilterWidget, KisMultiDoubleFilterWidget, KisWdgOptionsBrush, KisWdgOptionsExr, KisWdgOptionsHeif, KisWdgOptionsHeightmap, KisWdgOptionsJPEG, KisWdgOptionsJPEGXL, KisWdgOptionsQImageIO, KisWdgOptionsRGBE, KisTIFFOptionsWidget, KisWdgOptionsWebP, KisVideoExportOptionsDialog, KisPaintOpSettingsWidget, KisMultiIntegerFilterWidget, KisASCCDLConfigWidget, KisColorBalanceConfigWidget, KisCrossChannelConfigWidget, KisDesaturateConfigWidget, KisHSVConfigWidget, KisMultiChannelConfigWidget, KisWdgConvertHeightToNormalMap, KisDodgeBurnConfigWidget, KisWdgEdgeDetection, KisGradientMapFilterConfigWidget, KisHalftoneConfigWidget, KisWdgIndexColors, KisLevelsConfigWidget, KisPhongBumpmapConfigWidget, KisPropagateColorsConfigWidget, KisThresholdConfigWidget, KisWdgOptionsPNG, KisPaintOpConfigWidget, KisWdgBlur, KisWdgGaussianBlur, KisWdgLensBlur, KisWdgMotionBlur, KisWdgColorToAlpha, KisWdgFilterFastColorOverlay, KisWdgFastColorTransfer, KisWdgGaussianHighPass, KisWdgNoise, KisPalettizeWidget, KisWdgRandomPick, KisWdgUnsharp, KisWdgWave, KisGradientGeneratorConfigWidget, KisWdgMultigridPattern, KisWdgPattern, KisScreentoneConfigWidget, KisWdgSeExpr, KisWdgSimplexNoise, and KisWdgColor.

◆ setView()

void KisConfigWidget::setView ( KisViewManager * view )

virtual

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 in KisPaintOpConfigWidget, KisWdgColorToAlpha, KisWdgFilterFastColorOverlay, KisGradientMapFilterConfigWidget, KisHalftoneConfigWidget, KisGradientGeneratorConfigWidget, KisScreentoneConfigWidget, and KisWdgOptionsBrush.

Definition at line 32 of file kis_config_widget.cpp.

{
    if (!view) {
        warnKrita << "KisConfigWidget::setView has got view == 0. That's a bug! Please report it!";
    }
}

References warnKrita.

◆ sigConfigurationItemChanged

void KisConfigWidget::sigConfigurationItemChanged ( )

signal

Subclasses should Q_EMIT this signal whenever the preview should be be recalculated. This kicks of a timer, so it's perfectly fine to connect this to the changed signals of the widgets in your configuration widget.

◆ sigConfigurationUpdated

void KisConfigWidget::sigConfigurationUpdated ( )

signal

emitted whenever it makes sense to update the preview

◆ sigDropLockedConfig

void KisConfigWidget::sigDropLockedConfig ( KisPropertiesConfigurationSP p )

signal

◆ sigSaveLockedConfig

void KisConfigWidget::sigSaveLockedConfig ( KisPropertiesConfigurationSP p )

signal

◆ slotConfigChanged

void KisConfigWidget::slotConfigChanged ( )

privateslot

Definition at line 22 of file kis_config_widget.cpp.

{
    if (!signalsBlocked()) {
        m_compressor.start();
    }
}

References m_compressor, and KisSignalCompressor::start().

Member Data Documentation

◆ m_canvasResourcesInterface

KoCanvasResourcesInterfaceSP KisConfigWidget::m_canvasResourcesInterface

private

Definition at line 84 of file kis_config_widget.h.

◆ m_compressor

KisSignalCompressor KisConfigWidget::m_compressor

private

Definition at line 83 of file kis_config_widget.h.

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

libs/image/kis_config_widget.h
libs/image/kis_config_widget.cpp

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisConfigWidget()

◆ ~KisConfigWidget()

Member Function Documentation

◆ canvasResourcesInterface()

◆ configuration()

◆ setCanvasResourcesInterface()

◆ setConfiguration()

◆ setView()

◆ sigConfigurationItemChanged

◆ sigConfigurationUpdated

◆ sigDropLockedConfig

◆ sigSaveLockedConfig

◆ slotConfigChanged

Member Data Documentation

◆ m_canvasResourcesInterface

◆ m_compressor