#include <KoDocumentResourceManager.h>

Inheritance diagram for KoDocumentResourceManager:

Public Types
enum	DocumentResource { UndoStack , OdfDocument , GrabSensitivity , MarkerCollection , DocumentResolution , DocumentRectInPixels , KarbonStart = 1000 , KexiStart = 2000 , FlowStart = 3000 , PlanStart = 4000 , StageStart = 5000 , KritaStart = 6000 , SheetsStart = 7000 , WordsStart = 8000 , KoPageAppStart = 9000 , KoTextStart = 10000 }

Signals
void	resourceChanged (int key, const QVariant &value)

Public Member Functions
bool	boolResource (int key) const

void	clearResource (int key)

QRectF	documentRectInPixels () const

qreal	documentResolution () const

int	grabSensitivity () const
	Returns the actual grab sensitivity.

bool	hasResource (int key) const

int	intResource (int key) const

KoColor	koColorResource (int key) const

	KoDocumentResourceManager (QObject *parent=0)

KoShape *	koShapeResource (int key) const

QVariant	resource (int key) const

void	setGrabSensitivity (int grabSensitivity)

void	setResource (int key, const KoColor &color)

void	setResource (int key, const KoUnit &unit)

void	setResource (int key, const QVariant &value)

void	setResource (int key, KoShape *shape)

void	setUndoStack (KUndo2Stack *undoStack)

QSizeF	sizeResource (int key) const

QString	stringResource (int key) const

KUndo2Stack *	undoStack () const

KoUnit	unitResource (int key) const

	~KoDocumentResourceManager () override

Public Attributes
KoResourceManager	manager

Private Member Functions
	KoDocumentResourceManager (const KoDocumentResourceManager &)

KoDocumentResourceManager &	operator= (const KoDocumentResourceManager &)

Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

The KoResourceManager contains a set of per-canvas or per-document properties, like current foreground color, current background color and more. All tools belonging to the current canvas are notified when a Resource changes (is set).

The properties come from the KoDocumentResourceManager::DocumentResource See KoShapeController::resourceManager

The manager can contain all sorts of variable types and there are accessors for the most common ones. All variables are always stored inside a QVariant instance internally and you can always just use the resource() method to get that directly. The way to store arbitrary data objects that are stored as pointers you can use the following code snippets;

QVariant variant;
variant.setValue<void*>(textShapeData->document());
resourceManager->setResource(KoText::CurrentTextDocument, variant);
// and get it out again.
QVariant var = resourceManager->resource(KoText::CurrentTextDocument);
document = static_cast<QTextDocument*>(var.value<void*>());

Definition at line 19 of file KoDocumentResourceManager.cpp.

Member Enumeration Documentation

◆ DocumentResource

enum KoDocumentResourceManager::DocumentResource

This enum holds identifiers to the resources that can be stored in here.

Enumerator
UndoStack	The document-wide undo stack (KUndo2Stack)
OdfDocument	OBSOLETE The document this canvas shows.
GrabSensitivity	The grab sensitivity used for grabbing handles of any kind.
MarkerCollection	The collection holding all markers.
DocumentResolution	Pixels-per-inch resolution of the document.
DocumentRectInPixels	Bounds of the document in pixels.
KarbonStart	Base number for Karbon specific values.
KexiStart	Base number for Kexi specific values.
FlowStart	Base number for Flow specific values.
PlanStart	Base number for Plan specific values.
StageStart	Base number for Stage specific values.
KritaStart	Base number for Krita specific values.
SheetsStart	Base number for Sheets specific values.
WordsStart	Base number for Words specific values.
KoPageAppStart	Base number for KoPageApp specific values.
KoTextStart	Base number for KoText specific values.

Definition at line 57 of file KoDocumentResourceManager.h.

                      {
    UndoStack,              
    OdfDocument,            
    GrabSensitivity,        
    MarkerCollection,       
    DocumentResolution,     
    DocumentRectInPixels,   
 
    KarbonStart = 1000,      
    KexiStart = 2000,        
    FlowStart = 3000,        
    PlanStart = 4000,        
    StageStart = 5000,       
    KritaStart = 6000,       
    SheetsStart = 7000,      
    WordsStart = 8000,       
    KoPageAppStart = 9000,   
    KoTextStart = 10000      
};

Constructor & Destructor Documentation

◆ KoDocumentResourceManager() [1/2]

KoDocumentResourceManager::KoDocumentResourceManager ( QObject * parent = 0 )

explicit

Constructor.

Parameters

parent the parent QObject, used for memory management.

