KisDlgImageProperties Class Reference

#include <kis_dlg_image_properties.h>

Inheritance diagram for KisDlgImageProperties:

Classes
struct	Private

Public Member Functions
const KoColorSpace *	colorSpace () const
bool	convertLayerPixels () const
virtual int	exec () override
	KisDlgImageProperties (KisImageWSP image, KisDisplayColorConverter *colorConverter, QWidget *parent=0, const char *name=0)
	~KisDlgImageProperties () override
Public Member Functions inherited from KoDialog
QPushButton *	button (ButtonCode id) const
QIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
	KoDialog (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())
QWidget *	mainWidget ()
QSize	minimumSizeHint () const override
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const QIcon &icon)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
QSize	sizeHint () const override
	~KoDialog () override

Private Slots
void	setAnnotation (const QString &type)
void	setCurrentColor ()
void	setProofingConfigToImage ()
void	slotCalculateLightLevels ()
void	slotColorSpaceChanged (const KoColorSpace *)
void	updateDisplayConfigInfo ()

Private Attributes
QScopedPointer< Private >	d
WdgImageProperties *	m_page

Additional Inherited Members
Public Types inherited from KoDialog
enum	ButtonCode {   None = 0x00000000 , Help = 0x00000001 , Default = 0x00000002 , Ok = 0x00000004 ,   Apply = 0x00000008 , Try = 0x00000010 , Cancel = 0x00000020 , Close = 0x00000040 ,   No = 0x00000080 , Yes = 0x00000100 , Reset = 0x00000200 , Details = 0x00000400 ,   User1 = 0x00001000 , User2 = 0x00002000 , User3 = 0x00004000 , NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0 , DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0 , AppNameCaption = 1 , ModifiedCaption = 2 , HIGCompliantCaption = AppNameCaption }
Public Slots inherited from KoDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)
Signals inherited from KoDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KoDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()
Static Public Member Functions inherited from KoDialog
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static int	spacingHint ()
Protected Slots inherited from KoDialog
virtual void	slotButtonClicked (int button)
Protected Member Functions inherited from KoDialog
void	closeEvent (QCloseEvent *e) override
void	hideEvent (QHideEvent *) override
void	keyPressEvent (QKeyEvent *) override
void	showEvent (QShowEvent *e) override

Detailed Description

Definition at line 26 of file kis_dlg_image_properties.h.

Constructor & Destructor Documentation

KisDlgImageProperties()

KisDlgImageProperties::KisDlgImageProperties	(	KisImageWSP	image,
		KisDisplayColorConverter *	colorConverter,
		QWidget *	parent = 0,
		const char *	name = 0 )

