KoShapeQtQuickLabel Class Reference

The KoShapeQtQuickLabel class. More...

#include <KoShapeQtQuickLabel.h>

Inheritance diagram for KoShapeQtQuickLabel:

Classes
struct	Private

Public Types
enum	ScalingType { Fit , FitWidth , FitHeight }

Signals
void	alignmentChanged ()
void	documentRectChanged ()
void	fillColorChanged ()
void	foregroundColorChanged ()
void	fullColorChanged ()
void	minimumRectChanged ()
void	paddingChanged ()
void	scalingTypeChanged ()
void	svgDataChanged ()

Public Member Functions
Qt::Alignment	alignment () const
	alignment
void	componentComplete () override
QRectF	documentRect () const
QColor	foregroundColor () const
	foregroundColor This is the color that is used as the fill for the KoShapes when fullColor is set false.
bool	fullColor () const
	fullColor This controls whether the current shape background will be set to the foreground color or whether it will keep the color it received during parsing of SVG data.
	KoShapeQtQuickLabel (QQuickItem *parent=nullptr)
QRectF	minimumRect () const
	minimumRect Minimum size rectangle, defined by either documentRect or loaded SVG contentRect, with padding attached. Use this when you want sensible minimum size. We cannot set this to implicitsize or the like, because implicit width and height need to be used when setting KoShapeQtQuickLabel as a content item to a QQuickControl.
int	padding () const
void	paint (QPainter *painter) override
ScalingType	scalingType () const
	scalingType
void	setAlignment (const Qt::Alignment align)
void	setDocumentRect (const QRectF &rect)
void	setForegroundColor (const QColor &newForegroundColor)
void	setFullColor (bool newFullColor)
void	setPadding (int newPadding)
void	setScalingType (const ScalingType type)
void	setSvgData (const QString &newSvgData)
QString	svgData () const
	~KoShapeQtQuickLabel ()

Properties
Qt::Alignment	alignment
QRectF	documentRect
QColor	foregroundColor
bool	fullColor
QRectF	minimumRect
int	padding
ScalingType	scalingType
QString	svgData

Private Slots
void	callUpdateIfComplete ()
void	updateShapes ()

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

The KoShapeQtQuickLabel class.

A QQuickPaintedItem that will load SVG as KoShapes and paint them.

Definition at line 17 of file KoShapeQtQuickLabel.h.

Member Enumeration Documentation

ScalingType

enum KoShapeQtQuickLabel::ScalingType

Enumerator
Fit	Default koshapepainter behaviour, fit whole document into widget bounds.
FitWidth	Scale document view to document width. Use alignment to position top or bottom on the document.
FitHeight	Scale document view to document height. Use alignment to position left or right on the document.

Definition at line 34 of file KoShapeQtQuickLabel.h.

                     {
        Fit, 
        FitWidth, 
        FitHeight 
    };

Constructor & Destructor Documentation

KoShapeQtQuickLabel()

KoShapeQtQuickLabel::KoShapeQtQuickLabel

(

QQuickItem *

parent = nullptr

)

Definition at line 83 of file KoShapeQtQuickLabel.cpp.

    : QQuickPaintedItem(parent)
    , d(new Private())
{
    setAntialiasing(true);
    setOpaquePainting(true);
 
    connect(this, SIGNAL(minimumRectChanged()), this, SLOT(callUpdateIfComplete()));
}

References callUpdateIfComplete(), connect(), and minimumRectChanged().

~KoShapeQtQuickLabel()

KoShapeQtQuickLabel::~KoShapeQtQuickLabel

(

)

Definition at line 93 of file KoShapeQtQuickLabel.cpp.

{
}

Member Function Documentation

alignment()

Qt::Alignment KoShapeQtQuickLabel::alignment

(

)

const

alignment

Returns

how to align the document viewport when using FillWidth or FillHeight as the scaling type.

Definition at line 212 of file KoShapeQtQuickLabel.cpp.

{
    return d->alignment;
}

References d.

alignmentChanged

void KoShapeQtQuickLabel::alignmentChanged ( )

signal

callUpdateIfComplete

void KoShapeQtQuickLabel::callUpdateIfComplete ( )

privateslot

Definition at line 242 of file KoShapeQtQuickLabel.cpp.

{
    if (isComponentComplete()) {
        update(boundingRect().toAlignedRect());
    }
}

componentComplete()

void KoShapeQtQuickLabel::componentComplete ( )

override

Definition at line 224 of file KoShapeQtQuickLabel.cpp.

{
    QQuickPaintedItem::componentComplete();
    updateShapes();
    setOpaquePainting(fillColor().alpha() == 255);
}

References updateShapes().

documentRect()

QRectF KoShapeQtQuickLabel::documentRect

(

)

const

