Rich text item, based on QTextDocument. More...

#include <bpsgraphicsitem.h>

Inheritance diagram for BpsGraphicsRichtextItem:

Public Member Functions
	BpsGraphicsRichtextItem (QGraphicsItem *aParent=nullptr)
	Constructor for the class. More...

QFont	defaultFont () const

Bps::Direction	direction () const

QRectF	handleRect () const

BpsMargins	margins () const

int	resolution () const

int	roundness () const

void	setDefaultFont (const QFont &aFont)
	Set a new default fond. More...

void	setDirection (Bps::Direction aDirection)
	Set the new text direction. More...

void	setHtml (const QString &aText)
	Set new content as html code. More...

void	setMargins (const BpsMargins &aMargins)
	Set new margins. More...

void	setPlainText (const QString &aText)
	Set new content as plain text. More...

void	setResolution (int aResolution)
	Set the new resolution in DPI. More...

void	setRoundness (int aRoundness)
	Define a new roundness for the rectangle corners. More...

void	setTextWidth (qreal aWidth)
	Set the new text width. More...

qreal	textWidth () const

QString	toHtml () const

QString	toPlainText () const

Public Member Functions inherited from QAbstractGraphicsShapeItem
QBrush	brush () const const

virtual bool	isObscuredBy (const QGraphicsItem *item) const const override

virtual QPainterPath	opaqueArea () const const override

QPen	pen () const const

	QAbstractGraphicsShapeItem (QGraphicsItem *parent)

void	setBrush (const QBrush &brush)

void	setPen (const QPen &pen)

Public Member Functions inherited from QGraphicsItem
bool	acceptDrops () const const

Qt::MouseButtons	acceptedMouseButtons () const const

bool	acceptHoverEvents () const const

bool	acceptsHoverEvents () const const

bool	acceptTouchEvents () const const

virtual void	advance (int phase)

virtual QRectF	boundingRect () const const=0

QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const const

qreal	boundingRegionGranularity () const const

QGraphicsItem::CacheMode	cacheMode () const const

QList< QGraphicsItem * >	childItems () const const

QList< QGraphicsItem * >	children () const const

QRectF	childrenBoundingRect () const const

void	clearFocus ()

QPainterPath	clipPath () const const

virtual bool	collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const const

virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const const

QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode) const const

QGraphicsItem *	commonAncestorItem (const QGraphicsItem *other) const const

virtual bool	contains (const QPointF &point) const const

QCursor	cursor () const const

QVariant	data (int key) const const

QTransform	deviceTransform (const QTransform &viewportTransform) const const

qreal	effectiveOpacity () const const

void	ensureVisible (const QRectF &rect, int xmargin, int ymargin)

void	ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)

bool	filtersChildEvents () const const

QGraphicsItem::GraphicsItemFlags	flags () const const

QGraphicsItem *	focusItem () const const

QGraphicsItem *	focusProxy () const const

void	grabKeyboard ()

void	grabMouse ()

QGraphicsEffect *	graphicsEffect () const const

QGraphicsItemGroup *	group () const const

bool	handlesChildEvents () const const

bool	hasCursor () const const

bool	hasFocus () const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

void	installSceneEventFilter (QGraphicsItem *filterItem)

bool	isActive () const const

bool	isAncestorOf (const QGraphicsItem *child) const const

bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel) const const

bool	isClipped () const const

bool	isEnabled () const const

bool	isObscured (const QRectF &rect) const const

bool	isObscured (qreal x, qreal y, qreal w, qreal h) const const

bool	isPanel () const const

bool	isSelected () const const

bool	isUnderMouse () const const

bool	isVisible () const const

bool	isVisibleTo (const QGraphicsItem *parent) const const

bool	isWidget () const const

bool	isWindow () const const

QTransform	itemTransform (const QGraphicsItem other, bool ok) const const

QPainterPath	mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const const

QPointF	mapFromItem (const QGraphicsItem *item, const QPointF &point) const const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QRectF &rect) const const

QPointF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const const

QPolygonF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const const

QPainterPath	mapFromParent (const QPainterPath &path) const const

QPointF	mapFromParent (const QPointF &point) const const