Definition at line 60 of file kis_dlg_image_properties.cc.

    : KoDialog(parent)
    , d(new Private(colorConverter))
{
    setButtons(Ok | Cancel);
    setDefaultButton(Ok);
    setObjectName(name);
    setCaption(i18n("Image Properties"));
    m_page = new WdgImageProperties(this);
 
    d->image = image;
 
    setMainWidget(m_page);
    resize(m_page->sizeHint());
 
    m_page->lblWidthValue->setText(QString::number(image->width()));
    m_page->lblHeightValue->setText(QString::number(image->height()));
    m_page->lblLayerCount->setText(QString::number(image->nChildLayers()));
 
    m_page->lblResolutionValue->setText(QLocale().toString(image->xRes()*72, 2)); // XXX: separate values for x & y?
 
    //Set the canvas projection color:    backgroundColor
    KoColor background = d->image->defaultProjectionColor();
    background.setOpacity(1.0);
    m_page->bnBackgroundColor->setColor(background);
    m_page->sldBackgroundColor->setRange(0.0,1.0,2);
    m_page->sldBackgroundColor->setSingleStep(0.05);
    m_page->sldBackgroundColor->setValue(d->image->defaultProjectionColor().opacityF());
 
    connect(m_page->bnBackgroundColor, SIGNAL(changed(KoColor)), &d->compressor, SLOT(start()));
    connect(m_page->sldBackgroundColor, SIGNAL(valueChanged(qreal)), &d->compressor, SLOT(start()));
    connect(&d->compressor, SIGNAL(timeout()), this, SLOT(setCurrentColor()));
 
    //Set the color space
    m_page->colorSpaceSelector->setCurrentColorSpace(image->colorSpace());
    m_page->chkConvertLayers->setChecked(KisConfig(true).convertLayerColorSpaceInProperties());
 
    // fetch the proofing space
    KisProofingConfigurationSP config = d->image->proofingConfiguration();
    const bool hasImageLocalConfig = bool(config);
 
    if (config) {
        // create a copy of the original config
        d->originalProofingConfig.reset(new KisProofingConfiguration(*config));
    } else {
        config = KisImageConfig(true).defaultProofingconfiguration();
    }
 
    // enable proofing config widgets only when the image has its
    // own config
    m_page->chkSaveProofing->setChecked(hasImageLocalConfig);
    connect(m_page->chkSaveProofing, &QCheckBox::toggled,
        m_page->wdgProofingOptions, &KisProofingOptionsWidget::setEnabled);
    m_page->wdgProofingOptions->setEnabled(m_page->chkSaveProofing->isChecked());
 
    // we should reset to the global settings when when the checkbox
    // is toggled
    connect(m_page->chkSaveProofing, &QCheckBox::toggled,
        this, &KisDlgImageProperties::setProofingConfigToImage);
 
    // initialize the proofing configuration widget
    m_page->wdgProofingOptions->setProofingConfig(config);
    connect(d->colorConverter, SIGNAL(displayConfigurationChanged()), this, SLOT(updateDisplayConfigInfo()));
    updateDisplayConfigInfo();
 
    connect(m_page->wdgProofingOptions,
            &KisProofingOptionsWidget::sigProofingConfigChanged,
            this,
            &KisDlgImageProperties::setProofingConfigToImage);
 
    d->hdrMetadataModel.setImageProfileHdrReferenceWhite(d->image->colorSpace()->profile()->hdrReferenceWhite());
    d->hdrMetadataModel.setImageHdrReferenceWhiteMetadata(d->image->hdrReferenceWhiteLightLevel());
    d->hdrMetadataModel.setClli(d->image->relativeContentLightLevelInformation());
    d->hdrMetadataModel.setCvi(d->image->colorVolumeInformation());
    connect(m_page->btnCalculateClli, &QPushButton::clicked, this, &KisDlgImageProperties::slotCalculateLightLevels);
 
    KisWidgetConnectionUtils::connectControlState( m_page->cmbHdrReferenceWhite,  &d->hdrMetadataModel, "referenceWhiteState", "referenceWhiteIndex");
 
    KisWidgetConnectionUtils::connectControlState( m_page->gbxHdrReferenceWhite,  &d->hdrMetadataModel, "referenceWhitePresentState", "referenceWhitePresent");
 
    KisWidgetConnectionUtils::connectControlState( m_page->gbxContentLightLevel,  &d->hdrMetadataModel, "clliPresentState", "clliPresent");
    KisWidgetConnectionUtils::connectControl( m_page->spnMaxCll,  &d->hdrMetadataModel, "maxContentLightLevel");
    KisWidgetConnectionUtils::connectControl( m_page->spnMaxFall,  &d->hdrMetadataModel, "maxFrameAverageLightLevel");
    KisWidgetConnectionUtils::connectControlState( m_page->cmbLumiCalcType,  &d->hdrMetadataModel, "clliCalculationTypeState", "clliCalculationType");
 
    KisWidgetConnectionUtils::connectControl( m_page->gbxColorVolume, &d->hdrMetadataModel, "cviPresent");
 
    KisWidgetConnectionUtils::connectControl( m_page->spnWhiteX, &d->hdrMetadataModel, "cviWhiteX");
    KisWidgetConnectionUtils::connectControl( m_page->spnWhiteY, &d->hdrMetadataModel, "cviWhiteY");
    KisWidgetConnectionUtils::connectControl( m_page->spnRedX, &d->hdrMetadataModel, "cviRedX");
    KisWidgetConnectionUtils::connectControl( m_page->spnRedY, &d->hdrMetadataModel, "cviRedY");
    KisWidgetConnectionUtils::connectControl( m_page->spnGreenX, &d->hdrMetadataModel, "cviGreenX");
    KisWidgetConnectionUtils::connectControl( m_page->spnGreenY, &d->hdrMetadataModel, "cviGreenY");
    KisWidgetConnectionUtils::connectControl( m_page->spnBlueX, &d->hdrMetadataModel, "cviBlueX");
    KisWidgetConnectionUtils::connectControl( m_page->spnBlueY, &d->hdrMetadataModel, "cviBlueY");
    KisWidgetConnectionUtils::connectControl( m_page->spnMinLuminance, &d->hdrMetadataModel, "cviMinLuminance");
    KisWidgetConnectionUtils::connectControl( m_page->spnMaxLuminance, &d->hdrMetadataModel, "cviMaxLuminance");
 
    KisWidgetConnectionUtils::connectControlState( m_page->cmbColorVolumePresets, &d->hdrMetadataModel, "cviEffectivePresetIndexState", "cviEffectivePresetIndex");
 
    const bool hdr = d->image->colorSpace()->hasHighDynamicRange() ||
                     d->image->colorSpace()->profile()->getTransferCharacteristics() == TRC_ITU_R_BT_2100_0_PQ;
    m_page->grpHdrMeta->setEnabled(hdr);
 
    //annotations
    vKisAnnotationSP_it beginIt = image->beginAnnotations();
    vKisAnnotationSP_it endIt = image->endAnnotations();
 
    vKisAnnotationSP_it it = beginIt;
    while (it != endIt) {
 
        if (!(*it) || (*it)->type().isEmpty()) {
            dbgFile << "Warning: empty annotation";
            it++;
            continue;
        }
 
        m_page->cmbAnnotations->addItem((*it)->type());
        it++;
    }
    connect(m_page->cmbAnnotations, SIGNAL(textActivated(QString)), SLOT(setAnnotation(QString)));
    setAnnotation(m_page->cmbAnnotations->currentText());
 
    connect(m_page->colorSpaceSelector,
            SIGNAL(colorSpaceChanged(const KoColorSpace*)),
            SLOT(slotColorSpaceChanged(const KoColorSpace*)));
    slotColorSpaceChanged(d->image->colorSpace());
}