By default, this label will use the content rect as the document view. When this rectangle is valid, it will be used instead.

Definition at line 249 of file KoShapeQtQuickLabel.cpp.

{
    return d->documentRect;
}

References d.

documentRectChanged

void KoShapeQtQuickLabel::documentRectChanged ( )

signal

fillColorChanged

void KoShapeQtQuickLabel::fillColorChanged ( )

signal

foregroundColor()

QColor KoShapeQtQuickLabel::foregroundColor

(

)

const

foregroundColor This is the color that is used as the fill for the KoShapes when fullColor is set false.

Definition at line 152 of file KoShapeQtQuickLabel.cpp.

{
    return d->fgColor;
}

References d.

foregroundColorChanged

void KoShapeQtQuickLabel::foregroundColorChanged ( )

signal

fullColor()

bool KoShapeQtQuickLabel::fullColor

(

)

const

fullColor This controls whether the current shape background will be set to the foreground color or whether it will keep the color it received during parsing of SVG data.

Definition at line 186 of file KoShapeQtQuickLabel.cpp.

{
    return d->fullColor;
}

References d.

fullColorChanged

void KoShapeQtQuickLabel::fullColorChanged ( )

signal

minimumRect()

QRectF KoShapeQtQuickLabel::minimumRect

(

)

const

minimumRect Minimum size rectangle, defined by either documentRect or loaded SVG contentRect, with padding attached. Use this when you want sensible minimum size. We cannot set this to implicitsize or the like, because implicit width and height need to be used when setting KoShapeQtQuickLabel as a content item to a QQuickControl.

Definition at line 262 of file KoShapeQtQuickLabel.cpp.

{
    const QRectF bounds = d->documentRect.isValid()? d->documentRect: d->shapePainter? d->shapePainter->contentRect(): QRectF();
    return d->addPaddingToBounds(bounds);
}

References bounds, and d.

minimumRectChanged

void KoShapeQtQuickLabel::minimumRectChanged ( )

signal

padding()

int KoShapeQtQuickLabel::padding

(

)

const

Padding of the documentView to the borders. This will add extra padding to the sides. If there's still paintable shape data in that padding, it will be drawn as well.

Definition at line 167 of file KoShapeQtQuickLabel.cpp.

{
    return (d->leftPadding + d->rightPadding + d->topPadding + d->bottomPadding) / 4;
}

References d.

paddingChanged

void KoShapeQtQuickLabel::paddingChanged ( )

signal

paint()

void KoShapeQtQuickLabel::paint ( QPainter * painter )

override

Definition at line 97 of file KoShapeQtQuickLabel.cpp.

{
    if (!d->shapePainter) return;
    if (!painter->isActive()) return;
 
    const QRectF bbox = d->documentRect.isValid()? d->documentRect: d->shapePainter->contentRect();
    const QRectF bounds = QRectF(0, 0, width(), height());
 
    if (d->shapes.isEmpty()) {
        return;
    }
 
    d->shapePainter->paint(*painter,
                           bounds.toAlignedRect(),
                           d->adjustBBoxToScaling(bbox, bounds));
 
}

References bounds, and d.

scalingType()

KoShapeQtQuickLabel::ScalingType KoShapeQtQuickLabel::scalingType

(

)

const

scalingType

See also

ScalingType enum.

Definition at line 200 of file KoShapeQtQuickLabel.cpp.

{
    return d->scalingType;
}

References d.

scalingTypeChanged

void KoShapeQtQuickLabel::scalingTypeChanged ( )

signal

setAlignment()

void KoShapeQtQuickLabel::setAlignment

(

const Qt::Alignment

align

)

Definition at line 217 of file KoShapeQtQuickLabel.cpp.

{
    if (d->alignment == align) return;
    d->alignment = align;
    emit alignmentChanged();
}

References alignmentChanged(), and d.

setDocumentRect()

void KoShapeQtQuickLabel::setDocumentRect

(

const QRectF &

rect

)

Definition at line 254 of file KoShapeQtQuickLabel.cpp.

{
    if (d->documentRect == rect) return;
    d->documentRect = rect;
    emit documentRectChanged();
    emit minimumRectChanged();
}

References d, documentRectChanged(), and minimumRectChanged().

setForegroundColor()

void KoShapeQtQuickLabel::setForegroundColor

(

const QColor &

newForegroundColor

)

Definition at line 157 of file KoShapeQtQuickLabel.cpp.

{
    if (d->fgColor == newForegroundColor)
            return;
 
    d->fgColor = newForegroundColor;
    updateShapes();
    emit foregroundColorChanged();
}

References d, foregroundColorChanged(), and updateShapes().

setFullColor()

void KoShapeQtQuickLabel::setFullColor

(

bool

newFullColor

)

