DefaultToolTextPropertiesInterface Class Reference

Interface to interact with the text property manager. More...

#include <DefaultTool.h>

Inheritance diagram for DefaultToolTextPropertiesInterface:

Public Slots
void	slotSelectionChanged ()

Public Member Functions
virtual bool	characterPropertiesEnabled () override
	Whether character selections are possible at all.
void	clearSelection ()
	DefaultToolTextPropertiesInterface (DefaultTool *parent)
virtual QList< KoSvgTextProperties >	getCharacterProperties () override
	getSelectedProperties
virtual KoSvgTextProperties	getInheritedProperties () override
	getInheritedProperties The properties that should be visible when a given property isn't available in common properties. This is typically the paragraph properties.
virtual QList< KoSvgTextProperties >	getSelectedProperties () override
	getSelectedProperties
virtual void	notifyCursorPosChanged (int pos, int anchor) override
virtual void	notifyMarkupChanged () override
virtual void	notifyShapeChanged (KoShape::ChangeType type, KoShape *shape) override
	Private (DefaultTool *parent)
virtual void	setCharacterPropertiesOnSelected (KoSvgTextProperties properties, QSet< KoSvgTextProperties::PropertyId > removeProperties=QSet< KoSvgTextProperties::PropertyId >()) override
	setCharacterPropertiesOnSelected This sets the properties for a character selection instead of the full text shape. Typically the selection of characters. The implementation is responsible for handling the undo states.
virtual void	setPropertiesOnSelected (KoSvgTextProperties properties, QSet< KoSvgTextProperties::PropertyId > removeProperties=QSet< KoSvgTextProperties::PropertyId >()) override
	setPropertiesOnSelected This sets the properties on the selection. The implementation is responsible for handling the undo states.
virtual bool	spanSelection () override
	Whether the tool is currently selecting a set of characters instead of whole paragraphs.
	~DefaultToolTextPropertiesInterface ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KoSvgTextPropertiesInterface
	KoSvgTextPropertiesInterface (QObject *parent=nullptr)
Public Member Functions inherited from KoSvgTextShape::TextCursorChangeListener
void	notifyShapeChanged (ChangeType type, KoShape *shape) override
Public Member Functions inherited from KoShape::ShapeChangeListener
virtual	~ShapeChangeListener ()

Public Attributes
KisSignalCompressor	compressor
DefaultTool *	parent
QList< KoShape * >	shapes
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Attributes
const QScopedPointer< Private >	d

Additional Inherited Members
Signals inherited from KoSvgTextPropertiesInterface
void	textCharacterSelectionChanged ()
void	textSelectionChanged ()
	Emit to signal to KisTextPropertiesManager to call getSelectedProperties.

Detailed Description

Interface to interact with the text property manager.

Definition at line 2331 of file DefaultTool.cpp.

Constructor & Destructor Documentation

DefaultToolTextPropertiesInterface()

DefaultToolTextPropertiesInterface::DefaultToolTextPropertiesInterface

(

DefaultTool *

parent

)

Definition at line 2342 of file DefaultTool.cpp.

    : KoSvgTextPropertiesInterface(parent)
    , d(new Private(parent))
{
    connect(&d->compressor, SIGNAL(timeout()), this, SIGNAL(textSelectionChanged()));
}

References d, and KoSvgTextPropertiesInterface::textSelectionChanged().

~DefaultToolTextPropertiesInterface()

DefaultToolTextPropertiesInterface::~DefaultToolTextPropertiesInterface

(

)

Definition at line 2349 of file DefaultTool.cpp.

{
    clearSelection();
}

References clearSelection().

Member Function Documentation

characterPropertiesEnabled()

bool DefaultToolTextPropertiesInterface::characterPropertiesEnabled ( )

overridevirtual

Whether character selections are possible at all.

Implements KoSvgTextPropertiesInterface.

Definition at line 2401 of file DefaultTool.cpp.

{
    return false;
}

clearSelection()

void DefaultToolTextPropertiesInterface::clearSelection

(

)

Definition at line 2425 of file DefaultTool.cpp.

{
    Q_FOREACH(KoShape *shape, d->shapes) {
        shape->removeShapeChangeListener(this);
    }
    d->shapes.clear();
}

References d, and KoShape::removeShapeChangeListener().

getCharacterProperties()

QList< KoSvgTextProperties > DefaultToolTextPropertiesInterface::getCharacterProperties ( )

overridevirtual

getSelectedProperties

Returns

all KoSvgTextProperties for the given character selection.

Implements KoSvgTextPropertiesInterface.

Definition at line 2370 of file DefaultTool.cpp.

{
    return QList<KoSvgTextProperties>();
}

getInheritedProperties()

KoSvgTextProperties DefaultToolTextPropertiesInterface::getInheritedProperties ( )

overridevirtual

getInheritedProperties The properties that should be visible when a given property isn't available in common properties. This is typically the paragraph properties.

Returns

what counts as the inherited properties for the given selection.

Implements KoSvgTextPropertiesInterface.

Definition at line 2375 of file DefaultTool.cpp.

{
    return KoSvgTextProperties();
}

getSelectedProperties()

QList< KoSvgTextProperties > DefaultToolTextPropertiesInterface::getSelectedProperties ( )

overridevirtual

getSelectedProperties

Returns

all KoSvgTextProperties for the given selection.

Implements KoSvgTextPropertiesInterface.

Definition at line 2354 of file DefaultTool.cpp.

