#include <kis_paintop_option.h>

Inheritance diagram for KisPaintOpOption:

Classes
struct	Private

Public Types
using	OptionalLodLimitationsReader = std::optional<lager::reader<KisPaintopLodLimitations>>

enum	PaintopCategory { GENERAL , COLOR , TEXTURE , FILTER , MASKING_BRUSH }

Signals
void	sigCheckedChanged (bool value)

void	sigEnabledChanged (bool value)

void	sigSettingChanged ()

Public Member Functions
KisPaintOpOption::PaintopCategory	category () const

QWidget *	configurationPage () const

OptionalLodLimitationsReader	effectiveLodLimitations () const

virtual bool	isCheckable () const

virtual bool	isChecked () const

bool	isEnabled () const

bool	isLocked () const

	KisPaintOpOption (const QString &label, KisPaintOpOption::PaintopCategory category, bool checked)

	KisPaintOpOption (const QString &label, KisPaintOpOption::PaintopCategory category, lager::cursor< bool > checkedCursor)

	KisPaintOpOption (const QString &label, KisPaintOpOption::PaintopCategory category, lager::cursor< bool > checkedCursor, lager::reader< bool > externallyEnabledLink)

QString	label () const

virtual void	lodLimitations (KisPaintopLodLimitations *l) const

virtual void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

virtual void	setChecked (bool checked)

virtual void	setImage (KisImageWSP image)

void	setLocked (bool value)

virtual void	setNode (KisNodeWSP node)

virtual void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)

void	startReadOptionSetting (const KisPropertiesConfigurationSP setting)

void	startWriteOptionSetting (KisPropertiesConfigurationSP setting) const

	~KisPaintOpOption () override

Protected Slots
void	emitCheckedChanged (bool checked)

void	emitEnabledChanged (bool enabled)

void	emitSettingChanged ()

Protected Member Functions
KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const

virtual OptionalLodLimitationsReader	lodLimitationsReader () const

virtual void	readOptionSetting (const KisPropertiesConfigurationSP setting)

KisResourcesInterfaceSP	resourcesInterface () const

void	setConfigurationPage (QWidget *page)

virtual void	writeOptionSetting (KisPropertiesConfigurationSP setting) const

Protected Attributes
bool	m_checkable {false}

bool	m_locked {false}

Private Member Functions
void	slotEnablePageWidget (bool value)

Private Attributes
Private *const	m_d

Detailed Description

Base interface for paintop options. A paintop option can be enabled/disabled, has a configuration page (for example, a curve), a user-visible name and can be serialized and deserialized into KisPaintOpPresets

Because KisPaintOpOption classes create a QWidget in their constructor (the configuration page) you CANNOT create those objects in a KisPaintOp. KisPaintOps are created in non-gui threads.

Options are disabled by default.

Definition at line 37 of file kis_paintop_option.h.

Member Typedef Documentation

◆ OptionalLodLimitationsReader

using KisPaintOpOption::OptionalLodLimitationsReader = std::optional<lager::reader<KisPaintopLodLimitations>>

Definition at line 42 of file kis_paintop_option.h.

Member Enumeration Documentation

◆ PaintopCategory

enum KisPaintOpOption::PaintopCategory

Enumerator
GENERAL
COLOR
TEXTURE
FILTER
MASKING_BRUSH

Definition at line 44 of file kis_paintop_option.h.

                         {
        GENERAL,
        COLOR,
        TEXTURE,
        FILTER,
        MASKING_BRUSH
    };

Constructor & Destructor Documentation

◆ KisPaintOpOption() [1/3]

KisPaintOpOption::KisPaintOpOption	(	const QString &	label,
		KisPaintOpOption::PaintopCategory	category,
		bool	checked )

Definition at line 42 of file kis_paintop_option.cpp.

    : m_checkable(true)
    , m_d(new Private())
 
{
    m_d->label = label;
    m_d->checkedFallback.set(checked);
    m_d->checkedCursor = m_d->checkedFallback;
    m_d->externallyEnabledReader = lager::make_constant(true);
    m_d->pageEnabledReader = m_d->checkedCursor;
    m_d->category = category;
    m_d->pageEnabledReader.bind(std::bind(&KisPaintOpOption::slotEnablePageWidget, this, std::placeholders::_1));
    m_d->checkedCursor.bind(std::bind(&KisPaintOpOption::sigCheckedChanged, this, std::placeholders::_1));
    m_d->externallyEnabledReader.bind(std::bind(&KisPaintOpOption::sigEnabledChanged, this, std::placeholders::_1));
 
}

