KisGenericGradientEditor Class Reference

This is a generic gradient editor widget. More...

#include <KisGenericGradientEditor.h>

Inheritance diagram for KisGenericGradientEditor:

Public Slots
void	setAddGradientButtonVisible (bool visible)
	Set if the add gradient button must be shown.
void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP newCanvasResourcesInterface)
	Set the canvas resources interface.
void	setCompactGradientEditorMode (bool compact)
	Set if the internal gradient editor must use the compact mode.
void	setCompactGradientPresetChooserMode (bool compact)
	Set if the gradient preset chooser must be shown without any controls other than the list view.
void	setCompactMode (bool compact)
	Set if the editor must show a reduced ui.
void	setConvertGradientButtonVisible (bool visible)
	Set if the convert gradient button must be shown.
void	setGradient (KoAbstractGradientSP newGradient)
	Set the gradient.
void	setGradientPresetChooserOptionsButtonVisible (bool visible)
	Set if the button for the gradient preset chooser options must be shown.
void	setGradientPresetChooserVisible (bool visible)
	Set if the gradient preset chooser must be shown.
void	setUpdateGradientButtonVisible (bool visible)
	Set if the update gradient button must be shown.
void	setUseGradientPresetChooserPopUp (bool use)
	Set if the gradient preset chooser must be shown as a pop-up clicking a button or embedded in the widget ui.

Signals
void	sigGradientChanged ()
	signal emitted when the gradient changes

Public Member Functions
KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const
	Get the current Canvas Resources Interface.
bool	compactGradientEditorMode () const
	Tell if the internal gradient editor is using the compact mode.
bool	compactGradientPresetChooserMode () const
	Tell if the gradient preset chooser is being shown without any controls other than the list view.
bool	compactMode () const
	Tell if the compact mode is being used.
bool	event (QEvent *e) override
KoAbstractGradientSP	gradient () const
	Get the current gradient.
bool	isAddGradientButtonVisible () const
	Tell if the add gradient button is being shown.
bool	isConvertGradientButtonVisible () const
	Tell if the convert gradient button is being shown.
bool	isGradientPresetChooserOptionsButtonVisible () const
	Tell if the button for the gradient preset chooser options is being shown.
bool	isGradientPresetChooserVisible () const
	Tell if the gradient preset chooser is being shown.
bool	isUpdateGradientButtonVisible () const
	Tell if the update gradient button is being shown.
	KisGenericGradientEditor (QWidget *parent=0)
	Construct a new KisGenericGradientEditor widget.
void	loadUISettings (const QString &prefix=QString())
	Load the ui settings from the configuration.
QSize	minimumSizeHint () const override
void	saveUISettings (const QString &prefix=QString())
	Save the ui settings to the configuration.
QSize	sizeHint () const override
void	updateCachedSizeHint ()
bool	useGradientPresetChooserPopUp () const
	Tell if the gradient preset chooser is being shown as a pop-up clicking a button or embedded in the widget ui.
	~KisGenericGradientEditor () override

Public Attributes
QAction *	actionCompactGradientPresetChooserMode
QAction *	actionUseGradientPresetChooserPopUp
QPushButton *	buttonAddGradient
QPushButton *	buttonConvertGradient
QPushButton *	buttonUpdateGradient
QSize	cachedMinimumSizeHint
QSize	cachedSizeHint
KoCanvasResourcesInterfaceSP	canvasResourcesInterface
bool	compactGradientEditorMode
bool	compactGradientPresetChooserMode
bool	compactMode
KoAbstractGradientSP	gradient
bool	isAddGradientButtonVisible
bool	isConvertGradientButtonVisible
bool	isGradientPresetChooserOptionsButtonVisible
bool	isGradientPresetChooserVisible
bool	isUpdateGradientButtonVisible
QLabel *	labelConvertGradientWarning
KisGenericGradientEditor *	q
QToolButton *	toolButtonGradientPresetChooser
KisPopupButton *	toolButtonGradientPresetChooserOptions
bool	useGradientPresetChooserPopUp
QWidget *	widgetGradientEditor
KisGradientChooser *	widgetGradientPresetChooser
QWidget *	widgetToolButtonGradientPresetChooser

Private Slots
void	on_buttonAddGradient_clicked ()
void	on_buttonConvertGradient_clicked ()
void	on_buttonUpdateGradient_clicked ()
void	on_widgetGradientEditor_sigGradientChanged ()
void	on_widgetGradientPresetChooser_resourceClicked (KoResourceSP resource)

Private Member Functions
void	updateAddGradientButton ()
void	updateConvertGradientButton ()
void	updateGradientEditor ()
void	updateGradientPresetChooser ()
void	updateUpdateGradientButton ()
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
QScopedPointer< Private >	m_d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

This is a generic gradient editor widget.

This widget makes use of other gradient related widgets and puts them together in one place to ease the edition of gradients.

It supports loading/saving from/to resources and conversion between the different types of gradients

Definition at line 36 of file KisGenericGradientEditor.cpp.

Constructor & Destructor Documentation

KisGenericGradientEditor()

KisGenericGradientEditor::KisGenericGradientEditor

(

QWidget *

parent = 0

)

Construct a new KisGenericGradientEditor widget.

Parameters

parent

the parent widget

