KisPaintOpSettingsWidget Class Reference

#include <kis_paintop_settings_widget.h>

Inheritance diagram for KisPaintOpSettingsWidget:

Classes
struct	Private

Public Member Functions
void	addPaintOpOption (KisPaintOpOption *option)
void	addPaintOpOption (KisPaintOpOption *option, KisPaintOpOption::PaintopCategory category)
lager::reader< qreal >	effectiveBrushSize () const override
	KisPaintOpSettingsWidget (QWidget *parent=0)
KisPaintopLodLimitations	lodLimitations () const override
lager::reader< KisPaintopLodLimitations >	lodLimitationsReader () const override
void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface) override
void	setConfiguration (const KisPropertiesConfigurationSP config) override
	Reimplemented.
void	setImage (KisImageWSP image) override
	Reimplemented, sets image on option widgets.
void	setNode (KisNodeWSP node) override
	Reimplemented, sets node on option widgets.
void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface) override
void	writeConfiguration (KisPropertiesConfigurationSP config) const override
	Reimplemented.
	~KisPaintOpSettingsWidget () override
Public Member Functions inherited from KisPaintOpConfigWidget
	KisPaintOpConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())
KisResourcesInterfaceSP	resourcesInterface () const
void	setConfigurationSafe (const KisPropertiesConfigurationSP config)
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
	~KisConfigWidget () override

Protected Member Functions
void	addPaintOpOption (KisPaintOpOption *option, QString category)
bool	eventFilter (QObject *obj, QEvent *event) override
virtual void	notifyPageChanged ()
Protected Member Functions inherited from KisConfigWidget
	KisConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags(), int delay=200)

Private Slots
void	changePage (const QModelIndex &)
void	lockProperties (const QModelIndex &index)
void	slotEntryChecked (const QModelIndex &index)
void	slotLockPropertiesDrop ()
void	slotLockPropertiesSave ()

Private Attributes
Private *const	m_d
bool	m_saveLockedOption

Additional Inherited Members
Signals inherited from KisConfigWidget
void	sigConfigurationItemChanged ()
void	sigConfigurationUpdated ()
void	sigDropLockedConfig (KisPropertiesConfigurationSP p)
void	sigSaveLockedConfig (KisPropertiesConfigurationSP p)
Protected Attributes inherited from KisPaintOpConfigWidget
KisImageWSP	m_image
int	m_isInsideUpdateCall
KisNodeWSP	m_node
KisResourcesInterfaceSP	m_resourcesInterface

Detailed Description

A common widget for enabling/disabling and determining the effect of tablet pressure, tilt and rotation and other paintop settings.

Definition at line 26 of file kis_paintop_settings_widget.h.

Constructor & Destructor Documentation

KisPaintOpSettingsWidget()

KisPaintOpSettingsWidget::KisPaintOpSettingsWidget

(

QWidget *

parent = 0

)

Definition at line 46 of file kis_paintop_settings_widget.cpp.

        : KisPaintOpConfigWidget(parent)
        , m_d(new Private())
{
    setObjectName("KisPaintOpPresetsWidget");
 
    m_d->model       = new KisPaintOpOptionListModel(this);
    m_d->optionsList = new KisCategorizedListView(this);
    m_d->optionsList->setModel(m_d->model);
    m_d->optionsList->setItemDelegate(new KisCategorizedItemDelegate(m_d->optionsList));
    m_d->optionsList->setSizeAdjustPolicy(QAbstractScrollArea::AdjustToContents);
    m_d->optionsList->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 
    QSizePolicy policy =  QSizePolicy(QSizePolicy::Preferred, QSizePolicy::Preferred);
    m_d->optionsList->setSizePolicy(policy);
 
    m_d->optionsList->setMinimumWidth(160); // this should be just big enough to show all of the setting names
 
    m_d->optionsStack = new QStackedWidget(this);
    policy = QSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
    m_d->optionsStack->setSizePolicy(policy);
 
    QHBoxLayout* layout = new QHBoxLayout(this);
    layout->addWidget(m_d->optionsList);
    layout->addWidget(m_d->optionsStack);
 
    layout->setStretch(0, 0);
    layout->setStretch(1, 1);
 
    m_saveLockedOption = false;
 
    connect(m_d->optionsList, SIGNAL(activated(QModelIndex)), this, SLOT(changePage(QModelIndex)));
    connect(m_d->optionsList, SIGNAL(clicked(QModelIndex)), this, SLOT(changePage(QModelIndex)));
    connect(m_d->optionsList, SIGNAL(rightClickedMenuDropSettingsTriggered()), this, SLOT(slotLockPropertiesDrop()));
    connect(m_d->optionsList, SIGNAL(rightClickedMenuSaveSettingsTriggered()), this, SLOT(slotLockPropertiesSave()));
    connect(m_d->optionsList, SIGNAL(sigEntryChecked(QModelIndex)), this, SLOT(slotEntryChecked(QModelIndex)));
    connect (m_d->optionsList, SIGNAL(lockAreaTriggered(QModelIndex)), this, SLOT(lockProperties(QModelIndex)));
 
    // allow the list viewport to be responsive to input release events
    m_d->optionsList->viewport()->installEventFilter(this);
}