References KisImage::beginAnnotations(), KoDialog::Cancel, KisImage::colorSpace(), KisWidgetConnectionUtils::connectControl(), KisWidgetConnectionUtils::connectControlState(), d, dbgFile, KisImageConfig::defaultProofingconfiguration(), KisImage::endAnnotations(), KisImage::height(), m_page, KisImage::nChildLayers(), KoDialog::Ok, setAnnotation(), KoDialog::setButtons(), KoDialog::setCaption(), setCurrentColor(), KoDialog::setDefaultButton(), KoDialog::setMainWidget(), KoColor::setOpacity(), setProofingConfigToImage(), KisProofingOptionsWidget::sigProofingConfigChanged(), slotCalculateLightLevels(), slotColorSpaceChanged(), TRC_ITU_R_BT_2100_0_PQ, updateDisplayConfigInfo(), KisImage::width(), and KisImage::xRes().

~KisDlgImageProperties()

KisDlgImageProperties::~KisDlgImageProperties ( )

override

Definition at line 189 of file kis_dlg_image_properties.cc.

{
    if (d->compressor.isActive()) {
        d->compressor.stop();
        setCurrentColor();
    }
 
    delete m_page;
}

References d, m_page, and setCurrentColor().

Member Function Documentation

colorSpace()

const KoColorSpace * KisDlgImageProperties::colorSpace

(

)

const

Definition at line 246 of file kis_dlg_image_properties.cc.

{
    return m_page->colorSpaceSelector->currentColorSpace();
}

References m_page.

convertLayerPixels()

bool KisDlgImageProperties::convertLayerPixels

(

)

const

Definition at line 241 of file kis_dlg_image_properties.cc.

{
    return m_page->chkConvertLayers->isChecked();
}

References m_page.

exec()

int KisDlgImageProperties::exec ( )

overridevirtual

Definition at line 199 of file kis_dlg_image_properties.cc.

{
    int resultCode = KoDialog::exec();
 
    m_page->wdgProofingOptions->stopPendingUpdates();
 
    if (resultCode == QDialog::Accepted) {
        if (m_page->chkSaveProofing->isChecked()) {
            d->image->setProofingConfiguration(m_page->wdgProofingOptions->currentProofingConfig());
        } else {
            d->image->setProofingConfiguration(nullptr);
        }
 
        std::optional<double> effectiveHdrReferenceWhite = d->hdrMetadataModel.effectiveReferenceWhite();
        std::optional<KisRelativeContentLightLevelInformation> effectiveClli;
        std::optional<KisColorVolumeInformation> effectiveCvi;
 
        if (d->hdrMetadataModel.effectiveClliPresent()) {
            effectiveClli = d->hdrMetadataModel.clliData.get();
        }
 
        if (d->hdrMetadataModel.cviPresent()) {
            effectiveCvi = d->hdrMetadataModel.cviData.get();
        }
 
        if (effectiveHdrReferenceWhite != d->image->hdrReferenceWhiteLightLevel() ||
            effectiveClli != d->image->relativeContentLightLevelInformation() ||
            effectiveCvi != d->image->colorVolumeInformation()) {
 
            KUndo2Command *cmd = new KisChangeImageHdrMetadataCommand(d->image, effectiveHdrReferenceWhite, effectiveClli, effectiveCvi);
            KisProcessingApplicator::runSingleCommandStroke(d->image, cmd);
        }
    } else {
        d->image->setProofingConfiguration(d->originalProofingConfig);
    }
 
    KisConfig cfg(false);
    cfg.setConvertLayerColorSpaceInProperties(m_page->chkConvertLayers->isChecked());
 
    return resultCode;
}

References d, m_page, KisProcessingApplicator::runSingleCommandStroke(), and KisConfig::setConvertLayerColorSpaceInProperties().

setAnnotation

void KisDlgImageProperties::setAnnotation ( const QString & type )

privateslot

Definition at line 319 of file kis_dlg_image_properties.cc.