Definition at line 25 of file KoDocumentResourceManager.cpp.

        : QObject(parent),
        d(new Private())
{
    connect(&d->manager, &KoResourceManager::resourceChanged,
            this, &KoDocumentResourceManager::resourceChanged);
}

References connect(), d, resourceChanged(), and KoResourceManager::resourceChanged().

◆ ~KoDocumentResourceManager()

KoDocumentResourceManager::~KoDocumentResourceManager ( )

override

Definition at line 33 of file KoDocumentResourceManager.cpp.

{
    delete d;
}

References d.

◆ KoDocumentResourceManager() [2/2]

KoDocumentResourceManager::KoDocumentResourceManager ( const KoDocumentResourceManager & )

private

Member Function Documentation

◆ boolResource()

bool KoDocumentResourceManager::boolResource ( int key ) const

Return the resource determined by param key as a boolean.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Definition at line 75 of file KoDocumentResourceManager.cpp.

{
    return d->manager.boolResource(key);
}

References d.

◆ clearResource()

void KoDocumentResourceManager::clearResource ( int key )

Remove the resource with key from the provider.

Parameters

key	the key that will be used to remove the resource There will be a signal emitted with a variable that will return true on QVariable::isNull();

See also: KoDocumentResourceManager::DocumentResource

Definition at line 100 of file KoDocumentResourceManager.cpp.

{
    d->manager.clearResource(key);
}

References d.

◆ documentRectInPixels()

QRectF KoDocumentResourceManager::documentRectInPixels ( ) const

Definition at line 140 of file KoDocumentResourceManager.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(hasResource(DocumentRectInPixels), QRectF(0,0, 777, 666));
    return resource(DocumentRectInPixels).toRectF();
}

References DocumentRectInPixels, hasResource(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and resource().

◆ documentResolution()

qreal KoDocumentResourceManager::documentResolution ( ) const

Definition at line 134 of file KoDocumentResourceManager.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(hasResource(DocumentResolution), 72.0);
    return resource(DocumentResolution).toReal();
}

