#include <KoTextShapeDataBase.h>

Inheritance diagram for KoTextShapeDataBase:

Public Types
enum	ResizeMethod { AutoResize , AutoGrowWidth , AutoGrowHeight , AutoGrowWidthAndHeight , ShrinkToFitResize , NoResize }

Public Member Functions
QTextDocument *	document () const
	return the document

	KoTextShapeDataBase ()
	constructor

ResizeMethod	resizeMethod () const

void	setResizeMethod (ResizeMethod method)

void	setShapeMargins (const KoInsets &margins)

void	setVerticalAlignment (Qt::Alignment alignment)

KoInsets	shapeMargins () const

Qt::Alignment	verticalAlignment () const

	~KoTextShapeDataBase () override

Public Member Functions inherited from KoShapeUserData
virtual KoShapeUserData *	clone () const =0

	KoShapeUserData (QObject *parent=0)
	Constructor.

	~KoShapeUserData () override

Protected Member Functions
	KoTextShapeDataBase (KoTextShapeDataBasePrivate *)
	constructor

Protected Member Functions inherited from KoShapeUserData
	KoShapeUserData (const KoShapeUserData &rhs)

Protected Attributes
KoTextShapeDataBasePrivate *	d_ptr

Detailed Description

Definition at line 25 of file KoTextShapeDataBase.h.

Member Enumeration Documentation

◆ ResizeMethod

enum KoTextShapeDataBase::ResizeMethod

Enum to describe the text document's automatic resizing behaviour.

Enumerator
AutoResize	Resize the shape to fit the content. This makes sure that the text shape takes op only as much space as absolutely necessary to fit the entire text into its boundaries.
AutoGrowWidth	Specifies whether or not to automatically increase the width of the drawing object if text is added to fit the entire width of the text into its boundaries. Compared to AutoResize above this only applied to the width whereas the height is not resized. Also this only grows but does not shrink again if text is removed again.
AutoGrowHeight	Specifies whether or not to automatically increase the height of the drawing object if text is added to fit the entire height of the text into its boundaries.
AutoGrowWidthAndHeight	This combines the AutoGrowWidth and AutoGrowHeight and automatically increase width and height to fit the entire text into its boundaries.
ShrinkToFitResize	Shrink the content displayed within the shape to match into the shape's boundaries. This will scale the content down as needed to display the whole document.
NoResize	Deactivates auto-resizing. This is the default resizing method.

Definition at line 57 of file KoTextShapeDataBase.h.

                      {
        AutoResize,
        AutoGrowWidth,
        AutoGrowHeight,
        AutoGrowWidthAndHeight,
        ShrinkToFitResize,
        NoResize
    };

Constructor & Destructor Documentation

◆ KoTextShapeDataBase() [1/2]

KoTextShapeDataBase::KoTextShapeDataBase ( )

constructor

◆ ~KoTextShapeDataBase()

KoTextShapeDataBase::~KoTextShapeDataBase ( )

override

Definition at line 35 of file KoTextShapeDataBase.cpp.

{
    delete d_ptr;
}

References d_ptr.

◆ KoTextShapeDataBase() [2/2]

KoTextShapeDataBase::KoTextShapeDataBase ( KoTextShapeDataBasePrivate * dd )

protected

constructor

Definition at line 30 of file KoTextShapeDataBase.cpp.

    : d_ptr(dd)
{
}

Member Function Documentation

◆ document()

QTextDocument * KoTextShapeDataBase::document ( ) const

return the document

Definition at line 40 of file KoTextShapeDataBase.cpp.

{
    Q_D(const KoTextShapeDataBase);
    return d->document.data();
}

◆ resizeMethod()

KoTextShapeDataBase::ResizeMethod KoTextShapeDataBase::resizeMethod ( ) const

Returns the auto-resizing mode. By default, this is NoResize.

See also: setResizeMethod

Definition at line 79 of file KoTextShapeDataBase.cpp.

{
    Q_D(const KoTextShapeDataBase);
    return d->resizeMethod;
}

◆ setResizeMethod()

void KoTextShapeDataBase::setResizeMethod ( KoTextShapeDataBase::ResizeMethod method )

Specifies how the document should be resized upon a change in the document.

If auto-resizing is turned on, text will not be wrapped unless enforced by e.g. a newline.

By default, NoResize is set.

Definition at line 71 of file KoTextShapeDataBase.cpp.

{
    Q_D(KoTextShapeDataBase);
    if (d->resizeMethod == method)
        return;
    d->resizeMethod = method;
}

◆ setShapeMargins()

void KoTextShapeDataBase::setShapeMargins ( const KoInsets & margins )

Set the margins that will make the shapes text area smaller. The shape that owns this textShapeData object will layout text in an area confined by the shape size made smaller by the margins set here.

Parameters

margins the margins that shrink the text area.

Definition at line 46 of file KoTextShapeDataBase.cpp.

{
    Q_D(KoTextShapeDataBase);
    d->margins = margins;
}

◆ setVerticalAlignment()

void KoTextShapeDataBase::setVerticalAlignment ( Qt::Alignment alignment )

Sets the vertical alignment of all the text inside the shape.

Definition at line 58 of file KoTextShapeDataBase.cpp.

{
    Q_D(KoTextShapeDataBase);
    d->textAlignment = (d->textAlignment & Qt::AlignHorizontal_Mask)
        | (alignment & Qt::AlignVertical_Mask);
}

◆ shapeMargins()

KoInsets KoTextShapeDataBase::shapeMargins ( ) const

returns the currently set margins for the shape.

Definition at line 52 of file KoTextShapeDataBase.cpp.

{
    Q_D(const KoTextShapeDataBase);
    return d->margins;
}

◆ verticalAlignment()

Qt::Alignment KoTextShapeDataBase::verticalAlignment ( ) const

Returns the vertical alignment of all the text in the shape

Definition at line 65 of file KoTextShapeDataBase.cpp.

{
    Q_D(const KoTextShapeDataBase);
    return d->textAlignment & Qt::AlignVertical_Mask;
}

Member Data Documentation

◆ d_ptr

KoTextShapeDataBasePrivate* KoTextShapeDataBase::d_ptr