ToolReferenceImagesWidget Class Reference

#include <ToolReferenceImagesWidget.h>

Inheritance diagram for ToolReferenceImagesWidget:

Classes
struct	Private

Public Member Functions
void	selectionChanged (KoSelection *selection)
	ToolReferenceImagesWidget (ToolReferenceImages *tool, KisCanvasResourceProvider *provider=0, QWidget *parent=0)
	~ToolReferenceImagesWidget () override

Private Slots
void	slotImageValuesChanged ()
void	slotKeepAspectChanged ()
void	slotOpacitySliderChanged (qreal)
void	slotSaturationSliderChanged (qreal)
void	slotSaveLocationChanged (int index)

Private Member Functions
void	updateVisibility (bool hasSelection)

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

Definition at line 21 of file ToolReferenceImagesWidget.h.

Constructor & Destructor Documentation

ToolReferenceImagesWidget()

ToolReferenceImagesWidget::ToolReferenceImagesWidget	(	ToolReferenceImages *	tool,
		KisCanvasResourceProvider *	provider = 0,
		QWidget *	parent = 0 )

Definition at line 37 of file ToolReferenceImagesWidget.cpp.

    : QWidget(parent),
      d(new Private(tool))
{
    d->ui = new Ui_WdgToolOptions();
    d->ui->setupUi(this);
 
    d->ui->opacitySlider->setRange(0, 100);
    d->ui->opacitySlider->setTextTemplates(
        i18nc("{n} is the number value, % is the percent sign", "Opacity: {n}%"),
        i18nc("{n} is the number value, % is the percent sign", "Opacity [*varies*]: {n}%"));
    d->ui->opacitySlider->setValueGetter(
        [](KoShape *s){ return 100.0 * (1.0 - s->transparency()); }
    );
 
    d->ui->saturationSlider->setRange(0, 100);
    d->ui->saturationSlider->setTextTemplates(
        i18nc("{n} is the number value, % is the percent sign", "Saturation: {n}%"),
        i18nc("{n} is the number value, % is the percent sign", "Saturation [*varies*]: {n}%"));
    d->ui->saturationSlider->setValueGetter(
        [](KoShape *s){
            auto *r = dynamic_cast<KisReferenceImage*>(s);
            KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(r, 0.0);
            return 100.0 * r->saturation();
        }
    );
 
    d->ui->bnDeleteSelectedImages->setToolTip(i18n("Delete Selected Reference Images"));
    d->ui->bnDeleteSelectedImages->setIcon(KisIconUtils::loadIcon("edit-delete"));
    d->ui->bnDeleteSelectedImages->setIconSize(QSize(16, 16));
 
    d->ui->bnAddReferenceImage->setToolTip(i18n("Add Reference Image From File"));
    d->ui->bnAddReferenceImage->setIcon(KisIconUtils::loadIcon("view-preview"));
    d->ui->bnAddReferenceImage->setIconSize(QSize(16, 16));
    
    d->ui->bnPasteReferenceImage->setToolTip(i18n("Paste Reference Image From System Clipboard"));
    d->ui->bnPasteReferenceImage->setIcon(KisIconUtils::loadIcon("edit-paste-16"));
    d->ui->bnPasteReferenceImage->setIconSize(QSize(16, 16));
    d->ui->bnPasteReferenceImage->setEnabled(KisClipboard::instance()->hasClip() || KisClipboard::instance()->hasUrls());
 
    d->ui->bnAddReferenceImageFromCurrentLayer->setToolTip(i18n("Create Reference Image from Active Layer"));
    d->ui->bnAddReferenceImageFromCurrentLayer->setIcon(KisIconUtils::loadIcon("current-layer"));
    
    d->ui->bnAddReferenceImageFromVisible->setToolTip(i18n("Create Reference Image from Visible Canvas"));
    d->ui->bnAddReferenceImageFromVisible->setIcon(KisIconUtils::loadIcon("all-layers"));
 
    d->ui->bnDelete->setToolTip(i18n("Delete all Reference Images"));
    d->ui->bnDelete->setIcon(KisIconUtils::loadIcon("edit-delete"));
    d->ui->bnDelete->setIconSize(QSize(16, 16));
 
    d->ui->bnLoad->setToolTip(i18n("Load Reference Images Set"));
    d->ui->bnLoad->setIcon(KisIconUtils::loadIcon("folder"));
    d->ui->bnLoad->setIconSize(QSize(16, 16));
 
    d->ui->bnSave->setToolTip(i18n("Export Reference Images Set"));
    d->ui->bnSave->setIcon(KisIconUtils::loadIcon("document-save-16"));
    d->ui->bnSave->setIconSize(QSize(16, 16));
 
 
    connect(d->ui->bnDeleteSelectedImages, SIGNAL(clicked()), tool, SLOT(removeSelectedReferenceImages()));
    connect(d->ui->bnAddReferenceImage, SIGNAL(clicked()), tool, SLOT(addReferenceImage()));
    connect(d->ui->bnPasteReferenceImage, SIGNAL(clicked()), tool, SLOT(pasteReferenceImage()));
    connect(d->ui->bnAddReferenceImageFromCurrentLayer, SIGNAL(clicked()), tool, SLOT(addReferenceImageFromLayer()));
    connect(d->ui->bnAddReferenceImageFromVisible, SIGNAL(clicked()), tool, SLOT(addReferenceImageFromVisible()));
 
    connect(KisClipboard::instance(), &KisClipboard::clipChanged, this, [&]() {
        d->ui->bnPasteReferenceImage->setEnabled(KisClipboard::instance()->hasClip() || KisClipboard::instance()->hasUrls());
    });
 
    connect(d->ui->bnDelete, SIGNAL(clicked()), tool, SLOT(removeAllReferenceImages()));
    connect(d->ui->bnSave, SIGNAL(clicked()), tool, SLOT(saveReferenceImages()));
    connect(d->ui->bnLoad, SIGNAL(clicked()), tool, SLOT(loadReferenceImages()));
 
    connect(d->ui->chkKeepAspectRatio, SIGNAL(stateChanged(int)), this, SLOT(slotKeepAspectChanged()));
 
    KisSignalCompressor *compressor = new KisSignalCompressor(100 /* ms */, KisSignalCompressor::POSTPONE, this);
    connect(compressor, SIGNAL(timeout()), this, SLOT(slotImageValuesChanged()));
 
    connect(d->ui->saturationSlider, SIGNAL(valueChanged(qreal)), compressor, SLOT(start()));
    connect(d->ui->opacitySlider, SIGNAL(valueChanged(qreal)), compressor, SLOT(start()));
 
    d->ui->referenceImageLocationCombobox->addItem(i18n("Embed to .KRA"));
    d->ui->referenceImageLocationCombobox->addItem(i18n("Link to Image"));
    connect(d->ui->referenceImageLocationCombobox, SIGNAL(currentIndexChanged(int)), this, SLOT(slotSaveLocationChanged(int)));
 
    updateVisibility(false); // no selection when we start
}