References DocumentResolution, hasResource(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and resource().

◆ grabSensitivity()

int KoDocumentResourceManager::grabSensitivity ( ) const

Returns the actual grab sensitivity.

Definition at line 120 of file KoDocumentResourceManager.cpp.

{
    if (hasResource(GrabSensitivity))
        return intResource(GrabSensitivity);
    return 5; // default value (and is used just about everywhere)
}

References GrabSensitivity, hasResource(), and intResource().

◆ hasResource()

bool KoDocumentResourceManager::hasResource ( int key ) const

Returns true if there is a resource set with the requested key.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Definition at line 95 of file KoDocumentResourceManager.cpp.

{
    return d->manager.hasResource(key);
}

References d.

◆ intResource()

int KoDocumentResourceManager::intResource ( int key ) const

Return the resource determined by param key as an integer.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Definition at line 80 of file KoDocumentResourceManager.cpp.

{
    return d->manager.intResource(key);
}

References d.

◆ koColorResource()

KoColor KoDocumentResourceManager::koColorResource ( int key ) const

Return the resource determined by param key as a KoColor.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Definition at line 69 of file KoDocumentResourceManager.cpp.

{
    return d->manager.koColorResource(key);
}

References d.

◆ koShapeResource()

KoShape * KoDocumentResourceManager::koShapeResource ( int key ) const

Return the resource determined by param key as a pointer to a KoShape.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

◆ operator=()

KoDocumentResourceManager & KoDocumentResourceManager::operator= ( const KoDocumentResourceManager & )

private

◆ resource()

QVariant KoDocumentResourceManager::resource ( int key ) const

Returns a qvariant containing the specified resource or a standard one if the specified resource does not exist.

Parameters

key the key

See also: KoDocumentResourceManager::DocumentResource

Definition at line 43 of file KoDocumentResourceManager.cpp.

{
    return d->manager.resource(key);
}

References d.

◆ resourceChanged

void KoDocumentResourceManager::resourceChanged	(	int	key,
		const QVariant &	value )

signal

This signal is emitted every time a resource is set that is either new or different from the previous set value.

Parameters

key	the identifying key for the resource
value	the variants new value.

See also: KoDocumentResourceManager::DocumentResource

◆ setGrabSensitivity()

void KoDocumentResourceManager::setGrabSensitivity ( int grabSensitivity )

Tools that are used to grab handles or similar with the mouse should use this value to determine if the mouse is near enough

Parameters

grabSensitivity the grab sensitivity in pixels

Definition at line 112 of file KoDocumentResourceManager.cpp.

{
    // do not allow arbitrary small grab sensitivity
    if (grabSensitivity < 5)
        grabSensitivity = 5;
    setResource(GrabSensitivity, QVariant(grabSensitivity));
}

References GrabSensitivity, grabSensitivity(), and setResource().

◆ setResource() [1/4]

void KoDocumentResourceManager::setResource	(	int	key,
		const KoColor &	color )

Set a resource of type KoColor.

Parameters

key	the integer key
color	the new value for the key.

See also: KoDocumentResourceManager::DocumentResource

Definition at line 48 of file KoDocumentResourceManager.cpp.

{
    QVariant v;
    v.setValue(color);
    setResource(key, v);
}

References setResource(), and v.

◆ setResource() [2/4]

void KoDocumentResourceManager::setResource	(	int	key,
		const KoUnit &	unit )

Set a resource of type KoUnit

Parameters

key	the integer key
id	the new value for the key.

See also: KoDocumentResourceManager::DocumentResource

Definition at line 62 of file KoDocumentResourceManager.cpp.

{
    QVariant v;
    v.setValue(unit);
    setResource(key, v);
}

References setResource(), and v.

◆ setResource() [3/4]

void KoDocumentResourceManager::setResource	(	int	key,
		const QVariant &	value )

Set a resource of any type.

Parameters

key	the integer key
value	the new value for the key.

See also: KoDocumentResourceManager::DocumentResource

Definition at line 38 of file KoDocumentResourceManager.cpp.

{
    d->manager.setResource(key, value);
}

References d, and value().

◆ setResource() [4/4]

void KoDocumentResourceManager::setResource	(	int	key,
		KoShape *	shape )

Set a resource of type KoShape*.

Parameters

key	the integer key
id	the new value for the key.

See also: KoDocumentResourceManager::DocumentResource

Definition at line 55 of file KoDocumentResourceManager.cpp.

{
    QVariant v;
    v.setValue(shape);
    setResource(key, v);
}

References setResource(), and v.

◆ setUndoStack()

void KoDocumentResourceManager::setUndoStack ( KUndo2Stack * undoStack )

Definition at line 127 of file KoDocumentResourceManager.cpp.

{
    QVariant variant;
    variant.setValue<void*>(undoStack);
    setResource(UndoStack, variant);
}

References setResource(), and undoStack().

◆ sizeResource()

QSizeF KoDocumentResourceManager::sizeResource ( int key ) const

Return the resource determined by param key as a QSizeF.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Definition at line 90 of file KoDocumentResourceManager.cpp.

{
    return d->manager.sizeResource(key);
}

References d.

◆ stringResource()

QString KoDocumentResourceManager::stringResource ( int key ) const

Return the resource determined by param key as a QString .

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Definition at line 85 of file KoDocumentResourceManager.cpp.

{
    return d->manager.stringResource(key);
}

References d.

◆ undoStack()

KUndo2Stack * KoDocumentResourceManager::undoStack ( ) const

Definition at line 105 of file KoDocumentResourceManager.cpp.

{
    if (!hasResource(UndoStack))
        return 0;
    return static_cast<KUndo2Stack*>(resource(UndoStack).value<void*>());
}

References hasResource(), and resource().

◆ unitResource()

KoUnit KoDocumentResourceManager::unitResource ( int key ) const

Return the resource determined by param key as a KoUnit.

Parameters

key	the identifying key for the resource

See also: KoDocumentResourceManager::DocumentResource

Member Data Documentation

◆ d

Private* const KoDocumentResourceManager::d

private

Definition at line 221 of file KoDocumentResourceManager.h.

◆ manager

KoResourceManager KoDocumentResourceManager::manager

Definition at line 22 of file KoDocumentResourceManager.cpp.

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

libs/flake/KoDocumentResourceManager.cpp
libs/flake/KoDocumentResourceManager.h

Public Types

Signals

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ DocumentResource

Constructor & Destructor Documentation

◆ KoDocumentResourceManager() [1/2]

◆ ~KoDocumentResourceManager()

◆ KoDocumentResourceManager() [2/2]

Member Function Documentation

◆ boolResource()

◆ clearResource()

◆ documentRectInPixels()

◆ documentResolution()

◆ grabSensitivity()

◆ hasResource()

◆ intResource()

◆ koColorResource()

◆ koShapeResource()

◆ operator=()

◆ resource()

◆ resourceChanged

◆ setGrabSensitivity()

◆ setResource() [1/4]

◆ setResource() [2/4]

◆ setResource() [3/4]

◆ setResource() [4/4]

◆ setUndoStack()

◆ sizeResource()

◆ stringResource()

◆ undoStack()

◆ unitResource()

Member Data Documentation

◆ d

◆ manager