References changePage(), connect(), lockProperties(), m_d, m_saveLockedOption, KisPaintOpSettingsWidget::Private::model, KisPaintOpSettingsWidget::Private::optionsList, KisPaintOpSettingsWidget::Private::optionsStack, KisCategorizedListView::setModel(), slotEntryChecked(), slotLockPropertiesDrop(), and slotLockPropertiesSave().

~KisPaintOpSettingsWidget()

KisPaintOpSettingsWidget::~KisPaintOpSettingsWidget ( )

override

Definition at line 89 of file kis_paintop_settings_widget.cpp.

{
    qDeleteAll(m_d->paintOpOptions);
    delete m_d;
}

References m_d, and KisPaintOpSettingsWidget::Private::paintOpOptions.

Member Function Documentation

addPaintOpOption() [1/3]

void KisPaintOpSettingsWidget::addPaintOpOption

(

KisPaintOpOption *

option

)

Definition at line 95 of file kis_paintop_settings_widget.cpp.

{
    addPaintOpOption(option, option->category());
}

References addPaintOpOption(), and KisPaintOpOption::category().

addPaintOpOption() [2/3]

void KisPaintOpSettingsWidget::addPaintOpOption	(	KisPaintOpOption *	option,
		KisPaintOpOption::PaintopCategory	category )

Definition at line 100 of file kis_paintop_settings_widget.cpp.

{
    addPaintOpOption(option, m_d->model->categoryName(category));
}

References addPaintOpOption(), KisPaintOpOptionListModel::categoryName(), m_d, and KisPaintOpSettingsWidget::Private::model.

addPaintOpOption() [3/3]

void KisPaintOpSettingsWidget::addPaintOpOption ( KisPaintOpOption * option, QString category )

protected

Definition at line 105 of file kis_paintop_settings_widget.cpp.

{
    if (!option->configurationPage()) return;
    m_d->model->addPaintOpOption(option, m_d->optionsStack->count(), option->label(), category);
    connect(option, SIGNAL(sigSettingChanged()), SIGNAL(sigConfigurationItemChanged()));
    m_d->optionsStack->addWidget(option->configurationPage());
    m_d->paintOpOptions << option;
 
    m_d->lodLimitations =
        kislager::fold_optional_cursors(std::bit_or{}, m_d->lodLimitations,
                                      option->effectiveLodLimitations());
}

References KisPaintOpOptionListModel::addPaintOpOption(), KisPaintOpOption::configurationPage(), connect(), KisPaintOpOption::effectiveLodLimitations(), kislager::fold_optional_cursors(), KisPaintOpOption::label(), KisPaintOpSettingsWidget::Private::lodLimitations, m_d, KisPaintOpSettingsWidget::Private::model, KisPaintOpSettingsWidget::Private::optionsStack, KisPaintOpSettingsWidget::Private::paintOpOptions, and KisConfigWidget::sigConfigurationItemChanged().

changePage