References KisPaintOpOption::Private::category, category(), KisPaintOpOption::Private::checkedCursor, KisPaintOpOption::Private::checkedFallback, KisPaintOpOption::Private::externallyEnabledReader, KisPaintOpOption::Private::label, label(), m_d, KisPaintOpOption::Private::pageEnabledReader, sigCheckedChanged(), sigEnabledChanged(), and slotEnablePageWidget().

◆ KisPaintOpOption() [2/3]

KisPaintOpOption::KisPaintOpOption	(	const QString &	label,
		KisPaintOpOption::PaintopCategory	category,
		lager::cursor< bool >	checkedCursor )

Definition at line 59 of file kis_paintop_option.cpp.

    : KisPaintOpOption(label, category, checkedCursor, lager::make_constant(true))
{
 
}

◆ KisPaintOpOption() [3/3]

KisPaintOpOption::KisPaintOpOption	(	const QString &	label,
		KisPaintOpOption::PaintopCategory	category,
		lager::cursor< bool >	checkedCursor,
		lager::reader< bool >	externallyEnabledLink )

Definition at line 66 of file kis_paintop_option.cpp.

    : m_checkable(true)
    , m_d(new Private())
{
    m_d->label = label;
    m_d->checkedCursor = checkedCursor;
    m_d->externallyEnabledReader = externallyEnabledLink;
    m_d->pageEnabledReader = lager::with(m_d->checkedCursor, m_d->externallyEnabledReader).map(std::logical_and{});
    m_d->category = category;
    m_d->pageEnabledReader.bind(std::bind(&KisPaintOpOption::slotEnablePageWidget, this, std::placeholders::_1));
    m_d->checkedCursor.bind(std::bind(&KisPaintOpOption::sigCheckedChanged, this, std::placeholders::_1));
    m_d->externallyEnabledReader.bind(std::bind(&KisPaintOpOption::sigEnabledChanged, this, std::placeholders::_1));
}

References KisPaintOpOption::Private::category, category(), KisPaintOpOption::Private::checkedCursor, KisPaintOpOption::Private::externallyEnabledReader, KisPaintOpOption::Private::label, label(), m_d, KisPaintOpOption::Private::pageEnabledReader, sigCheckedChanged(), sigEnabledChanged(), and slotEnablePageWidget().

◆ ~KisPaintOpOption()

KisPaintOpOption::~KisPaintOpOption ( )

override

Definition at line 82 of file kis_paintop_option.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

◆ canvasResourcesInterface()

KoCanvasResourcesInterfaceSP KisPaintOpOption::canvasResourcesInterface ( ) const

protected

Definition at line 204 of file kis_paintop_option.cpp.

{
    return m_d->canvasResourcesInterface;
}

References KisPaintOpOption::Private::canvasResourcesInterface, and m_d.

◆ category()

KisPaintOpOption::PaintopCategory KisPaintOpOption::category ( ) const

Definition at line 153 of file kis_paintop_option.cpp.

{
    return m_d->category;
}

References KisPaintOpOption::Private::category, and m_d.

◆ configurationPage()

QWidget * KisPaintOpOption::configurationPage ( ) const

Definition at line 222 of file kis_paintop_option.cpp.

{
    return m_d->configurationPage;
}

References KisPaintOpOption::Private::configurationPage, and m_d.

◆ effectiveLodLimitations()

KisPaintOpOption::OptionalLodLimitationsReader KisPaintOpOption::effectiveLodLimitations ( ) const

Definition at line 133 of file kis_paintop_option.cpp.

{
    OptionalLodLimitationsReader reader = lodLimitationsReader();
 
    if (reader) {
        reader = lager::with(m_d->pageEnabledReader, *reader)
            .map([](bool enabled, const KisPaintopLodLimitations &l) {
                return enabled ? l : KisPaintopLodLimitations();
            });
    }
 
    return reader;
}

References lodLimitationsReader(), m_d, and KisPaintOpOption::Private::pageEnabledReader.

◆ emitCheckedChanged

void KisPaintOpOption::emitCheckedChanged ( bool checked )

protectedslot

