The TextPropertiesCanvasObserver class. More...

#include <TextPropertiesCanvasObserver.h>

Inheritance diagram for TextPropertiesCanvasObserver:

Classes
struct	Private

Public Slots
void	applyPreset (KoResourceSP resource)

void	callModalTextPropertyConfigDialog ()

void	cloneAndEditPreset (KoResourceSP resource)

bool	createNewPresetFromSettings ()

void	editPreset (KoResourceSP resource)

void	slotCanvasCharacterPropertiesChanged ()

void	slotCanvasTextPropertiesChanged ()

void	slotCharacterPropertiesChanged ()

void	slotTextPropertiesChanged ()

Signals
void	characterPropertiesChanged ()

void	dpiChanged ()

void	hasFocusChanged ()

void	localesChanged ()

void	textPropertiesChanged ()

void	textPropertyConfigChanged ()

Public Member Functions
KoSvgTextPropertiesModel *	characterProperties () const

qreal	dpi () const

bool	hasFocus () const

QStringList	locales () const

QString	observerName () override

void	setCanvas (KoCanvasBase *canvas) override

void	setHasFocus (const bool focus)

void	setViewManager (KisViewManager *kisview) override

KoSvgTextPropertiesModel *	textProperties () const

	TextPropertiesCanvasObserver (QObject *parent=nullptr)

TextPropertyConfigModel *	textPropertyConfig () const

void	unsetCanvas () override

	~TextPropertiesCanvasObserver ()

Public Member Functions inherited from KisMainwindowObserver
	KisMainwindowObserver ()

	~KisMainwindowObserver () override

Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()

KoCanvasBase *	observedCanvas () const

void	setObservedCanvas (KoCanvasBase *canvas)

void	unsetObservedCanvas ()

virtual	~KoCanvasObserverBase ()

Properties
KoSvgTextPropertiesModel *	characterProperties

qreal	dpi

bool	hasFocus

dpiChangedQStringList	locales

localesChangedKoSvgTextPropertiesModel *	textProperties

TextPropertyConfigModel *	textPropertyConfig

Private Attributes
const QScopedPointer< Private >	d

QPointer< KisCanvas2 >	m_canvas

Additional Inherited Members

Detailed Description

The TextPropertiesCanvasObserver class.

This splits out the canvas observer tasks from the docker into it's own QObject, so that it may be instantiated inside QML.

The benefit of this is that we'll have to do way less manipulating of the rootobject on the quickwidget if we want to communicate properties between qml and cpp. Given that the rootobject only exists when the qml successfully loads, this should require way less checks.

Definition at line 28 of file TextPropertiesCanvasObserver.h.

Constructor & Destructor Documentation

◆ TextPropertiesCanvasObserver()

TextPropertiesCanvasObserver::TextPropertiesCanvasObserver ( QObject * parent = nullptr )

explicit

Definition at line 43 of file TextPropertiesCanvasObserver.cpp.

    : QObject(parent)
    , d(new Private(this))
{
    d->textPropertyConfigModel = new TextPropertyConfigModel(this);
    QList<QLocale> locales;
    QStringList wellFormedBCPNames;
    Q_FOREACH (const QString langCode, KLocalizedString::languages()) {
        locales.append(QLocale(langCode));
        wellFormedBCPNames.append(langCode.split("_").join("-"));
    }
    d->locales = wellFormedBCPNames;
 
    connect(d->textModel, SIGNAL(textPropertyChanged()),
            &d->textToProviderCompressor, SLOT(start()));
    connect(d->characterModel, SIGNAL(textPropertyChanged()),
            &d->characterToProviderCompressor, SLOT(start()));
    connect(&d->textToProviderCompressor, SIGNAL(timeout()), this, SLOT(slotTextPropertiesChanged()));
    connect(&d->characterToProviderCompressor, SIGNAL(timeout()), this, SLOT(slotCharacterPropertiesChanged()));
    connect(d->textModel, SIGNAL(textPropertyChanged()),
            this, SIGNAL(textPropertiesChanged()));
    connect(d->characterModel, SIGNAL(textPropertyChanged()),
            this, SIGNAL(characterPropertiesChanged()));
}