void KisPaintOpSettingsWidget::changePage ( const QModelIndex & index )

privateslot

Definition at line 204 of file kis_paintop_settings_widget.cpp.

{
    KisOptionInfo info;
    QPalette palette;
    palette.setColor(QPalette::Base, QColor(255,200,200));
    palette.setColor(QPalette::Text, Qt::black);
 
    if(m_d->model->entryAt(info, index)) {
        m_d->optionsStack->setCurrentIndex(info.index);
    }
 
    notifyPageChanged();
}

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::entryAt(), KisOptionInfo::index, m_d, KisPaintOpSettingsWidget::Private::model, notifyPageChanged(), KisPaintOpSettingsWidget::Private::optionsStack, and palette.

effectiveBrushSize()

lager::reader< qreal > KisPaintOpSettingsWidget::effectiveBrushSize ( ) const

overridevirtual

Implements KisPaintOpConfigWidget.

Definition at line 163 of file kis_paintop_settings_widget.cpp.

{
    return lager::make_constant(1.0);
}

eventFilter()

bool KisPaintOpSettingsWidget::eventFilter ( QObject * obj, QEvent * event )

overrideprotected

Definition at line 269 of file kis_paintop_settings_widget.cpp.

{
    if (event->type() == (QEvent::MouseButtonRelease) || event->type() == QEvent::TabletRelease) {
        // bit of a hack to properly work with the KisCategorizedListView type:
        // get the mouse position and utilize indexAt() instead of currentIndex() to
        // ensure the pages don't swap back and forth if the user repeatedly clicks
        // another option's checkbox too quickly
        const QMouseEvent* mevent = static_cast<const QMouseEvent*>(event);
        QModelIndex index = m_d->optionsList->indexAt(mevent->pos());
        changePage(index);
        event->accept();
    }
 
    return QObject::eventFilter(obj, event);
}

References changePage(), m_d, and KisPaintOpSettingsWidget::Private::optionsList.

lockProperties

void KisPaintOpSettingsWidget::lockProperties ( const QModelIndex & index )

privateslot

Definition at line 222 of file kis_paintop_settings_widget.cpp.

{
    KisOptionInfo info;
    if (m_d->model->entryAt(info, index)) {
        m_d->optionsList->setCurrentIndex(index);
        KisPropertiesConfigurationSP p = new KisPropertiesConfiguration();
        info.option->startWriteOptionSetting(p);
 
        if (!info.option->isLocked()){
            KisLockedPropertiesServer::instance()->addToLockedProperties(p);
            info.option->setLocked(true);
            m_d->model->categoriesMapper()->itemFromRow(index.row())->setLocked(true);
            m_d->model->signalDataChanged(index);
 
        }
        else {
            KisLockedPropertiesServer::instance()->removeFromLockedProperties(p);
            info.option->setLocked(false);
            m_d->model->categoriesMapper()->itemFromRow(index.row())->setLocked(false);
            m_d->model->signalDataChanged(index);
 
            if (m_saveLockedOption){
                Q_EMIT sigSaveLockedConfig(p);
            }
            else {
                Q_EMIT sigDropLockedConfig(p);
            }
            m_saveLockedOption = false;
        }
    }
}