References KisClipboard::clipChanged(), connect(), d, KisClipboard::hasClip(), KisClipboard::hasUrls(), KisClipboard::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisIconUtils::loadIcon(), KisSignalCompressor::POSTPONE, slotImageValuesChanged(), slotKeepAspectChanged(), slotSaveLocationChanged(), KoShape::transparency(), and updateVisibility().

~ToolReferenceImagesWidget()

ToolReferenceImagesWidget::~ToolReferenceImagesWidget ( )

override

Definition at line 125 of file ToolReferenceImagesWidget.cpp.

{
    delete d->ui;
    d->ui = nullptr;
}

References d.

Member Function Documentation

selectionChanged()

void ToolReferenceImagesWidget::selectionChanged

(

KoSelection *

selection

)

Definition at line 131 of file ToolReferenceImagesWidget.cpp.

{
    QList<KoShape*> shapes = selection->selectedEditableShapes();
 
    d->ui->opacitySlider->setSelection(shapes);
    d->ui->saturationSlider->setSelection(shapes);
 
    bool anyKeepingAspectRatio = false;
    bool anyNotKeepingAspectRatio = false;
    bool anyEmbedded = false;
    bool anyLinked = false;
    // bool anyNonLinkable = false;
    bool anySelected = selection->count() > 0;
 
    Q_FOREACH(KoShape *shape, shapes) {
        KisReferenceImage *reference = dynamic_cast<KisReferenceImage*>(shape);
 
        anyKeepingAspectRatio |= shape->keepAspectRatio();
        anyNotKeepingAspectRatio |= !shape->keepAspectRatio();
 
        if (reference) {
            anyEmbedded |= reference->embed();
            anyLinked |= !reference->embed();
            // anyNonLinkable |= !reference->hasLocalFile();
        }
    }
 
    KisSignalsBlocker blocker(
        d->ui->chkKeepAspectRatio,
        d->ui->referenceImageLocationCombobox
    );
 
    d->ui->chkKeepAspectRatio->setCheckState(
        (anyKeepingAspectRatio && anyNotKeepingAspectRatio) ? Qt::PartiallyChecked :
         anyKeepingAspectRatio ? Qt::Checked : Qt::Unchecked);
 
 
    // set save location combobox
    bool imagesEmbedded = anyEmbedded && !anyLinked;
    int comboBoxIndex = imagesEmbedded ? 0 : 1; // maps state to combobox index
    d->ui->referenceImageLocationCombobox->setCurrentIndex(comboBoxIndex);
 
 
    updateVisibility(anySelected);
}

References KoSelection::count(), d, KisReferenceImage::embed(), KoShape::keepAspectRatio(), KoSelection::selectedEditableShapes(), and updateVisibility().

slotImageValuesChanged

void ToolReferenceImagesWidget::slotImageValuesChanged ( )

privateslot

Definition at line 233 of file ToolReferenceImagesWidget.cpp.

{
    slotSaturationSliderChanged(d->ui->saturationSlider->value());
    slotOpacitySliderChanged(d->ui->opacitySlider->value());
}