Definition at line 102 of file KisGenericGradientEditor.cpp.

    : QWidget(parent)
    , m_d(new Private)
{
    m_d->q = this;
    m_d->gradient = nullptr;
    m_d->canvasResourcesInterface = nullptr;
    m_d->widgetGradientEditor = nullptr;
 
    QVBoxLayout *layoutMain = new QVBoxLayout;
    layoutMain->setContentsMargins(0, 0, 0, 0);
    layoutMain->setSpacing(10);
 
    QHBoxLayout *layoutButtons = new QHBoxLayout;
    layoutButtons->setContentsMargins(0, 0, 0, 0);
    layoutButtons->setSpacing(5);
 
    m_d->buttonConvertGradient = new QPushButton(this);
    m_d->labelConvertGradientWarning = new QLabel(this);
    m_d->labelConvertGradientWarning->setPixmap(KisIconUtils::loadIcon("warning").pixmap(16, 16));
    m_d->labelConvertGradientWarning->setToolTip(
        i18nc(
            "Warning text shown when converting from a segment gradient to a stop gradient",
            "Converting a segment gradient to a stop gradient may cause loss of information"
        )
    );
 
    m_d->widgetGradientPresetChooser = new KisGradientChooser(this);
    m_d->widgetGradientPresetChooser->setNameLabelVisible(false);
    m_d->widgetGradientPresetChooser->setEditOptionsVisible(false);
 
    m_d->toolButtonGradientPresetChooser = new QToolButton(this);
    m_d->toolButtonGradientPresetChooser->setText(
        i18nc("Choose a preset gradient from the button popup", "Choose Gradient Preset")
    );
    m_d->toolButtonGradientPresetChooser->setPopupMode(QToolButton::InstantPopup);
    m_d->widgetToolButtonGradientPresetChooser = new QWidget(this);
    QVBoxLayout *layoutWidgetToolButtonGradientPresetChooser = new QVBoxLayout;
    layoutWidgetToolButtonGradientPresetChooser->setContentsMargins(0, 0, 0, 0);
    layoutWidgetToolButtonGradientPresetChooser->setSpacing(0);
    m_d->widgetToolButtonGradientPresetChooser->setLayout(layoutWidgetToolButtonGradientPresetChooser);
    QWidgetAction *widgetActionToolButtonGradientPresetChooser = new QWidgetAction(this);
    widgetActionToolButtonGradientPresetChooser->setDefaultWidget(m_d->widgetToolButtonGradientPresetChooser);
    m_d->toolButtonGradientPresetChooser->addAction(widgetActionToolButtonGradientPresetChooser);
    
    m_d->buttonUpdateGradient = new QPushButton(this);
    m_d->buttonUpdateGradient->setIcon(KisIconUtils::loadIcon("document-save"));
    m_d->buttonUpdateGradient->setToolTip(
        i18nc(
            "Update the current gradient in the presets with the one in the generic gradient editor",
            "Update the selected gradient preset with the current gradient"
        )
    );
    
    m_d->buttonAddGradient = new QPushButton(this);
    m_d->buttonAddGradient->setIcon(KisIconUtils::loadIcon("list-add"));
    m_d->buttonAddGradient->setToolTip(
        i18nc(
            "Add the current gradient in the generic gradient editor to the presets",
            "Add the current gradient to the presets"
        )
    );
 
    m_d->toolButtonGradientPresetChooserOptions = new KisPopupButton(this);
    m_d->toolButtonGradientPresetChooserOptions->setArrowVisible(false);
    m_d->toolButtonGradientPresetChooserOptions->setAutoRaise(true);
    m_d->toolButtonGradientPresetChooserOptions->setIcon(KisIconUtils::loadIcon("view-choose"));
    m_d->actionUseGradientPresetChooserPopUp = new QAction(this);
    m_d->actionUseGradientPresetChooserPopUp->setCheckable(true);
    m_d->actionUseGradientPresetChooserPopUp->setText(
        i18nc(
            "Show the gradient preset chooser as a pop-up in a button or inline",
            "Use a pop-up gradient preset chooser"
        )
    );
    m_d->actionCompactGradientPresetChooserMode = new QAction(this);
    m_d->actionCompactGradientPresetChooserMode->setCheckable(true);
    m_d->actionCompactGradientPresetChooserMode->setText(
        i18nc(
            "Hide/show option widgets around the gradient preset chooser",
            "Show compact gradient preset chooser"
        )
    );
    QMenu *toolButtonGradientPresetChooserOptionsMenu = new QMenu;
    toolButtonGradientPresetChooserOptionsMenu->addAction(m_d->actionUseGradientPresetChooserPopUp);
    toolButtonGradientPresetChooserOptionsMenu->addAction(m_d->actionCompactGradientPresetChooserMode);
    m_d->toolButtonGradientPresetChooserOptions->setPopupWidget(toolButtonGradientPresetChooserOptionsMenu);
 
    layoutButtons->addWidget(m_d->buttonAddGradient, 0);
    layoutButtons->addWidget(m_d->buttonUpdateGradient, 0);
    layoutButtons->addWidget(m_d->buttonConvertGradient, 0);
    layoutButtons->addWidget(m_d->labelConvertGradientWarning, 0);
    layoutButtons->addStretch(1);
    layoutButtons->addWidget(m_d->toolButtonGradientPresetChooser, 0);
    layoutButtons->addWidget(m_d->toolButtonGradientPresetChooserOptions, 0);
 
    layoutMain->addWidget(m_d->widgetGradientPresetChooser, 1);
    layoutMain->addLayout(layoutButtons, 0);
    layoutMain->addStretch();
 
    setLayout(layoutMain);
 
    m_d->compactMode = false;
    m_d->isConvertGradientButtonVisible = true;
    m_d->isUpdateGradientButtonVisible = true;
    m_d->isAddGradientButtonVisible = true;
    m_d->isGradientPresetChooserVisible = true;
    m_d->isGradientPresetChooserOptionsButtonVisible = true;
    m_d->useGradientPresetChooserPopUp = true;
    m_d->compactGradientPresetChooserMode = false;
    m_d->compactGradientEditorMode = false;
 
    updateConvertGradientButton();
    updateUpdateGradientButton();
    updateAddGradientButton();
    updateGradientPresetChooser();
    updateGradientEditor();
 
    connect(
        m_d->buttonConvertGradient,
        SIGNAL(clicked()),
        this,
        SLOT(on_buttonConvertGradient_clicked())
    );
 
    connect(
        m_d->buttonUpdateGradient,
        SIGNAL(clicked()),
        this,
        SLOT(on_buttonUpdateGradient_clicked())
    );
 
    connect(
        m_d->buttonAddGradient,
        SIGNAL(clicked()),
        this,
        SLOT(on_buttonAddGradient_clicked())
    );
 
    connect(
        m_d->widgetGradientPresetChooser,
        SIGNAL(resourceClicked(KoResourceSP)),
        this,
        SLOT(on_widgetGradientPresetChooser_resourceClicked(KoResourceSP))
    );
 
    connect(
        m_d->actionUseGradientPresetChooserPopUp,
        SIGNAL(toggled(bool)),
        this,
        SLOT(setUseGradientPresetChooserPopUp(bool))
    );
 
    connect(
        m_d->actionCompactGradientPresetChooserMode,
        SIGNAL(toggled(bool)),
        this,
        SLOT(setCompactGradientPresetChooserMode(bool))
    );
 
    m_d->updateCachedSizeHint();
    setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Minimum);
}