{
    QList<KoSvgTextProperties> props = QList<KoSvgTextProperties>();
    if (!d->parent->selection()->hasSelection()) return props;
 
    QList<KoShape*> shapes = d->shapes;
    for (auto it = shapes.begin(); it != shapes.end(); it++) {
        KoSvgTextShape *textShape = dynamic_cast<KoSvgTextShape*>(*it);
        if (!textShape) continue;
        KoSvgTextProperties p = textShape->textProperties();
        props.append(p);
    }
 
    return props;
}

References d, p, shapes, and KoSvgTextShape::textProperties().

notifyCursorPosChanged()

void DefaultToolTextPropertiesInterface::notifyCursorPosChanged ( int pos, int anchor )

overridevirtual

Implements KoSvgTextShape::TextCursorChangeListener.

Definition at line 2406 of file DefaultTool.cpp.

{
    Q_UNUSED(pos)
    Q_UNUSED(anchor)
    d->compressor.start();
}

References d.

notifyMarkupChanged()

void DefaultToolTextPropertiesInterface::notifyMarkupChanged ( )

overridevirtual

Implements KoSvgTextShape::TextCursorChangeListener.

Definition at line 2413 of file DefaultTool.cpp.

{
    d->compressor.start();
}

References d.

notifyShapeChanged()

void DefaultToolTextPropertiesInterface::notifyShapeChanged ( KoShape::ChangeType type, KoShape * shape )

overridevirtual

Implements KoShape::ShapeChangeListener.

Definition at line 2418 of file DefaultTool.cpp.

{
    Q_UNUSED(type)
    Q_UNUSED(shape)
    d->compressor.start();
}

References d.

Private()

DefaultToolTextPropertiesInterface::Private ( DefaultTool * parent )

inline

Definition at line 2333 of file DefaultTool.cpp.

        : parent(parent)
        , compressor(10, KisSignalCompressor::POSTPONE){}

setCharacterPropertiesOnSelected()

void DefaultToolTextPropertiesInterface::setCharacterPropertiesOnSelected ( KoSvgTextProperties properties, QSet< KoSvgTextProperties::PropertyId > removeProperties = QSet< KoSvgTextProperties::PropertyId >() )

overridevirtual

setCharacterPropertiesOnSelected This sets the properties for a character selection instead of the full text shape. Typically the selection of characters. The implementation is responsible for handling the undo states.

Parameters

properties	– the properties to set.
removeProperties	– properties to remove.

Implements KoSvgTextPropertiesInterface.

Definition at line 2389 of file DefaultTool.cpp.

{
    Q_UNUSED(properties)
    Q_UNUSED(removeProperties)
    return;
}

setPropertiesOnSelected()

void DefaultToolTextPropertiesInterface::setPropertiesOnSelected ( KoSvgTextProperties properties, QSet< KoSvgTextProperties::PropertyId > removeProperties = QSet< KoSvgTextProperties::PropertyId >() )

overridevirtual

setPropertiesOnSelected This sets the properties on the selection. The implementation is responsible for handling the undo states.

Parameters

properties	– the properties to set.
removeProperties	– properties to remove.

Implements KoSvgTextPropertiesInterface.

Definition at line 2380 of file DefaultTool.cpp.

{
    if (d->shapes.isEmpty()) return;
    KUndo2Command *cmd = new KoShapeMergeTextPropertiesCommand(d->shapes, properties, removeProperties);
    if (cmd) {
        d->parent->canvas()->addCommand(cmd);
    }
}

References d.

slotSelectionChanged

void DefaultToolTextPropertiesInterface::slotSelectionChanged ( )

slot

Definition at line 2433 of file DefaultTool.cpp.

{
    if (d->parent->updateTextContourMode()) return;
    Q_FOREACH(KoShape *shape, d->shapes) {
        if (!shape) continue;
        shape->removeShapeChangeListener(this);
    }
 
    auto *textShapeGroup = d->parent->tryFetchCurrentShapeManagerOwnerTextShape();
 
    if (textShapeGroup) {
        d->shapes = {textShapeGroup};
    } else {
        d->shapes = d->parent->canvas()->selectedShapesProxy()->selection()->selectedEditableShapes();
    }
 
    Q_FOREACH(KoShape *shape, d->shapes) {
        if (!shape) continue;
        shape->addShapeChangeListener(this);
    }
    d->compressor.start();
}

References KoShape::addShapeChangeListener(), d, and KoShape::removeShapeChangeListener().

spanSelection()

bool DefaultToolTextPropertiesInterface::spanSelection ( )

overridevirtual

Whether the tool is currently selecting a set of characters instead of whole paragraphs.

Implements KoSvgTextPropertiesInterface.

Definition at line 2396 of file DefaultTool.cpp.

{
    return false;
}

Member Data Documentation

compressor

KisSignalCompressor DefaultToolTextPropertiesInterface::compressor

Definition at line 2339 of file DefaultTool.cpp.

d

const QScopedPointer<Private> DefaultToolTextPropertiesInterface::d

private

Definition at line 249 of file DefaultTool.h.

parent

DefaultTool* DefaultToolTextPropertiesInterface::parent

Definition at line 2337 of file DefaultTool.cpp.

shapes

QList<KoShape*> DefaultToolTextPropertiesInterface::shapes

Definition at line 2338 of file DefaultTool.cpp.

---

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

• plugins/tools/defaulttool/defaulttool/DefaultTool.cpp
• plugins/tools/defaulttool/defaulttool/DefaultTool.h