Definition at line 96 of file kis_paintop_option.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(!m_d->isWritingSettings);
 
    if (!m_d->updatesBlocked) {
        Q_EMIT sigCheckedChanged(checked);
    }
}

References KisPaintOpOption::Private::isWritingSettings, KIS_ASSERT_RECOVER_RETURN, m_d, sigCheckedChanged(), and KisPaintOpOption::Private::updatesBlocked.

◆ emitEnabledChanged

void KisPaintOpOption::emitEnabledChanged ( bool enabled )

protectedslot

Definition at line 105 of file kis_paintop_option.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(!m_d->isWritingSettings);
 
    if (!m_d->updatesBlocked) {
        Q_EMIT sigEnabledChanged(enabled);
    }
}

References KisPaintOpOption::Private::isWritingSettings, KIS_ASSERT_RECOVER_RETURN, m_d, sigEnabledChanged(), and KisPaintOpOption::Private::updatesBlocked.

◆ emitSettingChanged

void KisPaintOpOption::emitSettingChanged ( )

protectedslot

Definition at line 87 of file kis_paintop_option.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(!m_d->isWritingSettings);
 
    if (!m_d->updatesBlocked) {
        Q_EMIT sigSettingChanged();
    }
}

References KisPaintOpOption::Private::isWritingSettings, KIS_ASSERT_RECOVER_RETURN, m_d, sigSettingChanged(), and KisPaintOpOption::Private::updatesBlocked.

◆ isCheckable()

bool KisPaintOpOption::isCheckable ( ) const

virtual

Reimplemented in KisCurveOptionWidget.

Definition at line 163 of file kis_paintop_option.cpp.

                                         {
    return m_checkable;
}

References m_checkable.

◆ isChecked()

bool KisPaintOpOption::isChecked ( ) const

virtual

Definition at line 158 of file kis_paintop_option.cpp.

{
    return m_d->checkedCursor.get();
}

References KisPaintOpOption::Private::checkedCursor, and m_d.

◆ isEnabled()

bool KisPaintOpOption::isEnabled ( ) const

Definition at line 174 of file kis_paintop_option.cpp.

{
    return m_d->externallyEnabledReader.get();
}

References KisPaintOpOption::Private::externallyEnabledReader, and m_d.

◆ isLocked()

bool KisPaintOpOption::isLocked ( ) const

Definition at line 239 of file kis_paintop_option.cpp.

{
    return m_locked;
}

References m_locked.

◆ label()

QString KisPaintOpOption::label ( ) const

Definition at line 244 of file kis_paintop_option.cpp.

{
    return m_d->label;
}

References KisPaintOpOption::Private::label, and m_d.

◆ lodLimitations()

void KisPaintOpOption::lodLimitations ( KisPaintopLodLimitations * l ) const

virtual

Reimplemented in KisMaskingBrushOption.

Definition at line 128 of file kis_paintop_option.cpp.

{
    Q_UNUSED(l);
}

◆ lodLimitationsReader()

KisPaintOpOption::OptionalLodLimitationsReader KisPaintOpOption::lodLimitationsReader ( ) const

protectedvirtual

Reimplemented in KisSmudgeOverlayModeOptionWidget, KisBrushOptionWidget, KisSizeOptionWidget, KisTextureOptionWidget, and MyPaintCurveOptionWidget.

Definition at line 147 of file kis_paintop_option.cpp.

{
    // no limitations by default
    return std::nullopt;
}

◆ readOptionSetting()

virtual void KisPaintOpOption::readOptionSetting ( const KisPropertiesConfigurationSP setting )

inlineprotectedvirtual

Re-implement this to set the widgets with the values in setting.

Reimplemented in KisPaintThicknessOptionWidget, KisSmudgeLengthOptionWidget, KisSmudgeOverlayModeOptionWidget, KisCurveOpOptionWidget, KisDuplicateOptionWidget, KisBrushSizeOptionWidget, KisDeformOptionWidget, KisExperimentOpOptionWidget, KisGridOpOptionWidget, KisGridShapeOptionWidget, KisHairyBristleOptionWidget, KisHairyInkOptionWidget, KisHatchingOptionsWidget, KisHatchingPreferencesWidget, KisBrushOptionWidget, KisAirbrushOptionWidget, KisColorOptionWidget, KisColorSourceOptionWidget, KisCompositeOpOptionWidget, KisCurveOptionWidget, KisFilterOptionWidget, KisMaskingBrushOption, KisMirrorOptionWidget, KisPaintingModeOptionWidget, KisScatterOptionWidget, KisSharpnessOptionWidget, KisSpacingOptionWidget, KisTextureOptionWidget, MyPaintBasicOptionWidget, KisParticleOpOptionWidget, KisRoundMarkerOpOptionWidget, KisSketchOpOptionWidget, KisSprayOpOptionWidget, KisSprayShapeDynamicsOptionWidget, KisSprayShapeOptionWidget, and KisTangentTiltOptionWidget.