References connect(), KisIconUtils::loadIcon(), m_d, on_buttonAddGradient_clicked(), on_buttonConvertGradient_clicked(), on_buttonUpdateGradient_clicked(), on_widgetGradientPresetChooser_resourceClicked(), setCompactGradientPresetChooserMode(), setUseGradientPresetChooserPopUp(), updateAddGradientButton(), updateConvertGradientButton(), updateGradientEditor(), updateGradientPresetChooser(), and updateUpdateGradientButton().

~KisGenericGradientEditor()

KisGenericGradientEditor::~KisGenericGradientEditor ( )

override

Definition at line 266 of file KisGenericGradientEditor.cpp.

{}

Member Function Documentation

canvasResourcesInterface()

KoCanvasResourcesInterfaceSP KisGenericGradientEditor::canvasResourcesInterface

(

)

const

Get the current Canvas Resources Interface.

Returns

The current Canvas Resources Interface

See also

setCanvasResourcesInterface(KoCanvasResourcesInterfaceSP)

compactGradientEditorMode()

bool KisGenericGradientEditor::compactGradientEditorMode

(

)

const

Tell if the internal gradient editor is using the compact mode.

Returns

true if the internal gradient editor is using the compact mode, false otherwise

See also

setCompactGradientEditorMode(bool)

compactGradientPresetChooserMode()

bool KisGenericGradientEditor::compactGradientPresetChooserMode

(

)

const

Tell if the gradient preset chooser is being shown without any controls other than the list view.

Returns

true if the gradient preset chooser is being shown without any controls other than the list view, false otherwise

See also

setCompactGradientPresetChooserMode(bool)

compactMode()

bool KisGenericGradientEditor::compactMode

(

)

const

Tell if the compact mode is being used.

Returns

true if the compact mode is being used, false otherwise

See also

setCompactMode(bool)

event()

bool KisGenericGradientEditor::event ( QEvent * e )

override

Definition at line 511 of file KisGenericGradientEditor.cpp.

{
    if (e->type() == QEvent::StyleChange || e->type() == QEvent::FontChange) {
        m_d->updateCachedSizeHint();
    }
    return QWidget::event(e);
}

References m_d.

gradient()

KoAbstractGradientSP KisGenericGradientEditor::gradient

(

)

const

Get the current gradient.

A clone is returned so that any changes in the returned gradient won't change the editor gradient and vice-versa

Returns

A clone of the current gradient

See also

setGradient(KoAbstractGradientSP)

isAddGradientButtonVisible()

bool KisGenericGradientEditor::isAddGradientButtonVisible

(

)

const

Tell if the add gradient button is being shown.

Returns

true if the add gradient button is being shown, false otherwise

See also

setAddGradientButtonVisible(bool)

isConvertGradientButtonVisible()

bool KisGenericGradientEditor::isConvertGradientButtonVisible

(

)

const

Tell if the convert gradient button is being shown.

Returns

true if the convert gradient button is being shown, false otherwise

See also

setConvertGradientButtonVisible(bool)

isGradientPresetChooserOptionsButtonVisible()

bool KisGenericGradientEditor::isGradientPresetChooserOptionsButtonVisible

(

)

const

Tell if the button for the gradient preset chooser options is being shown.

Returns

true if the button for the gradient preset chooser options is being shown, false otherwise

See also

setGradientPresetChooserOptionsButtonVisible(bool)

isGradientPresetChooserVisible()

bool KisGenericGradientEditor::isGradientPresetChooserVisible

(

)

const

Tell if the gradient preset chooser is being shown.

Returns

true if the gradient preset chooser is being shown, false otherwise

See also

setGradientPresetChooserVisible(bool)

isUpdateGradientButtonVisible()

bool KisGenericGradientEditor::isUpdateGradientButtonVisible

(

)

const

Tell if the update gradient button is being shown.

Returns

true if the update gradient button is being shown, false otherwise

See also