References characterPropertiesChanged(), d, locales, slotCharacterPropertiesChanged(), slotTextPropertiesChanged(), and textPropertiesChanged().

◆ ~TextPropertiesCanvasObserver()

TextPropertiesCanvasObserver::~TextPropertiesCanvasObserver ( )

Definition at line 68 of file TextPropertiesCanvasObserver.cpp.

{
 
}

Member Function Documentation

◆ applyPreset

void TextPropertiesCanvasObserver::applyPreset ( KoResourceSP resource )

slot

Definition at line 203 of file TextPropertiesCanvasObserver.cpp.

{
    KoCssStylePresetSP preset = resource.staticCast<KoCssStylePreset>();
    if (!preset) return;
    KoSvgTextPropertiesModel *model = d->characterModel->enabled() && d->characterModel->spanSelection()? d->characterModel: d->textModel;
    KoSvgTextPropertyData textData = model->textData.get();
    KoSvgTextProperties properties = preset->properties(d->currentDpi, true);
    Q_FOREACH(KoSvgTextProperties::PropertyId p, properties.properties()) {
        textData.commonProperties.setProperty(p, properties.property(p));
    }
    model->textData.set(textData);
}

References KoSvgTextPropertyData::commonProperties, d, p, KoSvgTextProperties::properties(), KoSvgTextProperties::property(), KoSvgTextProperties::setProperty(), and KoSvgTextPropertiesModel::textData.

◆ callModalTextPropertyConfigDialog

void TextPropertiesCanvasObserver::callModalTextPropertyConfigDialog ( )

slot

Definition at line 193 of file TextPropertiesCanvasObserver.cpp.

{
    TextPropertyConfigDialog dialog(qApp->activeWindow());
    dialog.setTextPropertyConfigModel(d->textPropertyConfigModel);
    if (dialog.exec() == QDialog::Accepted) {
        dialog.model()->saveConfiguration();
        Q_EMIT textPropertyConfigChanged();
    }
}

References d, and textPropertyConfigChanged().

◆ characterProperties()

KoSvgTextPropertiesModel * TextPropertiesCanvasObserver::characterProperties ( ) const

Definition at line 133 of file TextPropertiesCanvasObserver.cpp.

{
    return d->characterModel;
}

References d.

◆ characterPropertiesChanged

void TextPropertiesCanvasObserver::characterPropertiesChanged ( )

signal

◆ cloneAndEditPreset

void TextPropertiesCanvasObserver::cloneAndEditPreset ( KoResourceSP resource )

slot

Definition at line 253 of file TextPropertiesCanvasObserver.cpp.

{
    KoResourceSP newResource = resource->clone();
    KoCssStylePresetSP preset = newResource.staticCast<KoCssStylePreset>();
    if (!preset) return;
 
    CssStylePresetEditDialog *dialog = new CssStylePresetEditDialog(qApp->activeWindow());
    dialog->setCurrentResource(preset);
 
    if (dialog->exec() == QDialog::Accepted) {
        preset = dialog->currentResource();
        preset->setFilename(preset->name().replace(' ', '_').replace('.', '_') + preset->defaultFileExtension());
        KisResourceUserOperations::addResourceWithUserInput(qApp->activeWindow(), preset);
    }
}

References KisResourceUserOperations::addResourceWithUserInput().

◆ createNewPresetFromSettings

bool TextPropertiesCanvasObserver::createNewPresetFromSettings ( )

slot

Definition at line 216 of file TextPropertiesCanvasObserver.cpp.

