TextPropertiesCanvasObserver Class Reference

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	slotCanvasTextPropertiesChanged ()
void	slotTextPropertiesChanged ()

Signals
void	dpiChanged ()
void	hasFocusChanged ()
void	localesChanged ()
void	textPropertiesChanged ()
void	textPropertyConfigChanged ()

Public Member Functions
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
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 40 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->modelToProviderCompressor, SLOT(start()));
    connect(&d->modelToProviderCompressor, SIGNAL(timeout()), this, SLOT(slotTextPropertiesChanged()));
    connect(d->textModel, SIGNAL(textPropertyChanged()),
            this, SIGNAL(textPropertiesChanged()));
}

References connect(), d, locales, slotTextPropertiesChanged(), and textPropertiesChanged().

~TextPropertiesCanvasObserver()

TextPropertiesCanvasObserver::~TextPropertiesCanvasObserver

(

)

Definition at line 60 of file TextPropertiesCanvasObserver.cpp.

{
 
}

Member Function Documentation

applyPreset

void TextPropertiesCanvasObserver::applyPreset ( KoResourceSP resource )

slot

Definition at line 166 of file TextPropertiesCanvasObserver.cpp.

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

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

callModalTextPropertyConfigDialog

void TextPropertiesCanvasObserver::callModalTextPropertyConfigDialog ( )

slot

Definition at line 156 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().

cloneAndEditPreset

void TextPropertiesCanvasObserver::cloneAndEditPreset ( KoResourceSP resource )

slot

Definition at line 214 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 178 of file TextPropertiesCanvasObserver.cpp.

{
    KoCssStylePresetSP preset(new KoCssStylePreset(QString()));
    KoSvgTextPropertyData textData = d->textModel->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, and d.

dpi()

qreal TextPropertiesCanvasObserver::dpi

(

)

const

Definition at line 105 of file TextPropertiesCanvasObserver.cpp.

{
    return d->currentDpi;
}

References d.

dpiChanged

void TextPropertiesCanvasObserver::dpiChanged ( )

signal

editPreset

void TextPropertiesCanvasObserver::editPreset ( KoResourceSP resource )

slot

Definition at line 198 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 125 of file TextPropertiesCanvasObserver.cpp.

{
    return d->hasFocus;
}

References d.

hasFocusChanged

void TextPropertiesCanvasObserver::hasFocusChanged ( )

signal

locales()

QStringList TextPropertiesCanvasObserver::locales

(

)

const

Definition at line 110 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 47 of file TextPropertiesCanvasObserver.h.

{ 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 79 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 130 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 65 of file TextPropertiesCanvasObserver.cpp.

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

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

slotCanvasTextPropertiesChanged

void TextPropertiesCanvasObserver::slotCanvasTextPropertiesChanged ( )

slot

Definition at line 137 of file TextPropertiesCanvasObserver.cpp.

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

References d, and textPropertiesChanged().

slotTextPropertiesChanged

void TextPropertiesCanvasObserver::slotTextPropertiesChanged ( )

slot

Definition at line 147 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 115 of file TextPropertiesCanvasObserver.cpp.

{
    return d->textModel;
}

References d.

textPropertiesChanged

void TextPropertiesCanvasObserver::textPropertiesChanged ( )

signal

textPropertyConfig()

TextPropertyConfigModel * TextPropertiesCanvasObserver::textPropertyConfig

(

)

const

Definition at line 120 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 100 of file TextPropertiesCanvasObserver.cpp.

{
    m_canvas = 0;
}

References m_canvas.

Member Data Documentation

d

const QScopedPointer<Private> TextPropertiesCanvasObserver::d

private

Definition at line 78 of file TextPropertiesCanvasObserver.h.

m_canvas

QPointer<KisCanvas2> TextPropertiesCanvasObserver::m_canvas

private

Definition at line 79 of file TextPropertiesCanvasObserver.h.

Property Documentation

dpi

qreal TextPropertiesCanvasObserver::dpi

read

Definition at line 31 of file TextPropertiesCanvasObserver.h.

hasFocus

bool TextPropertiesCanvasObserver::hasFocus

readwrite

Definition at line 42 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 34 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