KoSvgTextPropertiesInterface Class Reference

The KoSvgTextPropertiesInterface class. More...

#include <KoSvgTextPropertiesInterface.h>

Inheritance diagram for KoSvgTextPropertiesInterface:

Signals
void	textCharacterSelectionChanged ()
void	textSelectionChanged ()
	Emit to signal to KisTextPropertiesManager to call getSelectedProperties.

Public Member Functions
virtual bool	characterPropertiesEnabled ()=0
	Whether character selections are possible at all.
virtual QList< KoSvgTextProperties >	getCharacterProperties ()=0
	getSelectedProperties
virtual KoSvgTextProperties	getInheritedProperties ()=0
	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 ()=0
	getSelectedProperties
	KoSvgTextPropertiesInterface (QObject *parent=nullptr)
virtual void	setCharacterPropertiesOnSelected (KoSvgTextProperties properties, QSet< KoSvgTextProperties::PropertyId > removeProperties=QSet< KoSvgTextProperties::PropertyId >())=0
	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 >())=0
	setPropertiesOnSelected This sets the properties on the selection. The implementation is responsible for handling the undo states.
virtual bool	spanSelection ()=0
	Whether the tool is currently selecting a set of characters instead of whole paragraphs.

Detailed Description

The KoSvgTextPropertiesInterface class.

This is an interface that can be used by tools to communicate with the KisTextPropertiesManager.

Definition at line 19 of file KoSvgTextPropertiesInterface.h.

Constructor & Destructor Documentation

KoSvgTextPropertiesInterface()

KoSvgTextPropertiesInterface::KoSvgTextPropertiesInterface ( QObject * parent = nullptr )

inlineexplicit

Definition at line 23 of file KoSvgTextPropertiesInterface.h.

: QObject(parent){}

Member Function Documentation

characterPropertiesEnabled()

virtual bool KoSvgTextPropertiesInterface::characterPropertiesEnabled ( )

pure virtual

Whether character selections are possible at all.

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

getCharacterProperties()

virtual QList< KoSvgTextProperties > KoSvgTextPropertiesInterface::getCharacterProperties ( )

pure virtual

getSelectedProperties

Returns

all KoSvgTextProperties for the given character selection.

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

getInheritedProperties()

virtual KoSvgTextProperties KoSvgTextPropertiesInterface::getInheritedProperties ( )

pure virtual

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.

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

getSelectedProperties()

virtual QList< KoSvgTextProperties > KoSvgTextPropertiesInterface::getSelectedProperties ( )

pure virtual

getSelectedProperties

Returns

all KoSvgTextProperties for the given selection.

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

setCharacterPropertiesOnSelected()

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

pure virtual

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.

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

setPropertiesOnSelected()

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

pure virtual

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.

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

spanSelection()

virtual bool KoSvgTextPropertiesInterface::spanSelection ( )

pure virtual

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

Implemented in DefaultToolTextPropertiesInterface, and SvgTextCursorPropertyInterface.

textCharacterSelectionChanged

void KoSvgTextPropertiesInterface::textCharacterSelectionChanged ( )

signal

Emit to signal to KisTextPropertiesManager to call getCharacterProperties and getInheritedProperties.

textSelectionChanged

void KoSvgTextPropertiesInterface::textSelectionChanged ( )

signal

Emit to signal to KisTextPropertiesManager to call getSelectedProperties.

---

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

• libs/flake/text/KoSvgTextPropertiesInterface.h