QPolygonF	mapFromParent (const QPolygonF &polygon) const const

QPolygonF	mapFromParent (const QRectF &rect) const const

QPointF	mapFromParent (qreal x, qreal y) const const

QPolygonF	mapFromParent (qreal x, qreal y, qreal w, qreal h) const const

QPainterPath	mapFromScene (const QPainterPath &path) const const

QPointF	mapFromScene (const QPointF &point) const const

QPolygonF	mapFromScene (const QPolygonF &polygon) const const

QPolygonF	mapFromScene (const QRectF &rect) const const

QPointF	mapFromScene (qreal x, qreal y) const const

QPolygonF	mapFromScene (qreal x, qreal y, qreal w, qreal h) const const

QRectF	mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const const

QRectF	mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const const

QRectF	mapRectFromParent (const QRectF &rect) const const

QRectF	mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const const

QRectF	mapRectFromScene (const QRectF &rect) const const

QRectF	mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const const

QRectF	mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const const

QRectF	mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const const

QRectF	mapRectToParent (const QRectF &rect) const const

QRectF	mapRectToParent (qreal x, qreal y, qreal w, qreal h) const const

QRectF	mapRectToScene (const QRectF &rect) const const

QRectF	mapRectToScene (qreal x, qreal y, qreal w, qreal h) const const

QPainterPath	mapToItem (const QGraphicsItem *item, const QPainterPath &path) const const

QPointF	mapToItem (const QGraphicsItem *item, const QPointF &point) const const

QPolygonF	mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const const

QPolygonF	mapToItem (const QGraphicsItem *item, const QRectF &rect) const const

QPointF	mapToItem (const QGraphicsItem *item, qreal x, qreal y) const const

QPolygonF	mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const const

QPainterPath	mapToParent (const QPainterPath &path) const const

QPointF	mapToParent (const QPointF &point) const const

QPolygonF	mapToParent (const QPolygonF &polygon) const const

QPolygonF	mapToParent (const QRectF &rect) const const

QPointF	mapToParent (qreal x, qreal y) const const

QPolygonF	mapToParent (qreal x, qreal y, qreal w, qreal h) const const

QPainterPath	mapToScene (const QPainterPath &path) const const

QPointF	mapToScene (const QPointF &point) const const

QPolygonF	mapToScene (const QPolygonF &polygon) const const

QPolygonF	mapToScene (const QRectF &rect) const const

QPointF	mapToScene (qreal x, qreal y) const const

QPolygonF	mapToScene (qreal x, qreal y, qreal w, qreal h) const const

QMatrix	matrix () const const

void	moveBy (qreal dx, qreal dy)

qreal	opacity () const const

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget)=0

QGraphicsItem *	panel () const const

QGraphicsItem::PanelModality	panelModality () const const

QGraphicsItem *	parentItem () const const

QGraphicsObject *	parentObject () const const

QGraphicsWidget *	parentWidget () const const

QPointF	pos () const const

	QGraphicsItem (QGraphicsItem *parent)

T	qgraphicsitem_cast (QGraphicsItem *item)

void	removeSceneEventFilter (QGraphicsItem *filterItem)

void	resetMatrix ()

void	resetTransform ()

void	rotate (qreal angle)

qreal	rotation () const const

qreal	scale () const const

void	scale (qreal sx, qreal sy)

QGraphicsScene *	scene () const const

QRectF	sceneBoundingRect () const const

QMatrix	sceneMatrix () const const

QPointF	scenePos () const const

QTransform	sceneTransform () const const

void	scroll (qreal dx, qreal dy, const QRectF &rect)

void	setAcceptDrops (bool on)

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptsHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActive (bool active)

void	setBoundingRegionGranularity (qreal granularity)

void	setCacheMode (QGraphicsItem::CacheMode mode, const QSize &logicalCacheSize)

void	setCursor (const QCursor &cursor)

void	setData (int key, const QVariant &value)

void	setEnabled (bool enabled)

void	setFiltersChildEvents (bool enabled)

void	setFlag (QGraphicsItem::GraphicsItemFlag flag, bool enabled)

void	setFlags (QGraphicsItem::GraphicsItemFlags flags)