{
    KoCssStylePresetSP preset(new KoCssStylePreset(QString()));
    KoSvgTextPropertiesModel *model = d->characterModel->enabled() && d->characterModel->spanSelection()? d->characterModel: d->textModel;
    KoSvgTextPropertyData textData = model->textData.get();
    preset->setProperties(textData.commonProperties);
    preset->setName(i18nc("@info:placeholder", "New Style Preset"));
    preset->setStyleType("character");
    preset->updateThumbnail();
 
    CssStylePresetEditDialog *dialog = new CssStylePresetEditDialog(qApp->activeWindow());
    dialog->setDpi(d->currentDpi);
    dialog->setCurrentResource(preset);
 
    if (dialog->exec() == QDialog::Accepted) {
        return KisResourceUserOperations::addResourceWithUserInput(qApp->activeWindow(), dialog->currentResource());
    }
 
    return false;
}

References KisResourceUserOperations::addResourceWithUserInput(), KoSvgTextPropertyData::commonProperties, d, and KoSvgTextPropertiesModel::textData.

◆ dpi()

qreal TextPropertiesCanvasObserver::dpi ( ) const

Definition at line 118 of file TextPropertiesCanvasObserver.cpp.

{
    return d->currentDpi;
}

References d.

◆ dpiChanged

void TextPropertiesCanvasObserver::dpiChanged ( )

signal

◆ editPreset

void TextPropertiesCanvasObserver::editPreset ( KoResourceSP resource )

slot

Definition at line 237 of file TextPropertiesCanvasObserver.cpp.

{
    KoCssStylePresetSP preset = resource.staticCast<KoCssStylePreset>();
    if (!preset) return;
 
    CssStylePresetEditDialog *dialog = new CssStylePresetEditDialog(qApp->activeWindow());
    dialog->setCurrentResource(preset);
 
    if (dialog->exec() == QDialog::Accepted) {
        KisResourceUserOperations::updateResourceWithUserInput(qApp->activeWindow(), dialog->currentResource());
    } else {
        KisResourceModel model = KisResourceModel(ResourceType::CssStyles, qApp->activeWindow());
        model.reloadResource(preset);
    }
}

References ResourceType::CssStyles, KisResourceModel::reloadResource(), and KisResourceUserOperations::updateResourceWithUserInput().

◆ hasFocus()

bool TextPropertiesCanvasObserver::hasFocus ( ) const

Definition at line 143 of file TextPropertiesCanvasObserver.cpp.

{
    return d->hasFocus;
}

References d.

◆ hasFocusChanged

void TextPropertiesCanvasObserver::hasFocusChanged ( )

signal

◆ locales()

QStringList TextPropertiesCanvasObserver::locales ( ) const

Definition at line 123 of file TextPropertiesCanvasObserver.cpp.

{
    return d->locales;
}

References d.

◆ localesChanged

void TextPropertiesCanvasObserver::localesChanged ( )

signal

◆ observerName()

QString TextPropertiesCanvasObserver::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 48 of file TextPropertiesCanvasObserver.h.

48{ return "TextPropertiesCanvasObserver"; }

◆ setCanvas()

void TextPropertiesCanvasObserver::setCanvas ( KoCanvasBase * canvas )

overridevirtual

re-implement this method in your canvas observer. It will be called whenever a canvas becomes active. Note that you are responsible for not connecting more than one time to the signals of a canvas or any of the QObjects you can access through the canvas.

Implements KoCanvasObserverBase.

Definition at line 92 of file TextPropertiesCanvasObserver.cpp.

{
    //setEnabled(true);
 
    if (m_canvas == canvas) {
        return;
    }
 
    if (m_canvas) {
        m_canvas->disconnectCanvasObserver(this);
    }
 
    KIS_ASSERT(canvas);
 
    m_canvas = dynamic_cast<KisCanvas2*>(canvas);
    if (m_canvas && m_canvas->currentImage()) {
        d->currentDpi = m_canvas->currentImage()->xRes() * 72.0;
        Q_EMIT dpiChanged();
    }
}

References d, dpiChanged(), KIS_ASSERT, and m_canvas.

◆ setHasFocus()

void TextPropertiesCanvasObserver::setHasFocus ( const bool focus )