Definition at line 107 of file kis_paintop_option.h.

                                                                               {
        Q_UNUSED(setting);
    }

◆ resourcesInterface()

KisResourcesInterfaceSP KisPaintOpOption::resourcesInterface ( ) const

protected

Definition at line 199 of file kis_paintop_option.cpp.

{
    return m_d->resourcesInterface;
}

References m_d, and KisPaintOpOption::Private::resourcesInterface.

◆ setCanvasResourcesInterface()

void KisPaintOpOption::setCanvasResourcesInterface ( KoCanvasResourcesInterfaceSP canvasResourcesInterface )

virtual

Definition at line 194 of file kis_paintop_option.cpp.

{
    m_d->canvasResourcesInterface = canvasResourcesInterface;
}

References KisPaintOpOption::Private::canvasResourcesInterface, canvasResourcesInterface(), and m_d.

◆ setChecked()

void KisPaintOpOption::setChecked ( bool checked )

virtual

Definition at line 167 of file kis_paintop_option.cpp.

{
    m_d->checkedCursor.set(checked);
 
    emitSettingChanged();
}

References KisPaintOpOption::Private::checkedCursor, emitSettingChanged(), and m_d.

◆ setConfigurationPage()

void KisPaintOpOption::setConfigurationPage ( QWidget * page )

protected

Definition at line 209 of file kis_paintop_option.cpp.

{
    if (m_d->configurationPage && !m_d->checkedCursor.get()) {
        m_d->configurationPage->setEnabled(true);
    }
 
    m_d->configurationPage = page;
 
    if (m_d->configurationPage) {
        m_d->configurationPage->setEnabled(m_d->checkedCursor.get());
    }
}

References KisPaintOpOption::Private::checkedCursor, KisPaintOpOption::Private::configurationPage, and m_d.

◆ setImage()

void KisPaintOpOption::setImage ( KisImageWSP image )

virtual

Reimplement this to use the image in the option widget

Reimplemented in KisBrushOptionWidget, KisFilterOptionWidget, and KisMaskingBrushOption.

Definition at line 179 of file kis_paintop_option.cpp.

{
    Q_UNUSED(image);
}

◆ setLocked()

void KisPaintOpOption::setLocked ( bool value )

Definition at line 234 of file kis_paintop_option.cpp.

{
    m_locked = value;
}

References m_locked, and value().

◆ setNode()

void KisPaintOpOption::setNode ( KisNodeWSP node )

virtual

Reimplemented in KisFilterOptionWidget.

Definition at line 184 of file kis_paintop_option.cpp.

{
    Q_UNUSED(node);
}

◆ setResourcesInterface()

void KisPaintOpOption::setResourcesInterface ( KisResourcesInterfaceSP resourcesInterface )

virtual

Definition at line 189 of file kis_paintop_option.cpp.

{
    m_d->resourcesInterface = resourcesInterface;
}

References m_d, KisPaintOpOption::Private::resourcesInterface, and resourcesInterface().

◆ sigCheckedChanged

void KisPaintOpOption::sigCheckedChanged ( bool value )

signal

Q_EMIT this whenever a checked state of the option has changed. It as always emitted before sigSettingChanged()

◆ sigEnabledChanged

void KisPaintOpOption::sigEnabledChanged ( bool value )

signal

◆ sigSettingChanged

void KisPaintOpOption::sigSettingChanged ( )

signal

Q_EMIT this whenever a setting has changed. It will update the preview

◆ slotEnablePageWidget()

void KisPaintOpOption::slotEnablePageWidget ( bool value )

private

Definition at line 227 of file kis_paintop_option.cpp.

{
    if (m_d->configurationPage) {
        m_d->configurationPage->setEnabled(value);
    }
}

References KisPaintOpOption::Private::configurationPage, m_d, and value().