setUpdateGradientButtonVisible(bool)

loadUISettings()

void KisGenericGradientEditor::loadUISettings

(

const QString &

prefix = QString()

)

Load the ui settings from the configuration.

Parameters

prefix

string prepended to the settings names

See also

saveUISettings(const QString &)

Definition at line 269 of file KisGenericGradientEditor.cpp.

{
    KConfigGroup configGroup(KSharedConfig::openConfig(), "GenericGradientEditor");
    const QString pfx = prefix.isEmpty() ? QString("global/") : prefix + "/";
 
    m_d->useGradientPresetChooserPopUp = configGroup.readEntry(pfx + "useGradientPresetChooserPopUp", m_d->useGradientPresetChooserPopUp);
    m_d->compactGradientPresetChooserMode = configGroup.readEntry(pfx + "compactGradientPresetChooserMode", m_d->compactGradientPresetChooserMode);
    
    updateGradientPresetChooser();
}

References m_d, and updateGradientPresetChooser().

minimumSizeHint()

QSize KisGenericGradientEditor::minimumSizeHint ( ) const

override

Definition at line 506 of file KisGenericGradientEditor.cpp.

{
    return m_d->cachedMinimumSizeHint;
}

References m_d.

on_buttonAddGradient_clicked

void KisGenericGradientEditor::on_buttonAddGradient_clicked ( )

privateslot

Definition at line 639 of file KisGenericGradientEditor.cpp.

{
    qDebug() << m_d->gradient << m_d->gradient->valid() << m_d->gradient->name();
 
    if (!m_d->gradient || !m_d->gradient->valid() || m_d->gradient->name().isEmpty()) {
        return;
    }
    
    m_d->gradient->updatePreview();
    KisResourceModel model(ResourceType::Gradients);
    KisResourceUserOperations::addResourceWithUserInput(this, m_d->gradient);
}

References KisResourceUserOperations::addResourceWithUserInput(), ResourceType::Gradients, and m_d.

on_buttonConvertGradient_clicked

void KisGenericGradientEditor::on_buttonConvertGradient_clicked ( )

privateslot

Definition at line 612 of file KisGenericGradientEditor.cpp.

{
    if (m_d->gradient.dynamicCast<KoStopGradient>()) {
        setGradient(KisGradientConversion::toSegmentGradient(m_d->gradient));
    }
    else if (m_d->gradient.dynamicCast<KoSegmentGradient>()) {
        setGradient(KisGradientConversion::toStopGradient(m_d->gradient));
    }
}

References m_d, setGradient(), KisGradientConversion::toSegmentGradient(), and KisGradientConversion::toStopGradient().

on_buttonUpdateGradient_clicked

void KisGenericGradientEditor::on_buttonUpdateGradient_clicked ( )

privateslot

Definition at line 622 of file KisGenericGradientEditor.cpp.

{
    if (!m_d->gradient || !m_d->gradient->valid() || !(m_d->gradient->resourceId() > -1)) {
        return;
    }
 
    KoResourceSP selectedGradient = m_d->widgetGradientPresetChooser->currentResource();
    if (!selectedGradient ||
        !(m_d->gradient->resourceId() == selectedGradient->resourceId()) ||
        selectedGradient->permanent()) {
        return;
    }
 
    m_d->gradient->updatePreview();
    KisResourceUserOperations::updateResourceWithUserInput(this, m_d->gradient);
}

References m_d, and KisResourceUserOperations::updateResourceWithUserInput().

on_widgetGradientEditor_sigGradientChanged

void KisGenericGradientEditor::on_widgetGradientEditor_sigGradientChanged ( )

privateslot

Definition at line 657 of file KisGenericGradientEditor.cpp.

{
    updateUpdateGradientButton();
    updateAddGradientButton();
    Q_EMIT sigGradientChanged();
}

References sigGradientChanged(), updateAddGradientButton(), and updateUpdateGradientButton().

on_widgetGradientPresetChooser_resourceClicked

void KisGenericGradientEditor::on_widgetGradientPresetChooser_resourceClicked ( KoResourceSP resource )

privateslot

Definition at line 652 of file KisGenericGradientEditor.cpp.

{
    setGradient(resource.dynamicCast<KoAbstractGradient>());
}

References setGradient().

saveUISettings()

void KisGenericGradientEditor::saveUISettings

(

const QString &

prefix = QString()

)

Save the ui settings to the configuration.

Parameters

prefix

string prepended to the settings names

See also

loadUISettings(const QString &)

Definition at line 280 of file KisGenericGradientEditor.cpp.

{
    KConfigGroup configGroup(KSharedConfig::openConfig(), "GenericGradientEditor");
    const QString pfx = prefix.isEmpty() ? QString("global/") : prefix + "/";
 
    configGroup.writeEntry(pfx + "useGradientPresetChooserPopUp", m_d->useGradientPresetChooserPopUp);
    configGroup.writeEntry(pfx + "compactGradientPresetChooserMode", m_d->compactGradientPresetChooserMode);
}

References m_d.

setAddGradientButtonVisible

void KisGenericGradientEditor::setAddGradientButtonVisible ( bool visible )

slot

Set if the add gradient button must be shown.

Parameters

visible

true if the add gradient button must be shown, false otherwise

See also

isAddGradientButtonVisible()

Definition at line 460 of file KisGenericGradientEditor.cpp.

{
    m_d->isAddGradientButtonVisible = visible;
    updateAddGradientButton();
}

References m_d, and updateAddGradientButton().

setCanvasResourcesInterface