void	setFocus (Qt::FocusReason focusReason)

void	setFocusProxy (QGraphicsItem *item)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setGroup (QGraphicsItemGroup *group)

void	setHandlesChildEvents (bool enabled)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setMatrix (const QMatrix &matrix, bool combine)

void	setOpacity (qreal opacity)

void	setPanelModality (QGraphicsItem::PanelModality panelModality)

void	setParentItem (QGraphicsItem *newParent)

void	setPos (const QPointF &pos)

void	setPos (qreal x, qreal y)

void	setRotation (qreal angle)

void	setScale (qreal factor)

void	setSelected (bool selected)

void	setToolTip (const QString &toolTip)

void	setTransform (const QTransform &matrix, bool combine)

void	setTransformations (const QList< QGraphicsTransform * > &transformations)

void	setTransformOriginPoint (const QPointF &origin)

void	setTransformOriginPoint (qreal x, qreal y)

void	setVisible (bool visible)

void	setX (qreal x)

void	setY (qreal y)

void	setZValue (qreal z)

virtual QPainterPath	shape () const const

void	shear (qreal sh, qreal sv)

void	show ()

void	stackBefore (const QGraphicsItem *sibling)

QGraphicsObject *	toGraphicsObject ()

const QGraphicsObject *	toGraphicsObject () const const

QString	toolTip () const const

QGraphicsItem *	topLevelItem () const const

QGraphicsWidget *	topLevelWidget () const const

QTransform	transform () const const

QList< QGraphicsTransform * >	transformations () const const

QPointF	transformOriginPoint () const const

void	translate (qreal dx, qreal dy)

virtual int	type () const const

void	ungrabKeyboard ()

void	ungrabMouse ()

void	unsetCursor ()

void	update (const QRectF &rect)

void	update (qreal x, qreal y, qreal width, qreal height)

QGraphicsWidget *	window () const const

qreal	x () const const

qreal	y () const const

qreal	zValue () const const

Additional Inherited Members
Public Types inherited from QGraphicsItem
enum	anonymous

enum	CacheMode

enum	GraphicsItemChange

enum	GraphicsItemFlag

enum	PanelModality

Public Attributes inherited from QGraphicsItem
	DeviceCoordinateCache

typedef	GraphicsItemFlags

	ItemAcceptsInputMethod

	ItemChildAddedChange

	ItemChildRemovedChange

	ItemClipsChildrenToShape

	ItemClipsToShape

	ItemContainsChildrenInShape

	ItemCoordinateCache

	ItemCursorChange

	ItemCursorHasChanged

	ItemDoesntPropagateOpacityToChildren

	ItemEnabledChange

	ItemEnabledHasChanged

	ItemFlagsChange

	ItemFlagsHaveChanged

	ItemHasNoContents

	ItemIgnoresParentOpacity

	ItemIgnoresTransformations

	ItemIsFocusable

	ItemIsFocusScope

	ItemIsMovable

	ItemIsPanel

	ItemIsSelectable

	ItemMatrixChange

	ItemNegativeZStacksBehindParent

	ItemOpacityChange

	ItemOpacityHasChanged

	ItemParentChange

	ItemParentHasChanged

	ItemPositionChange

	ItemPositionHasChanged

	ItemRotationChange

	ItemRotationHasChanged

	ItemScaleChange

	ItemScaleHasChanged

	ItemSceneChange

	ItemSceneHasChanged

	ItemScenePositionHasChanged

	ItemSelectedChange

	ItemSelectedHasChanged

	ItemSendsGeometryChanges

	ItemSendsScenePositionChanges

	ItemStacksBehindParent

	ItemStopsClickFocusPropagation

	ItemStopsFocusHandling

	ItemToolTipChange

	ItemToolTipHasChanged

	ItemTransformChange

	ItemTransformHasChanged

	ItemTransformOriginPointChange

	ItemTransformOriginPointHasChanged

	ItemUsesExtendedStyleOption

	ItemVisibleChange

	ItemVisibleHasChanged

	ItemZValueChange

	ItemZValueHasChanged

	NoCache

	NonModal

	PanelModal

	SceneModal

	Type

	UserType

Protected Member Functions inherited from QGraphicsItem
virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