References d, slotOpacitySliderChanged(), and slotSaturationSliderChanged().

slotKeepAspectChanged

void ToolReferenceImagesWidget::slotKeepAspectChanged ( )

privateslot

Definition at line 177 of file ToolReferenceImagesWidget.cpp.

{
    KoSelection *selection = d->tool->koSelection();
    QList<KoShape*> shapes = selection->selectedEditableShapes();
 
    KUndo2Command *cmd =
            new KoShapeKeepAspectRatioCommand(shapes, d->ui->chkKeepAspectRatio->isChecked());
 
    d->tool->canvas()->addCommand(cmd);
}

References d, and KoSelection::selectedEditableShapes().

slotOpacitySliderChanged

void ToolReferenceImagesWidget::slotOpacitySliderChanged ( qreal newOpacity )

privateslot

Definition at line 188 of file ToolReferenceImagesWidget.cpp.

{
    QList<KoShape*> shapes = d->ui->opacitySlider->selection();
    if (shapes.isEmpty()) return;
 
    KUndo2Command *cmd =
        new KoShapeTransparencyCommand(shapes, 1.0 - newOpacity / 100.0);
 
    d->tool->canvas()->addCommand(cmd);
}

References d.

slotSaturationSliderChanged

void ToolReferenceImagesWidget::slotSaturationSliderChanged ( qreal newSaturation )

privateslot

Definition at line 199 of file ToolReferenceImagesWidget.cpp.

{
    QList<KoShape*> shapes = d->ui->saturationSlider->selection();
    if (shapes.isEmpty()) return;
 
    KUndo2Command *cmd =
            new KisReferenceImage::SetSaturationCommand(shapes, newSaturation / 100.0);
 
    d->tool->canvas()->addCommand(cmd);
}

References d.

slotSaveLocationChanged

void ToolReferenceImagesWidget::slotSaveLocationChanged ( int index )

privateslot

Definition at line 210 of file ToolReferenceImagesWidget.cpp.

{
    KoSelection *selection = d->tool->koSelection();
    QList<KoShape*> shapes = selection->selectedEditableShapes();
 
 
    Q_FOREACH(KoShape *shape, shapes) {
        KisReferenceImage *reference = dynamic_cast<KisReferenceImage*>(shape);
        KIS_SAFE_ASSERT_RECOVER_RETURN(reference);
 
        if (index == 0) { // embed to KRA
            reference->setEmbed(true);
        } else { // link to file
            if (reference->hasLocalFile()) {
                reference->setEmbed(false);
            } else {
                //In the case no local file is found, switch back to embed file data.
                d->ui->referenceImageLocationCombobox->setCurrentIndex(0);
            }
        }
    }
}

References d, KisReferenceImage::hasLocalFile(), KIS_SAFE_ASSERT_RECOVER_RETURN, KoSelection::selectedEditableShapes(), and KisReferenceImage::setEmbed().

updateVisibility()

void ToolReferenceImagesWidget::updateVisibility ( bool hasSelection )

private

Definition at line 239 of file ToolReferenceImagesWidget.cpp.

{
    // hide UI elements if nothing is selected.
    d->ui->referenceImageLocationCombobox->setVisible(hasSelection);
    d->ui->chkKeepAspectRatio->setVisible(hasSelection);
    d->ui->saveLocationLabel->setVisible(hasSelection);
    d->ui->opacitySlider->setVisible(hasSelection);
    d->ui->saturationSlider->setVisible(hasSelection);
    d->ui->bnDeleteSelectedImages->setVisible(hasSelection);
 
    // show a label indicating that a selection is required to show options
    d->ui->referenceImageOptionsLabel->setVisible(!hasSelection);
 
    if (hasSelection) {
        KoSelection* selection = d->tool->koSelection();
        QList<KoShape*> shapes = selection->selectedEditableShapes();
        bool usesLocalFile = true;
 
        Q_FOREACH(KoShape *shape, shapes) {
            KisReferenceImage *reference = dynamic_cast<KisReferenceImage*>(shape);
 
            if (reference) {
                usesLocalFile &= reference->hasLocalFile();
            }
        }
 
        QStandardItemModel* model = dynamic_cast<QStandardItemModel*>(d->ui->referenceImageLocationCombobox->model());
 
        if (model) {
            QStandardItem* item = model->item(1);
            item->setFlags(usesLocalFile ? item->flags() | Qt::ItemIsEnabled :
                                           item->flags() & ~Qt::ItemIsEnabled);
        }
    }
}

References d, KisReferenceImage::hasLocalFile(), and KoSelection::selectedEditableShapes().

Member Data Documentation

d

const QScopedPointer<Private> ToolReferenceImagesWidget::d

private

Definition at line 41 of file ToolReferenceImagesWidget.h.

---

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

• plugins/tools/defaulttool/referenceimagestool/ToolReferenceImagesWidget.h
• plugins/tools/defaulttool/referenceimagestool/ToolReferenceImagesWidget.cpp