void KisGenericGradientEditor::setCanvasResourcesInterface ( KoCanvasResourcesInterfaceSP newCanvasResourcesInterface )

slot

Set the canvas resources interface.

the canvas resources interface is used to get the current foreground and background colors

Parameters

newCanvasResourcesInterface

the new canvas resources interface

See also

canvasResourcesInterface()

Definition at line 425 of file KisGenericGradientEditor.cpp.

{
    m_d->canvasResourcesInterface = newCanvasResourcesInterface;
 
    if (dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)) {
        dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)->setCanvasResourcesInterface(m_d->canvasResourcesInterface);
    } else if (dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)) {
        dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)->setCanvasResourcesInterface(m_d->canvasResourcesInterface);
    }
 
    m_d->widgetGradientPresetChooser->setCanvasResourcesInterface(newCanvasResourcesInterface);
}

References m_d, KisSegmentGradientEditor::setCanvasResourcesInterface(), and setCanvasResourcesInterface().

setCompactGradientEditorMode

void KisGenericGradientEditor::setCompactGradientEditorMode ( bool compact )

slot

Set if the internal gradient editor must use the compact mode.

Parameters

compact

true if the internal gradient editor must use the compact mode, false otherwise

See also

compactGradientEditorMode()

Definition at line 493 of file KisGenericGradientEditor.cpp.

{
    m_d->compactGradientEditorMode = compact;
    updateGradientEditor();
    m_d->updateCachedSizeHint();
}

References m_d, and updateGradientEditor().

setCompactGradientPresetChooserMode

void KisGenericGradientEditor::setCompactGradientPresetChooserMode ( bool compact )

slot

Set if the gradient preset chooser must be shown without any controls other than the list view.

Parameters

compact

true if the gradient preset chooser must be shown without any controls other than the list view, false otherwise

See also

compactGradientPresetChooserMode()

Definition at line 486 of file KisGenericGradientEditor.cpp.

{
    m_d->compactGradientPresetChooserMode = compact;
    updateGradientPresetChooser();
    m_d->updateCachedSizeHint();
}

References m_d, and updateGradientPresetChooser().

setCompactMode

void KisGenericGradientEditor::setCompactMode ( bool compact )

slot

Set if the editor must show a reduced ui.

If the compact mode is set, only the gradient editors will be visible

Parameters

compact

true if the compact mode must be used, false otherwise

See also

compactMode()

Definition at line 438 of file KisGenericGradientEditor.cpp.

{
    m_d->compactMode = compact;
    
    updateConvertGradientButton();
    updateUpdateGradientButton();
    updateAddGradientButton();
    updateGradientPresetChooser();
}

References m_d, updateAddGradientButton(), updateConvertGradientButton(), updateGradientPresetChooser(), and updateUpdateGradientButton().

setConvertGradientButtonVisible

void KisGenericGradientEditor::setConvertGradientButtonVisible ( bool visible )

slot

Set if the convert gradient button must be shown.

Parameters

visible

true if the convert gradient button must be shown, false otherwise

See also

isConvertGradientButtonVisible()

Definition at line 448 of file KisGenericGradientEditor.cpp.

{
    m_d->isConvertGradientButtonVisible = visible;
    updateConvertGradientButton();
}

References m_d, and updateConvertGradientButton().

setGradient

void KisGenericGradientEditor::setGradient ( KoAbstractGradientSP newGradient )

slot

Set the gradient.

This editor makes a clone os the gradient passed so that any changes made in the editor won't change the passed gradient and vice-versa

Parameters

newGradient

The new gradient

See also

gradient()

Definition at line 347 of file KisGenericGradientEditor.cpp.

{
    if (newGradient == m_d->gradient) {
        return;
    }
 
    if (!newGradient || !newGradient->valid()) {
        if (m_d->widgetGradientEditor) {
            layout()->removeWidget(m_d->widgetGradientEditor);
            delete m_d->widgetGradientEditor;
            m_d->widgetGradientEditor = nullptr;
        }
        m_d->gradient = nullptr;
        updateConvertGradientButton();
        updateUpdateGradientButton();
        updateAddGradientButton();
        updateGradientEditor();
        return;
    }
 
    m_d->gradient = newGradient->clone().staticCast<KoAbstractGradient>();
    if (m_d->canvasResourcesInterface) {
        m_d->gradient->updateVariableColors(m_d->canvasResourcesInterface);
    }
    
    QWidget *newGradientEditorWidget = nullptr;
    if (m_d->gradient.dynamicCast<KoStopGradient>()) {
        if (dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)) {
            dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)->setGradient(m_d->gradient.dynamicCast<KoStopGradient>());
        } else {
            newGradientEditorWidget =
                new KisStopGradientEditor(m_d->gradient.dynamicCast<KoStopGradient>(), nullptr, "", "", m_d->canvasResourcesInterface);
        }
    } else if (m_d->gradient.dynamicCast<KoSegmentGradient>()) {
        if (dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)) {
            dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)->setGradient(m_d->gradient.dynamicCast<KoSegmentGradient>());
        } else {
            newGradientEditorWidget =
                new KisSegmentGradientEditor(m_d->gradient.dynamicCast<KoSegmentGradient>(), nullptr, "", "", m_d->canvasResourcesInterface);
        }
    }
 
    if (newGradientEditorWidget) {
        QWidget *oldGradientEditorWidget = m_d->widgetGradientEditor;
        m_d->widgetGradientEditor = newGradientEditorWidget;
        m_d->widgetGradientEditor->layout()->setContentsMargins(0, 0, 0, 0);
        m_d->widgetGradientEditor->setMinimumSize(0, 0);
        m_d->widgetGradientEditor->setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Fixed);
        if (dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)) {
            dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)->setCompactMode(m_d->compactGradientPresetChooserMode);
        } else {
            dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)->setCompactMode(m_d->compactGradientPresetChooserMode);
        }
        if (oldGradientEditorWidget) {
            setUpdatesEnabled(false);
            layout()->replaceWidget(oldGradientEditorWidget, m_d->widgetGradientEditor);
            dynamic_cast<QVBoxLayout*>(layout())->setStretchFactor(m_d->widgetGradientEditor, 0);
            layout()->activate();
            delete oldGradientEditorWidget;
            setUpdatesEnabled(true);
        } else {
            dynamic_cast<QVBoxLayout*>(layout())->insertWidget(
                m_d->useGradientPresetChooserPopUp ? 1 : 2,
                m_d->widgetGradientEditor,
                0
            );
        }
        connect(m_d->widgetGradientEditor, SIGNAL(sigGradientChanged()), this, SLOT(on_widgetGradientEditor_sigGradientChanged()));
        updateConvertGradientButton();
        updateUpdateGradientButton();
        updateAddGradientButton();
        updateGradientEditor();
    }
    m_d->updateCachedSizeHint();
 
    Q_EMIT sigGradientChanged();
}