◆ startReadOptionSetting()

void KisPaintOpOption::startReadOptionSetting ( const KisPropertiesConfigurationSP setting )

Definition at line 114 of file kis_paintop_option.cpp.

{
    m_d->updatesBlocked = true;
    readOptionSetting(setting);
    m_d->updatesBlocked = false;
}

References m_d, readOptionSetting(), and KisPaintOpOption::Private::updatesBlocked.

◆ startWriteOptionSetting()

void KisPaintOpOption::startWriteOptionSetting ( KisPropertiesConfigurationSP setting ) const

Definition at line 121 of file kis_paintop_option.cpp.

{
    m_d->isWritingSettings = true;
    writeOptionSetting(setting);
    m_d->isWritingSettings = false;
}

References KisPaintOpOption::Private::isWritingSettings, m_d, and writeOptionSetting().

◆ writeOptionSetting()

virtual void KisPaintOpOption::writeOptionSetting ( KisPropertiesConfigurationSP setting ) const

inlineprotectedvirtual

Re-implement this to save the configuration to the paint configuration.

Reimplemented in KisPaintThicknessOptionWidget, KisSmudgeLengthOptionWidget, KisSmudgeOverlayModeOptionWidget, KisCurveOpOptionWidget, KisDuplicateOptionWidget, KisBrushSizeOptionWidget, KisDeformOptionWidget, KisExperimentOpOptionWidget, KisGridOpOptionWidget, KisGridShapeOptionWidget, KisHairyBristleOptionWidget, KisHairyInkOptionWidget, KisHatchingOptionsWidget, KisHatchingPreferencesWidget, KisBrushOptionWidget, KisAirbrushOptionWidget, KisColorOptionWidget, KisColorSourceOptionWidget, KisCompositeOpOptionWidget, KisCurveOptionWidget, KisFilterOptionWidget, KisMaskingBrushOption, KisMirrorOptionWidget, KisPaintingModeOptionWidget, KisScatterOptionWidget, KisSharpnessOptionWidget, KisSpacingOptionWidget, KisTextureOptionWidget, MyPaintBasicOptionWidget, KisParticleOpOptionWidget, KisRoundMarkerOpOptionWidget, KisSketchOpOptionWidget, KisSprayOpOptionWidget, KisSprayShapeDynamicsOptionWidget, KisSprayShapeOptionWidget, and KisTangentTiltOptionWidget.

Definition at line 100 of file kis_paintop_option.h.

                                                                                {
        Q_UNUSED(setting);
    }

Member Data Documentation

◆ m_checkable

bool KisPaintOpOption::m_checkable {false}

protected

Definition at line 135 of file kis_paintop_option.h.

135{false};

◆ m_d

Private* const KisPaintOpOption::m_d

private

Definition at line 141 of file kis_paintop_option.h.

◆ m_locked

bool KisPaintOpOption::m_locked {false}

protected

Definition at line 136 of file kis_paintop_option.h.

136{false};

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

libs/ui/kis_paintop_option.h
libs/ui/kis_paintop_option.cpp

Classes

Public Types

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ OptionalLodLimitationsReader

Member Enumeration Documentation

◆ PaintopCategory

Constructor & Destructor Documentation

◆ KisPaintOpOption() [1/3]

◆ KisPaintOpOption() [2/3]

◆ KisPaintOpOption() [3/3]

◆ ~KisPaintOpOption()

Member Function Documentation

◆ canvasResourcesInterface()

◆ category()

◆ configurationPage()

◆ effectiveLodLimitations()

◆ emitCheckedChanged

◆ emitEnabledChanged

◆ emitSettingChanged

◆ isCheckable()

◆ isChecked()

◆ isEnabled()

◆ isLocked()

◆ label()

◆ lodLimitations()

◆ lodLimitationsReader()

◆ readOptionSetting()

◆ resourcesInterface()

◆ setCanvasResourcesInterface()

◆ setChecked()

◆ setConfigurationPage()

◆ setImage()

◆ setLocked()

◆ setNode()

◆ setResourcesInterface()

◆ sigCheckedChanged

◆ sigEnabledChanged

◆ sigSettingChanged

◆ slotEnablePageWidget()

◆ startReadOptionSetting()

◆ startWriteOptionSetting()

◆ writeOptionSetting()

Member Data Documentation

◆ m_checkable

◆ m_d

◆ m_locked