{
    KisAnnotationSP annotation = d->image->annotation(type);
    if (annotation) {
        m_page->lblDescription->clear();
        m_page->txtAnnotation->clear();
        m_page->lblDescription->setText(annotation->description());
        m_page->txtAnnotation->appendPlainText(annotation->displayText());
    }
    else {
        m_page->lblDescription->clear();
        m_page->txtAnnotation->clear();
    }
}

References d, and m_page.

setCurrentColor

void KisDlgImageProperties::setCurrentColor ( )

privateslot

Definition at line 251 of file kis_dlg_image_properties.cc.

{
    KoColor background = m_page->bnBackgroundColor->color();
    background.setOpacity(m_page->sldBackgroundColor->value());
    KisLayerUtils::changeImageDefaultProjectionColor(d->image, background);
}

References KisLayerUtils::changeImageDefaultProjectionColor(), d, m_page, and KoColor::setOpacity().

setProofingConfigToImage

void KisDlgImageProperties::setProofingConfigToImage ( )

privateslot

Definition at line 258 of file kis_dlg_image_properties.cc.

{
    if (m_page->chkSaveProofing->isChecked()) {
        d->image->setProofingConfiguration(m_page->wdgProofingOptions->currentProofingConfig());
    } else {
        d->image->setProofingConfiguration(nullptr);
    }
}

References d, and m_page.

slotCalculateLightLevels

void KisDlgImageProperties::slotCalculateLightLevels ( )

privateslot

Definition at line 272 of file kis_dlg_image_properties.cc.

{
    KisRelativeContentLightLevelInformation::CalculationType type = d->hdrMetadataModel.clliCalculationType();
    KisSharedPtr<KisContentLightLevelProcessingVistor> visitor =
            new KisContentLightLevelProcessingVistor(type, d->image->bounds());
 
    KisProcessingApplicator::ProcessingFlags flags =
        KisProcessingApplicator::RECURSIVE_FRAME_TIMES | KisProcessingApplicator::READ_ONLY_ACTION;
    KisProcessingApplicator applicator(d->image, d->image->rootLayer(), flags);
 
    applicator.applyVisitorAllFrames(visitor);
 
    // a poor-man implementation of a QFuture (which is Qt6-only),
    // the proxy object will notify us manually when the visitor
    // has completed its execution
    QSharedPointer<FunctionToSignalProxy> completionSignalProxy(new FunctionToSignalProxy);
    connect(completionSignalProxy.get(), &FunctionToSignalProxy::timeout, this,
        [visitor, model = &d->hdrMetadataModel, image = d->image]() {
            auto info = visitor->contentLightLevelInformation();
 
            model->setClli(info);
        });
 
    // add the command **after** the signal has been set up; this
    // is not a QFuture, so it cannot store the actual "finished"
    // state
    applicator.applyCommand(new KisCommandUtils::LambdaCommand([completionSignalProxy]() {
        completionSignalProxy->start();
        return nullptr;
    }));
 
    applicator.end();
}

References KisProcessingApplicator::applyCommand(), KisProcessingApplicator::applyVisitorAllFrames(), d, KisProcessingApplicator::end(), KisProcessingApplicator::READ_ONLY_ACTION, KisProcessingApplicator::RECURSIVE_FRAME_TIMES, and FunctionToSignalProxy::timeout().

slotColorSpaceChanged

void KisDlgImageProperties::slotColorSpaceChanged ( const KoColorSpace * cs )

privateslot

Definition at line 306 of file kis_dlg_image_properties.cc.

{
    if (*d->image->profile() != *cs->profile() &&
        !KisLayerUtils::canChangeImageProfileInvisibly(d->image)) {
 
        m_page->wdgWarningNotice->setVisible(true);
        m_page->wdgWarningNotice->setText(
                    m_page->wdgWarningNotice->changeImageProfileWarningText());
    } else {
        m_page->wdgWarningNotice->setVisible(false);
    }
}

References KisLayerUtils::canChangeImageProfileInvisibly(), d, m_page, and KoColorSpace::profile().

updateDisplayConfigInfo

void KisDlgImageProperties::updateDisplayConfigInfo ( )

privateslot

Definition at line 267 of file kis_dlg_image_properties.cc.

{
    m_page->wdgProofingOptions->setDisplayConfigOptions(d->colorConverter->conversionOptions());
}

References d, and m_page.

Member Data Documentation

d

QScopedPointer<Private> KisDlgImageProperties::d

private

Definition at line 54 of file kis_dlg_image_properties.h.

m_page

WdgImageProperties* KisDlgImageProperties::m_page

private

Definition at line 55 of file kis_dlg_image_properties.h.

---

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

• libs/ui/dialogs/kis_dlg_image_properties.h
• libs/ui/dialogs/kis_dlg_image_properties.cc