Definition at line 191 of file KoShapeQtQuickLabel.cpp.

{
    if (d->fullColor == newFullColor)
        return;
    d->fullColor = newFullColor;
 
    emit fullColorChanged();
}

References d, and fullColorChanged().

setPadding()

void KoShapeQtQuickLabel::setPadding

(

int

newPadding

)

Definition at line 172 of file KoShapeQtQuickLabel.cpp.

{
    const int currentPadding = (d->leftPadding + d->rightPadding + d->topPadding + d->bottomPadding) / 4;
    if (currentPadding == newPadding)
        return;
    d->leftPadding = newPadding;
    d->rightPadding = newPadding;
    d->topPadding = newPadding;
    d->bottomPadding = newPadding;
 
    emit paddingChanged();
    emit minimumRectChanged();
}

References d, minimumRectChanged(), and paddingChanged().

setScalingType()

void KoShapeQtQuickLabel::setScalingType

(

const ScalingType

type

)

Definition at line 205 of file KoShapeQtQuickLabel.cpp.

{
    if (d->scalingType == type) return;
    d->scalingType = type;
    emit scalingTypeChanged();
}

References d, and scalingTypeChanged().

setSvgData()

void KoShapeQtQuickLabel::setSvgData

(

const QString &

newSvgData

)

Definition at line 120 of file KoShapeQtQuickLabel.cpp.

{
    if (d->svgData == newSvgData)
        return;
    d->svgData = newSvgData;
 
    QDomDocument doc = SvgParser::createDocumentFromSvg(d->svgData);
    KoDocumentResourceManager resourceManager;
    SvgParser p(&resourceManager);
    QRectF bb = QRectF( 0, 0, 200, 200);
    QSizeF sz = bb.size();
    p.setResolution(bb, 72);
    p.setFillStrokeInheritByDefault(true);
 
    QList<KoShape*> shapes = p.parseSvg(doc.documentElement(), &sz);
 
    // TODO: Evaluate if this can't be faster.
    d->shapePainter.reset(new KoShapePainter());
 
    if (!d->shapes.isEmpty()) {
        qDeleteAll(d->shapes);
    }
 
    d->shapes = shapes;
    d->shapePainter->setShapes(d->shapes);
 
    updateShapes();
 
    emit svgDataChanged();
    emit minimumRectChanged();
}

References SvgParser::createDocumentFromSvg(), d, minimumRectChanged(), p, svgDataChanged(), and updateShapes().

svgData()

QString KoShapeQtQuickLabel::svgData

(

)

const

Definition at line 115 of file KoShapeQtQuickLabel.cpp.

{
    return d->svgData;
}

References d.

svgDataChanged

void KoShapeQtQuickLabel::svgDataChanged ( )

signal

updateShapes

void KoShapeQtQuickLabel::updateShapes ( )

privateslot

Definition at line 231 of file KoShapeQtQuickLabel.cpp.

{
    if (!d->fullColor) {
        QSharedPointer<KoColorBackground> bg(new KoColorBackground(d->fgColor));
        for (int i = 0; i < d->shapes.size(); i++) {
            d->shapes.at(i)->setBackground(bg);
        }
    }
    callUpdateIfComplete();
}

References callUpdateIfComplete(), and d.

Member Data Documentation

d

const QScopedPointer<Private> KoShapeQtQuickLabel::d

private

Definition at line 128 of file KoShapeQtQuickLabel.h.

Property Documentation

alignment

Qt::Alignment KoShapeQtQuickLabel::alignment

readwrite

Definition at line 25 of file KoShapeQtQuickLabel.h.

documentRect

QRectF KoShapeQtQuickLabel::documentRect

readwrite

Definition at line 26 of file KoShapeQtQuickLabel.h.

foregroundColor

QColor KoShapeQtQuickLabel::foregroundColor

readwrite

Definition at line 21 of file KoShapeQtQuickLabel.h.

fullColor

bool KoShapeQtQuickLabel::fullColor

readwrite

Definition at line 23 of file KoShapeQtQuickLabel.h.

minimumRect

QRectF KoShapeQtQuickLabel::minimumRect

read

Definition at line 27 of file KoShapeQtQuickLabel.h.

padding

int KoShapeQtQuickLabel::padding

readwrite

Definition at line 22 of file KoShapeQtQuickLabel.h.

scalingType

ScalingType KoShapeQtQuickLabel::scalingType

readwrite

Definition at line 24 of file KoShapeQtQuickLabel.h.

svgData

QString KoShapeQtQuickLabel::svgData

readwrite

Definition at line 20 of file KoShapeQtQuickLabel.h.

---

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

• qmlmodules/components/KoShapeQtQuickLabel.h
• qmlmodules/components/KoShapeQtQuickLabel.cpp