Definition at line 148 of file TextPropertiesCanvasObserver.cpp.

{
    if (d->hasFocus == focus) return;
    d->hasFocus = focus;
    Q_EMIT hasFocusChanged();
}

References d, and hasFocusChanged().

◆ setViewManager()

void TextPropertiesCanvasObserver::setViewManager ( KisViewManager * kisview )

overridevirtual

Implements KisMainwindowObserver.

Definition at line 73 of file TextPropertiesCanvasObserver.cpp.

{
    d->provider = kisview->canvasResourceProvider();
    if (d->provider) {
        connect(d->provider, SIGNAL(sigTextPropertiesChanged()),
                this, SLOT(slotCanvasTextPropertiesChanged()));
        connect(d->provider, SIGNAL(sigCharacterPropertiesChanged()),
                this, SLOT(slotCanvasCharacterPropertiesChanged()));
 
        // This initializes the docker to an empty entry;
        KoSvgTextPropertyData textData;
        textData.inheritedProperties = KoSvgTextProperties();
        textData.enabled = true;
        d->provider->setTextPropertyData(textData);
        textData.enabled = false;
        d->provider->setCharacterPropertyData(textData);
    }
}

References KisViewManager::canvasResourceProvider(), d, KoSvgTextPropertyData::enabled, KoSvgTextPropertyData::inheritedProperties, slotCanvasCharacterPropertiesChanged(), and slotCanvasTextPropertiesChanged().

◆ slotCanvasCharacterPropertiesChanged

void TextPropertiesCanvasObserver::slotCanvasCharacterPropertiesChanged ( )

slot

Definition at line 165 of file TextPropertiesCanvasObserver.cpp.

{
    KoSvgTextPropertyData data = d->provider->characterTextPropertyData();
    const bool shouldSet = d->hasFocus? !d->characterToProviderCompressor.isActive(): true;
    if (d->characterModel->textData.get() != data && shouldSet) {
        d->characterModel->textData.set(data);
        Q_EMIT characterPropertiesChanged();
    }
}

References characterPropertiesChanged(), and d.

◆ slotCanvasTextPropertiesChanged

void TextPropertiesCanvasObserver::slotCanvasTextPropertiesChanged ( )

slot

Definition at line 155 of file TextPropertiesCanvasObserver.cpp.

{
    KoSvgTextPropertyData data = d->provider->textPropertyData();
    const bool shouldSet = d->hasFocus? !d->textToProviderCompressor.isActive(): true;
    if (d->textModel->textData.get() != data && shouldSet) {
        d->textModel->textData.set(data);
        Q_EMIT textPropertiesChanged();
    }
}

References d, and textPropertiesChanged().

◆ slotCharacterPropertiesChanged

void TextPropertiesCanvasObserver::slotCharacterPropertiesChanged ( )

slot

Definition at line 184 of file TextPropertiesCanvasObserver.cpp.

{
    KoSvgTextPropertyData characterData = d->characterModel->textData.get();
    debugFlake << Q_FUNC_INFO << characterData;
    if (d->provider && d->provider->characterTextPropertyData() != characterData) {
        d->provider->setCharacterPropertyData(characterData);
    }
}

References d, and debugFlake.

◆ slotTextPropertiesChanged

void TextPropertiesCanvasObserver::slotTextPropertiesChanged ( )

slot

Definition at line 175 of file TextPropertiesCanvasObserver.cpp.

{
    KoSvgTextPropertyData textData = d->textModel->textData.get();
    debugFlake << Q_FUNC_INFO << textData;
    if (d->provider && d->provider->textPropertyData() != textData) {
        d->provider->setTextPropertyData(textData);
    }
}

References d, and debugFlake.

◆ textProperties()

KoSvgTextPropertiesModel * TextPropertiesCanvasObserver::textProperties ( ) const

Definition at line 128 of file TextPropertiesCanvasObserver.cpp.

{
    return d->textModel;
}