References connect(), m_d, on_widgetGradientEditor_sigGradientChanged(), setCompactMode(), setGradient(), sigGradientChanged(), updateAddGradientButton(), updateConvertGradientButton(), updateGradientEditor(), updateUpdateGradientButton(), and KoAbstractGradient::updateVariableColors().

setGradientPresetChooserOptionsButtonVisible

void KisGenericGradientEditor::setGradientPresetChooserOptionsButtonVisible ( bool visible )

slot

Set if the button for the gradient preset chooser options must be shown.

Parameters

visible

true if the button for the gradient preset chooser options must be shown, false otherwise

See also

isGradientPresetChooserOptionsButtonVisible()

Definition at line 473 of file KisGenericGradientEditor.cpp.

{
    m_d->isGradientPresetChooserOptionsButtonVisible = visible;
    updateGradientPresetChooser();
}

References m_d, and updateGradientPresetChooser().

setGradientPresetChooserVisible

void KisGenericGradientEditor::setGradientPresetChooserVisible ( bool visible )

slot

Set if the gradient preset chooser must be shown.

Parameters

visible

true if the gradient preset chooser must be shown, false otherwise

See also

isSaveGradientButtonVisible()

Definition at line 466 of file KisGenericGradientEditor.cpp.

{
    m_d->isGradientPresetChooserVisible = visible;
    updateGradientPresetChooser();
    m_d->updateCachedSizeHint();
}

References m_d, and updateGradientPresetChooser().

setUpdateGradientButtonVisible

void KisGenericGradientEditor::setUpdateGradientButtonVisible ( bool visible )

slot

Set if the update gradient button must be shown.

Parameters

visible

true if the update gradient button must be shown, false otherwise

See also

isUpdateGradientButtonVisible()

Definition at line 454 of file KisGenericGradientEditor.cpp.

{
    m_d->isUpdateGradientButtonVisible = visible;
    updateUpdateGradientButton();
}

References m_d, and updateUpdateGradientButton().

setUseGradientPresetChooserPopUp

void KisGenericGradientEditor::setUseGradientPresetChooserPopUp ( bool use )

slot

Set if the gradient preset chooser must be shown as a pop-up clicking a button or embedded in the widget ui.

Parameters

use	true if the gradient preset chooser must be shown as a pop-up, false otherwise

See also

useGradientPresetChooserPopUp()

Definition at line 479 of file KisGenericGradientEditor.cpp.

{
    m_d->useGradientPresetChooserPopUp = use;
    updateGradientPresetChooser();
    m_d->updateCachedSizeHint();
}

References m_d, and updateGradientPresetChooser().

sigGradientChanged

void KisGenericGradientEditor::sigGradientChanged ( )

signal

signal emitted when the gradient changes

sizeHint()

QSize KisGenericGradientEditor::sizeHint ( ) const

override

Definition at line 501 of file KisGenericGradientEditor.cpp.

{
    return m_d->cachedSizeHint;
}

References m_d.

updateAddGradientButton()

void KisGenericGradientEditor::updateAddGradientButton ( )

private

Definition at line 548 of file KisGenericGradientEditor.cpp.

{
    m_d->buttonAddGradient->setVisible(!m_d->compactMode && m_d->isAddGradientButtonVisible);
    m_d->buttonAddGradient->setEnabled(m_d->gradient && !m_d->gradient->name().isEmpty());
}

References m_d.

updateCachedSizeHint()

void KisGenericGradientEditor::updateCachedSizeHint ( )

inline