References KisLockedPropertiesServer::addToLockedProperties(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::entryAt(), KisLockedPropertiesServer::instance(), KisPaintOpOption::isLocked(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), m_d, m_saveLockedOption, KisPaintOpSettingsWidget::Private::model, KisOptionInfo::option, KisPaintOpSettingsWidget::Private::optionsList, p, KisLockedPropertiesServer::removeFromLockedProperties(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setLocked(), KisPaintOpOption::setLocked(), KisConfigWidget::sigDropLockedConfig(), KisPaintOpOptionListModel::signalDataChanged(), KisConfigWidget::sigSaveLockedConfig(), and KisPaintOpOption::startWriteOptionSetting().

lodLimitations()

KisPaintopLodLimitations KisPaintOpSettingsWidget::lodLimitations ( ) const

overridevirtual

Implements KisPaintOpConfigWidget.

Definition at line 146 of file kis_paintop_settings_widget.cpp.

{
    KisPaintopLodLimitations l;
 
    Q_FOREACH (const KisPaintOpOption* option, m_d->paintOpOptions) {
        if (option->isCheckable() && !option->isChecked()) continue;
        option->lodLimitations(&l);
    }
 
    return l;
}

References KisPaintOpOption::isCheckable(), KisPaintOpOption::isChecked(), KisPaintOpOption::lodLimitations(), m_d, and KisPaintOpSettingsWidget::Private::paintOpOptions.

lodLimitationsReader()

lager::reader< KisPaintopLodLimitations > KisPaintOpSettingsWidget::lodLimitationsReader ( ) const

overridevirtual

Implements KisPaintOpConfigWidget.

Definition at line 158 of file kis_paintop_settings_widget.cpp.

{
    return m_d->lodLimitations.value_or(lager::make_constant(KisPaintopLodLimitations()));
}

References KisPaintOpSettingsWidget::Private::lodLimitations, and m_d.

notifyPageChanged()

void KisPaintOpSettingsWidget::notifyPageChanged ( )

protectedvirtual

Definition at line 218 of file kis_paintop_settings_widget.cpp.

{
}

setCanvasResourcesInterface()

void KisPaintOpSettingsWidget::setCanvasResourcesInterface ( KoCanvasResourcesInterfaceSP canvasResourcesInterface )

overridevirtual

Reimplemented from KisConfigWidget.

Definition at line 195 of file kis_paintop_settings_widget.cpp.

{
    KisPaintOpConfigWidget::setCanvasResourcesInterface(canvasResourcesInterface);
 
    Q_FOREACH (KisPaintOpOption* option, m_d->paintOpOptions) {
        option->setCanvasResourcesInterface(canvasResourcesInterface);
    }
}

References KisConfigWidget::canvasResourcesInterface(), m_d, KisPaintOpSettingsWidget::Private::paintOpOptions, KisConfigWidget::setCanvasResourcesInterface(), and KisPaintOpOption::setCanvasResourcesInterface().

setConfiguration()

void KisPaintOpSettingsWidget::setConfiguration ( const KisPropertiesConfigurationSP config )

overridevirtual

Reimplemented.

Implements KisPaintOpConfigWidget.

Definition at line 118 of file kis_paintop_settings_widget.cpp.

{
    Q_ASSERT(!config->getString("paintop").isEmpty());
    KisLockedPropertiesProxySP propertiesProxy = KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(config);
    int indexcount = 0;
    Q_FOREACH (KisPaintOpOption* option, m_d->paintOpOptions) {
        option->startReadOptionSetting(propertiesProxy);
 
        KisLockedPropertiesServer::instance()->setPropertiesFromLocked(false);
        KisOptionInfo info;
        info.option = option;
        info.index = indexcount;
 
        m_d->model->categoriesMapper()->itemFromRow(m_d->model->indexOf(info).row())->setLocked(option->isLocked());
        m_d->model->categoriesMapper()->itemFromRow(m_d->model->indexOf(info).row())->setLockable(true);
        m_d->model->signalDataChanged(m_d->model->indexOf(info));
        indexcount++;
    }
}

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisLockedPropertiesServer::createLockedPropertiesProxy(), KisOptionInfo::index, KisCategorizedListModel< TEntry, TEntryToQStringConverter >::indexOf(), KisLockedPropertiesServer::instance(), KisPaintOpOption::isLocked(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), m_d, KisPaintOpSettingsWidget::Private::model, KisOptionInfo::option, KisPaintOpSettingsWidget::Private::paintOpOptions, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setLockable(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setLocked(), KisLockedPropertiesServer::setPropertiesFromLocked(), KisPaintOpOptionListModel::signalDataChanged(), and KisPaintOpOption::startReadOptionSetting().

setImage()

void KisPaintOpSettingsWidget::setImage ( KisImageWSP image )

overridevirtual

Reimplemented, sets image on option widgets.

Reimplemented from KisPaintOpConfigWidget.

Definition at line 168 of file kis_paintop_settings_widget.cpp.

{
    KisPaintOpConfigWidget::setImage(image);
 
    Q_FOREACH (KisPaintOpOption* option, m_d->paintOpOptions) {
        option->setImage(image);
    }
}

References m_d, KisPaintOpSettingsWidget::Private::paintOpOptions, KisPaintOpConfigWidget::setImage(), and KisPaintOpOption::setImage().

setNode()

void KisPaintOpSettingsWidget::setNode ( KisNodeWSP node )

overridevirtual

Reimplemented, sets node on option widgets.

Reimplemented from KisPaintOpConfigWidget.

Definition at line 177 of file kis_paintop_settings_widget.cpp.

{
    KisPaintOpConfigWidget::setNode(node);
 
    Q_FOREACH (KisPaintOpOption* option, m_d->paintOpOptions) {
        option->setNode(node);
    }
}

References m_d, KisPaintOpSettingsWidget::Private::paintOpOptions, KisPaintOpConfigWidget::setNode(), and KisPaintOpOption::setNode().

setResourcesInterface()

void KisPaintOpSettingsWidget::setResourcesInterface ( KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Reimplemented from KisPaintOpConfigWidget.

Definition at line 186 of file kis_paintop_settings_widget.cpp.

{
    KisPaintOpConfigWidget::setResourcesInterface(resourcesInterface);
 
    Q_FOREACH (KisPaintOpOption* option, m_d->paintOpOptions) {
        option->setResourcesInterface(resourcesInterface);
    }
}

References m_d, KisPaintOpSettingsWidget::Private::paintOpOptions, KisPaintOpConfigWidget::resourcesInterface(), KisPaintOpConfigWidget::setResourcesInterface(), and KisPaintOpOption::setResourcesInterface().

slotEntryChecked

void KisPaintOpSettingsWidget::slotEntryChecked ( const QModelIndex & index )

privateslot

Definition at line 263 of file kis_paintop_settings_widget.cpp.

{
    Q_UNUSED(index);
    Q_EMIT sigConfigurationItemChanged();
}

References KisConfigWidget::sigConfigurationItemChanged().

slotLockPropertiesDrop

void KisPaintOpSettingsWidget::slotLockPropertiesDrop ( )

privateslot

Definition at line 253 of file kis_paintop_settings_widget.cpp.

{
    m_saveLockedOption = false;
    lockProperties(m_d->optionsList->currentIndex());
}

References lockProperties(), m_d, m_saveLockedOption, and KisPaintOpSettingsWidget::Private::optionsList.

slotLockPropertiesSave

void KisPaintOpSettingsWidget::slotLockPropertiesSave ( )

privateslot

Definition at line 258 of file kis_paintop_settings_widget.cpp.

{
    m_saveLockedOption = true;
    lockProperties(m_d->optionsList->currentIndex());
}

References lockProperties(), m_d, m_saveLockedOption, and KisPaintOpSettingsWidget::Private::optionsList.

writeConfiguration()

void KisPaintOpSettingsWidget::writeConfiguration ( KisPropertiesConfigurationSP config ) const

overridevirtual

Reimplemented.

Implements KisPaintOpConfigWidget.

Definition at line 138 of file kis_paintop_settings_widget.cpp.

{
    KisLockedPropertiesProxySP propertiesProxy = KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(config);
    Q_FOREACH (const KisPaintOpOption* option, m_d->paintOpOptions) {
        option->startWriteOptionSetting(propertiesProxy);
    }
}

References KisLockedPropertiesServer::createLockedPropertiesProxy(), KisLockedPropertiesServer::instance(), m_d, KisPaintOpSettingsWidget::Private::paintOpOptions, and KisPaintOpOption::startWriteOptionSetting().

Member Data Documentation

m_d

Private* const KisPaintOpSettingsWidget::m_d

private

Definition at line 73 of file kis_paintop_settings_widget.h.

m_saveLockedOption

bool KisPaintOpSettingsWidget::m_saveLockedOption

private

Definition at line 74 of file kis_paintop_settings_widget.h.

---

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

• libs/ui/kis_paintop_settings_widget.h
• libs/ui/kis_paintop_settings_widget.cpp