References d.

◆ textPropertiesChanged

void TextPropertiesCanvasObserver::textPropertiesChanged ( )

signal

◆ textPropertyConfig()

TextPropertyConfigModel * TextPropertiesCanvasObserver::textPropertyConfig ( ) const

Definition at line 138 of file TextPropertiesCanvasObserver.cpp.

{
    return d->textPropertyConfigModel;
}

References d.

◆ textPropertyConfigChanged

void TextPropertiesCanvasObserver::textPropertyConfigChanged ( )

signal

◆ unsetCanvas()

void TextPropertiesCanvasObserver::unsetCanvas ( )

overridevirtual

Re-implement to notify the observer that its canvas is no longer among the living. The daisies, it is pushing up. This means you don't have to disconnect, it's dead.

The old canvas should be deleted already, so if you stored a pointer to it, don't touch!

Note that currently there is a bug where in certain specific circumstances unsetCanvas can be called when it shouldn't, see for example KWStatisticsDocker for a workaround for this problem.

Implements KoCanvasObserverBase.

Definition at line 113 of file TextPropertiesCanvasObserver.cpp.

{
    m_canvas = 0;
}

References m_canvas.

Member Data Documentation

◆ d

const QScopedPointer<Private> TextPropertiesCanvasObserver::d

private

Definition at line 83 of file TextPropertiesCanvasObserver.h.

◆ m_canvas

QPointer<KisCanvas2> TextPropertiesCanvasObserver::m_canvas

private

Definition at line 84 of file TextPropertiesCanvasObserver.h.

Property Documentation

◆ characterProperties

KoSvgTextPropertiesModel * TextPropertiesCanvasObserver::characterProperties

read

Definition at line 34 of file TextPropertiesCanvasObserver.h.

◆ dpi

qreal TextPropertiesCanvasObserver::dpi

read

Definition at line 31 of file TextPropertiesCanvasObserver.h.

◆ hasFocus

bool TextPropertiesCanvasObserver::hasFocus

readwrite

Definition at line 43 of file TextPropertiesCanvasObserver.h.

◆ locales

dpiChangedQStringList TextPropertiesCanvasObserver::locales

read

Definition at line 32 of file TextPropertiesCanvasObserver.h.

◆ textProperties

localesChangedKoSvgTextPropertiesModel * TextPropertiesCanvasObserver::textProperties

read

Definition at line 33 of file TextPropertiesCanvasObserver.h.

◆ textPropertyConfig

TextPropertyConfigModel * TextPropertiesCanvasObserver::textPropertyConfig

read

Definition at line 35 of file TextPropertiesCanvasObserver.h.

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

plugins/dockers/textproperties/TextPropertiesCanvasObserver.h
plugins/dockers/textproperties/TextPropertiesCanvasObserver.cpp

Classes

Public Slots

Signals

Public Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextPropertiesCanvasObserver()

◆ ~TextPropertiesCanvasObserver()

Member Function Documentation

◆ applyPreset

◆ callModalTextPropertyConfigDialog

◆ characterProperties()

◆ characterPropertiesChanged

◆ cloneAndEditPreset

◆ createNewPresetFromSettings

◆ dpi()

◆ dpiChanged

◆ editPreset

◆ hasFocus()

◆ hasFocusChanged

◆ locales()

◆ localesChanged

◆ observerName()

◆ setCanvas()

◆ setHasFocus()

◆ setViewManager()

◆ slotCanvasCharacterPropertiesChanged

◆ slotCanvasTextPropertiesChanged

◆ slotCharacterPropertiesChanged

◆ slotTextPropertiesChanged

◆ textProperties()

◆ textPropertiesChanged

◆ textPropertyConfig()

◆ textPropertyConfigChanged

◆ unsetCanvas()

Member Data Documentation

◆ d

◆ m_canvas

Property Documentation

◆ characterProperties

◆ dpi

◆ hasFocus

◆ locales

◆ textProperties

◆ textPropertyConfig