Definition at line 67 of file KisGenericGradientEditor.cpp.

    {
        static bool editorWidthHintComputed = false;
        static int editorWidthHint;
        static int editorMinimumWidthHint;
        if (!editorWidthHintComputed) {
            KisStopGradientEditor stopGradientEditor(nullptr);
            KisSegmentGradientEditor segmentGradientEditor(nullptr);
            editorWidthHint = qMax(stopGradientEditor.sizeHint().width(), segmentGradientEditor.sizeHint().width());
            editorMinimumWidthHint = qMax(stopGradientEditor.minimumSizeHint().width(), segmentGradientEditor.minimumSizeHint().width());
            editorWidthHintComputed = true;
        }
 
        const bool presetChooserHidden = useGradientPresetChooserPopUp || !isGradientPresetChooserVisible;
 
        cachedSizeHint = QSize(
            qMax(widgetGradientPresetChooser->sizeHint().width(), editorWidthHint),
 
            (presetChooserHidden ? 0 : widgetGradientPresetChooser->minimumHeight()) +
            buttonConvertGradient->sizeHint().height() +
            (widgetGradientEditor ? widgetGradientEditor->sizeHint().height() : 0) +
            (presetChooserHidden ? 15 : 25) // spacing
        );
 
        cachedMinimumSizeHint = QSize(
            qMax(widgetGradientPresetChooser->minimumSizeHint().width(), editorMinimumWidthHint),
 
            (presetChooserHidden ? 0 : widgetGradientPresetChooser->minimumHeight()) +
            buttonConvertGradient->minimumSizeHint().height() +
            (widgetGradientEditor ? widgetGradientEditor->minimumSizeHint().height() : 0) +
            (presetChooserHidden ? 15 : 25) // spacing
        );
    }

updateConvertGradientButton()

void KisGenericGradientEditor::updateConvertGradientButton ( )

private

Definition at line 519 of file KisGenericGradientEditor.cpp.

{
    bool isSegmentGradient = dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor);
 
    m_d->buttonConvertGradient->setVisible(!m_d->compactMode && m_d->isConvertGradientButtonVisible);
    m_d->labelConvertGradientWarning->setVisible(!m_d->compactMode && m_d->isConvertGradientButtonVisible && isSegmentGradient);
    
    m_d->buttonConvertGradient->setText(
        m_d->gradient
        ?   isSegmentGradient
            ? i18nc("Convert the segment gradient to a stop gradient", "Convert to Stop Gradient")
            : i18nc("Convert the stop gradient to a segment gradient", "Convert to Segment Gradient")
        :   i18nc("A gradient wasn't set in the generic gradient editor", "No Gradient Set")
    );
 
    m_d->buttonConvertGradient->setEnabled(!m_d->gradient.isNull());
}

References m_d.

updateGradientEditor()

void KisGenericGradientEditor::updateGradientEditor ( )

private

Definition at line 602 of file KisGenericGradientEditor.cpp.

{
    if (dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)) {
        dynamic_cast<KisStopGradientEditor*>(m_d->widgetGradientEditor)->setCompactMode(m_d->compactGradientEditorMode);
    }
    else if (dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)) {
        dynamic_cast<KisSegmentGradientEditor*>(m_d->widgetGradientEditor)->setCompactMode(m_d->compactGradientEditorMode);
    }
}

References m_d, and setCompactMode().

updateGradientPresetChooser()

void KisGenericGradientEditor::updateGradientPresetChooser ( )

private

Definition at line 554 of file KisGenericGradientEditor.cpp.

{
    m_d->widgetGradientPresetChooser->resourceItemChooser()->showImportExportBtns(!m_d->compactGradientPresetChooserMode);
    m_d->widgetGradientPresetChooser->resourceItemChooser()->showStorageBtn(!m_d->compactGradientPresetChooserMode);
    m_d->widgetGradientPresetChooser->resourceItemChooser()->showTaggingBar(!m_d->compactGradientPresetChooserMode);
    m_d->widgetGradientPresetChooser->resourceItemChooser()->showViewModeBtn(!m_d->compactGradientPresetChooserMode);
 
    {
        int margin = !m_d->useGradientPresetChooserPopUp || m_d->compactGradientPresetChooserMode ? 0 : 10;
        m_d->widgetGradientPresetChooser->setContentsMargins(margin, margin, margin, margin);
 
        if (m_d->useGradientPresetChooserPopUp) {
            if (!m_d->widgetToolButtonGradientPresetChooser->children().contains(m_d->widgetGradientPresetChooser)) {
                layout()->removeWidget(m_d->widgetGradientPresetChooser);
                m_d->widgetToolButtonGradientPresetChooser->layout()->addWidget(m_d->widgetGradientPresetChooser);
            }
            m_d->widgetGradientPresetChooser->setMinimumSize(
                m_d->compactGradientPresetChooserMode ? 300 : 320,
                m_d->compactGradientPresetChooserMode ? 300 : 320
            );
            m_d->widgetGradientPresetChooser->adjustSize();
        } else {
            if (!children().contains(m_d->widgetGradientPresetChooser)) {
                m_d->widgetToolButtonGradientPresetChooser->layout()->removeWidget(m_d->widgetGradientPresetChooser);
                static_cast<QVBoxLayout*>(layout())->insertWidget(0, m_d->widgetGradientPresetChooser, 1);
            }
            m_d->widgetGradientPresetChooser->setMinimumSize(
                0,
                m_d->compactGradientPresetChooserMode ? 100 : 200
            );
            m_d->widgetGradientPresetChooser->show();
        }
    }
 
    m_d->toolButtonGradientPresetChooser->setVisible(
        !m_d->compactMode &&
        m_d->isGradientPresetChooserVisible &&
        m_d->useGradientPresetChooserPopUp
    );
    m_d->toolButtonGradientPresetChooserOptions->setVisible(
        !m_d->compactMode &&
        m_d->isGradientPresetChooserVisible &&
        m_d->isGradientPresetChooserOptionsButtonVisible
    );
    m_d->actionUseGradientPresetChooserPopUp->setChecked(m_d->useGradientPresetChooserPopUp);
    m_d->actionCompactGradientPresetChooserMode->setChecked(m_d->compactGradientPresetChooserMode);
}

References m_d.

updateUpdateGradientButton()

void KisGenericGradientEditor::updateUpdateGradientButton ( )