virtual void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	hoverEnterEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

virtual QVariant	itemChange (QGraphicsItem::GraphicsItemChange change, const QVariant &value)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)

virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)

void	prepareGeometryChange ()

virtual bool	sceneEvent (QEvent *event)

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)

void	updateMicroFocus ()

virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)

Detailed Description

Rich text item, based on QTextDocument.

Compared to QGraphicsTextItem, this class has an enclosing rectangle, margins, and can be rotated in all four directions.

Constructor & Destructor Documentation

◆ BpsGraphicsRichtextItem()

BpsGraphicsRichtextItem::BpsGraphicsRichtextItem ( QGraphicsItem * aParent = nullptr )

Constructor for the class.

Parameters

aParent Parent item.

Member Function Documentation

◆ defaultFont()

QFont BpsGraphicsRichtextItem::defaultFont ( ) const

Returns: The current default font.

◆ direction()

Bps::Direction BpsGraphicsRichtextItem::direction ( ) const

Returns: Returns the direction in which the text reads.

◆ handleRect()

QRectF BpsGraphicsRichtextItem::handleRect ( ) const

Returns: Returns the handle rectangle. For the rich text item this is identical to the frame shape.

◆ margins()

BpsMargins BpsGraphicsRichtextItem::margins ( ) const

Returns: Get the current margins.

◆ resolution()

int BpsGraphicsRichtextItem::resolution ( ) const

Returns: Returns the current resolution. 0 stands for default (screen) resolution.

◆ roundness()

int BpsGraphicsRichtextItem::roundness ( ) const

Returns: Get the current roundness.

◆ setDefaultFont()

void BpsGraphicsRichtextItem::setDefaultFont ( const QFont & aFont )

Set a new default fond.

This font will be used for plain text and otherwise unformatted html text.

Parameters

aFont The default font to set.

◆ setDirection()

void BpsGraphicsRichtextItem::setDirection ( Bps::Direction aDirection )

Set the new text direction.

Default is east.

Parameters

aDirection The new direction to set.

◆ setHtml()

void BpsGraphicsRichtextItem::setHtml ( const QString & aText )

Set new content as html code.

Parameters

aText The new content.

◆ setMargins()

void BpsGraphicsRichtextItem::setMargins ( const BpsMargins & aMargins )

Set new margins.

Parameters

aMargins The new margins to set.

◆ setPlainText()

void BpsGraphicsRichtextItem::setPlainText ( const QString & aText )

Set new content as plain text.

Parameters

aText The new content to set.

◆ setResolution()

void BpsGraphicsRichtextItem::setResolution ( int aResolution )

Set the new resolution in DPI.

Parameters

aResolution The new resolution to set.

◆ setRoundness()

void BpsGraphicsRichtextItem::setRoundness ( int aRoundness )

Define a new roundness for the rectangle corners.

The roundness is expressed in percent and can range from 0 to 100, where 0 is no roundness and 100 is maximum. The radius is calculated as percentage of the half of the shorter side of the rectangle.

Parameters

aRoundness The new roundness to set.

◆ setTextWidth()

void BpsGraphicsRichtextItem::setTextWidth ( qreal aWidth )

Set the new text width.

The height is calculated automatically depending on the amount of text.

Parameters

aWidth The new text width (excluding margins).

◆ textWidth()

qreal BpsGraphicsRichtextItem::textWidth ( ) const

Returns: Get the current text width.

◆ toHtml()

QString BpsGraphicsRichtextItem::toHtml ( ) const

Returns: Return the current content as html.

◆ toPlainText()

QString BpsGraphicsRichtextItem::toPlainText ( ) const

Returns: Return the current content as plain text, stripping any html.

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

bpsgraphicsitem.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BpsGraphicsRichtextItem()

Member Function Documentation

◆ defaultFont()

◆ direction()

◆ handleRect()

◆ margins()

◆ resolution()

◆ roundness()

◆ setDefaultFont()

◆ setDirection()

◆ setHtml()

◆ setMargins()

◆ setPlainText()

◆ setResolution()

◆ setRoundness()

◆ setTextWidth()

◆ textWidth()

◆ toHtml()

◆ toPlainText()