private

Definition at line 537 of file KisGenericGradientEditor.cpp.

{
    m_d->buttonUpdateGradient->setVisible(!m_d->compactMode && m_d->isUpdateGradientButtonVisible);
    KoResourceSP selectedGradient = m_d->widgetGradientPresetChooser->currentResource();
    m_d->buttonUpdateGradient->setEnabled(
        m_d->gradient && selectedGradient &&
        m_d->gradient->resourceId() == selectedGradient->resourceId() &&
        !selectedGradient->permanent()
    );
}

References m_d.

useGradientPresetChooserPopUp()

bool KisGenericGradientEditor::useGradientPresetChooserPopUp

(

)

const

Tell if the gradient preset chooser is being shown as a pop-up clicking a button or embedded in the widget ui.

Returns

true if the gradient preset chooser is being shown as a pop-up, false otherwise

See also

setGradientPresetChooserVisible(bool)

Member Data Documentation

actionCompactGradientPresetChooserMode

QAction* KisGenericGradientEditor::actionCompactGradientPresetChooserMode

Definition at line 52 of file KisGenericGradientEditor.cpp.

actionUseGradientPresetChooserPopUp

QAction* KisGenericGradientEditor::actionUseGradientPresetChooserPopUp

Definition at line 51 of file KisGenericGradientEditor.cpp.

buttonAddGradient

QPushButton* KisGenericGradientEditor::buttonAddGradient

Definition at line 45 of file KisGenericGradientEditor.cpp.

buttonConvertGradient

QPushButton* KisGenericGradientEditor::buttonConvertGradient

Definition at line 43 of file KisGenericGradientEditor.cpp.

buttonUpdateGradient

QPushButton* KisGenericGradientEditor::buttonUpdateGradient

Definition at line 44 of file KisGenericGradientEditor.cpp.

cachedMinimumSizeHint

QSize KisGenericGradientEditor::cachedMinimumSizeHint

Definition at line 65 of file KisGenericGradientEditor.cpp.

cachedSizeHint

QSize KisGenericGradientEditor::cachedSizeHint

Definition at line 65 of file KisGenericGradientEditor.cpp.

canvasResourcesInterface

KoCanvasResourcesInterfaceSP KisGenericGradientEditor::canvasResourcesInterface

Definition at line 40 of file KisGenericGradientEditor.cpp.

compactGradientEditorMode

bool KisGenericGradientEditor::compactGradientEditorMode

Definition at line 63 of file KisGenericGradientEditor.cpp.

compactGradientPresetChooserMode

bool KisGenericGradientEditor::compactGradientPresetChooserMode

Definition at line 62 of file KisGenericGradientEditor.cpp.

compactMode

bool KisGenericGradientEditor::compactMode

Definition at line 55 of file KisGenericGradientEditor.cpp.

gradient

KoAbstractGradientSP KisGenericGradientEditor::gradient

Definition at line 39 of file KisGenericGradientEditor.cpp.

isAddGradientButtonVisible

bool KisGenericGradientEditor::isAddGradientButtonVisible

Definition at line 58 of file KisGenericGradientEditor.cpp.

isConvertGradientButtonVisible

bool KisGenericGradientEditor::isConvertGradientButtonVisible

Definition at line 56 of file KisGenericGradientEditor.cpp.

isGradientPresetChooserOptionsButtonVisible

bool KisGenericGradientEditor::isGradientPresetChooserOptionsButtonVisible

Definition at line 60 of file KisGenericGradientEditor.cpp.

isGradientPresetChooserVisible

bool KisGenericGradientEditor::isGradientPresetChooserVisible

Definition at line 59 of file KisGenericGradientEditor.cpp.

isUpdateGradientButtonVisible

bool KisGenericGradientEditor::isUpdateGradientButtonVisible

Definition at line 57 of file KisGenericGradientEditor.cpp.

labelConvertGradientWarning

QLabel* KisGenericGradientEditor::labelConvertGradientWarning

Definition at line 46 of file KisGenericGradientEditor.cpp.

m_d

QScopedPointer<Private> KisGenericGradientEditor::m_d

private

Definition at line 219 of file KisGenericGradientEditor.h.

q

KisGenericGradientEditor* KisGenericGradientEditor::q

Definition at line 42 of file KisGenericGradientEditor.cpp.

toolButtonGradientPresetChooser

QToolButton* KisGenericGradientEditor::toolButtonGradientPresetChooser

Definition at line 48 of file KisGenericGradientEditor.cpp.

toolButtonGradientPresetChooserOptions

KisPopupButton* KisGenericGradientEditor::toolButtonGradientPresetChooserOptions

Definition at line 50 of file KisGenericGradientEditor.cpp.

useGradientPresetChooserPopUp

bool KisGenericGradientEditor::useGradientPresetChooserPopUp

Definition at line 61 of file KisGenericGradientEditor.cpp.

widgetGradientEditor

QWidget* KisGenericGradientEditor::widgetGradientEditor

Definition at line 53 of file KisGenericGradientEditor.cpp.

widgetGradientPresetChooser

KisGradientChooser* KisGenericGradientEditor::widgetGradientPresetChooser

Definition at line 47 of file KisGenericGradientEditor.cpp.

widgetToolButtonGradientPresetChooser

QWidget* KisGenericGradientEditor::widgetToolButtonGradientPresetChooser

Definition at line 49 of file KisGenericGradientEditor.cpp.

---

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

• libs/ui/widgets/gradient/KisGenericGradientEditor.cpp
• libs/ui/widgets/gradient/KisGenericGradientEditor.h