Plasma::FrameSvgItem

#include <framesvgitem.h>

Inheritance diagram for Plasma::FrameSvgItem:

[legend]

Properties
Plasma::Theme::ColorGroup	colorGroup

Plasma::FrameSvg::EnabledBorders	enabledBorders

QObject	fixedMargins

bool	fromCurrentTheme

QString	imagePath

QObject	inset

QObject	margins

QRegion	mask

int	minimumDrawingHeight

int	minimumDrawingWidth

QVariant	prefix

Plasma::Svg::Status	status

QString	usedPrefix

Properties inherited from QQuickItem
	activeFocus

	activeFocusOnTab

	antialiasing

	baselineOffset

	childrenRect

	clip

	enabled

	focus

	height

	implicitHeight

	implicitWidth

	opacity

	parent

	rotation

	scale

	smooth

	state

	transformOrigin

	visible

	width

	x

	y

	z

Properties inherited from QObject
	objectName

Signals
void	colorGroupChanged ()

void	enabledBordersChanged ()

void	fromCurrentThemeChanged ()

void	imagePathChanged ()

void	maskChanged ()

void	prefixChanged ()

void	repaintNeeded ()

void	statusChanged ()

void	usedPrefixChanged ()

Public Member Functions
Q_INVOKABLE bool	hasElement (const QString &elementName) const

Q_INVOKABLE bool	hasElementPrefix (const QString &prefix) const

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)

Qt::MouseButtons	acceptedMouseButtons () const const

bool	acceptHoverEvents () const const

bool	acceptTouchEvents () const const

void	activeFocusChanged (bool)

bool	activeFocusOnTab () const const

void	activeFocusOnTabChanged (bool)

bool	antialiasing () const const

void	antialiasingChanged (bool)

qreal	baselineOffset () const const

void	baselineOffsetChanged (qreal)

QQuickItem *	childAt (qreal x, qreal y) const const

QList< QQuickItem * >	childItems () const const

QRectF	childrenRect ()

void	childrenRectChanged (const QRectF &)

bool	clip () const const

void	clipChanged (bool)

QObject *	containmentMask () const const

void	containmentMaskChanged ()

virtual bool	contains (const QPointF &point) const const

QCursor	cursor () const const

void	enabledChanged ()

bool	filtersChildMouseEvents () const const

QQuickItem::Flags	flags () const const

void	focusChanged (bool)

void	forceActiveFocus ()

void	forceActiveFocus (Qt::FocusReason reason)

void	grabMouse ()

QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize)

void	grabTouchPoints (const QVector< int > &ids)

bool	hasActiveFocus () const const

bool	hasFocus () const const

qreal	height () const const

void	heightChanged ()

qreal	implicitHeight () const const

void	implicitHeightChanged ()

qreal	implicitWidth () const const

void	implicitWidthChanged ()

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

bool	isAncestorOf (const QQuickItem *child) const const

bool	isEnabled () const const

bool	isFocusScope () const const

virtual bool	isTextureProvider () const const

bool	isVisible () const const

bool	keepMouseGrab () const const

bool	keepTouchGrab () const const

QPointF	mapFromGlobal (const QPointF &point) const const

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

QPointF	mapFromScene (const QPointF &point) const const

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

QRectF	mapRectFromScene (const QRectF &rect) const const

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

QRectF	mapRectToScene (const QRectF &rect) const const

QPointF	mapToGlobal (const QPointF &point) const const

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

QPointF	mapToScene (const QPointF &point) const const

QQuickItem *	nextItemInFocusChain (bool forward)

qreal	opacity () const const

void	opacityChanged ()

void	parentChanged (QQuickItem *)

QQuickItem *	parentItem () const const

void	polish ()

void	resetAntialiasing ()

void	resetHeight ()

void	resetWidth ()

qreal	rotation () const const

void	rotationChanged ()

qreal	scale () const const

void	scaleChanged ()

QQuickItem *	scopedFocusItem () const const

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActiveFocusOnTab (bool)

void	setAntialiasing (bool)

void	setBaselineOffset (qreal)

void	setClip (bool)

void	setContainmentMask (QObject *mask)

void	setCursor (const QCursor &cursor)

void	setEnabled (bool)

void	setFiltersChildMouseEvents (bool filter)

void	setFlag (QQuickItem::Flag flag, bool enabled)

void	setFlags (QQuickItem::Flags flags)

void	setFocus (bool focus, Qt::FocusReason reason)

void	setFocus (bool)

void	setHeight (qreal)

void	setImplicitHeight (qreal)

void	setImplicitWidth (qreal)

void	setKeepMouseGrab (bool keep)

void	setKeepTouchGrab (bool keep)

void	setOpacity (qreal)

void	setParentItem (QQuickItem *parent)

void	setRotation (qreal)

void	setScale (qreal)

void	setSize (const QSizeF &size)

void	setSmooth (bool)

void	setState (const QString &)

void	setTransformOrigin (QQuickItem::TransformOrigin)

void	setVisible (bool)

void	setWidth (qreal)

void	setX (qreal)

void	setY (qreal)

void	setZ (qreal)

QSizeF	size () const const

bool	smooth () const const

void	smoothChanged (bool)

void	stackAfter (const QQuickItem *sibling)

void	stackBefore (const QQuickItem *sibling)

QString	state () const const

void	stateChanged (const QString &)

virtual QSGTextureProvider *	textureProvider () const const

QQuickItem::TransformOrigin	transformOrigin () const const

void	transformOriginChanged (QQuickItem::TransformOrigin)

void	ungrabMouse ()

void	ungrabTouchPoints ()

void	unsetCursor ()

void	update ()

void	visibleChanged ()

qreal	width () const const

void	widthChanged ()

QQuickWindow *	window () const const

void	windowChanged (QQuickWindow *window)

qreal	x () const const

void	xChanged ()

qreal	y () const const

void	yChanged ()

qreal	z () const const

void	zChanged ()

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QQuickItem
enum	Flag

enum	ItemChange

enum	TransformOrigin

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QQuickItem
	Bottom

	BottomLeft

	BottomRight

	Center

typedef	Flags

	ItemAcceptsDrops

	ItemAcceptsInputMethod

	ItemActiveFocusHasChanged

	ItemAntialiasingHasChanged

	ItemChildAddedChange

	ItemChildRemovedChange

	ItemClipsChildrenToShape

	ItemDevicePixelRatioHasChanged

	ItemEnabledHasChanged

	ItemHasContents

	ItemIsFocusScope

	ItemOpacityHasChanged

	ItemParentHasChanged

	ItemRotationHasChanged

	ItemSceneChange

	ItemVisibleHasChanged

	Left

	Right

	Top

	TopLeft

	TopRight

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QQuickItem
virtual bool	childMouseEventFilter (QQuickItem item, QEvent event)

virtual void	classBegin () override

virtual void	componentComplete () override

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual bool	event (QEvent *ev) override

virtual void	focusInEvent (QFocusEvent *)

virtual void	focusOutEvent (QFocusEvent *)

virtual void	geometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry)

bool	heightValid () const const

virtual void	hoverEnterEvent (QHoverEvent *event)

virtual void	hoverLeaveEvent (QHoverEvent *event)

virtual void	hoverMoveEvent (QHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

bool	isComponentComplete () const const

virtual void	itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseUngrabEvent ()

virtual void	releaseResources ()

virtual void	touchEvent (QTouchEvent *event)

virtual void	touchUngrabEvent ()

void	updateInputMethod (Qt::InputMethodQueries queries)

virtual QSGNode *	updatePaintNode (QSGNode oldNode, QQuickItem::UpdatePaintNodeData updatePaintNodeData)

virtual void	updatePolish ()

virtual void	wheelEvent (QWheelEvent *event)

bool	widthValid () const const

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Provides an SVG with borders.

It is exposed as org.kde.plasma.core.FrameSvgItem

Definition at line 98 of file framesvgitem.h.

Property Documentation

◆ colorGroup

Plasma::Theme::ColorGroup Plasma::FrameSvgItem::colorGroup

readwrite

Set a color group for the FrameSvgItem.

if the Svg uses stylesheets and has elements that are either TextColor or BackgroundColor class, make them use ButtonTextColor/ButtonBackgroundColor or ViewTextColor/ViewBackgroundColor, ComplementaryTextColor etc.

Definition at line 168 of file framesvgitem.h.

◆ enabledBorders

Plasma::FrameSvg::EnabledBorders Plasma::FrameSvgItem::enabledBorders

readwrite

The borders that will be rendered, it's a flag combination of: NoBorder TopBorder BottomBorder LeftBorder RightBorder.

Definition at line 154 of file framesvgitem.h.

◆ fixedMargins

FrameSvgItemMargins * Plasma::FrameSvgItem::fixedMargins

read

The margins of the frame, regardless if they are enabled or not read only.

See also: FrameSvgItemMargins

Definition at line 136 of file framesvgitem.h.

◆ fromCurrentTheme

bool Plasma::FrameSvgItem::fromCurrentTheme

read

Holds whether the current svg is present in the current theme and NO fallback is involved.

Definition at line 159 of file framesvgitem.h.

◆ imagePath

QString Plasma::FrameSvgItem::imagePath

readwrite

Theme relative path of the svg, like "widgets/background".

Definition at line 106 of file framesvgitem.h.

◆ inset

FrameSvgItemMargins * Plasma::FrameSvgItem::inset

read

The inset of the frame read only.

See also: FrameSvgItemMargins

Since: 5.77

Definition at line 144 of file framesvgitem.h.

◆ margins

FrameSvgItemMargins * Plasma::FrameSvgItem::margins

read

The margins of the frame, read only.

See also: FrameSvgItemMargins

Definition at line 129 of file framesvgitem.h.

◆ mask

QRegion Plasma::FrameSvgItem::mask

read

The mask that tightly contains the painted areas.

Since: 5.58

Definition at line 185 of file framesvgitem.h.

◆ minimumDrawingHeight

int Plasma::FrameSvgItem::minimumDrawingHeight

read

This will return the minimum height required to correctly draw this SVG.

Since: 5.101

Definition at line 192 of file framesvgitem.h.

◆ minimumDrawingWidth

int Plasma::FrameSvgItem::minimumDrawingWidth

read

This will return the minimum width required to correctly draw this SVG.

Since: 5.101

Definition at line 199 of file framesvgitem.h.

◆ prefix

QVariant Plasma::FrameSvgItem::prefix

readwrite

prefix for the 9 piece svg, like "pushed" or "normal" for the button see https://techbase.kde.org/Development/Tutorials/Plasma5/ThemeDetails for a list of paths and prefixes It can also be an array of strings, specifying a fallback chain in case the first element isn't found in the theme, eg ["toolbutton-normal", "normal"] so it's easy to keep backwards compatibility with old themes (Note: fallback chain is supported only

Since: 5.32)

Definition at line 117 of file framesvgitem.h.

◆ status

Plasma::Svg::Status Plasma::FrameSvgItem::status

readwrite

Sets the image in a selected status.

Svgs can be colored with system color themes, if the status is selected, the TextColor will become HighlightedText color and BackgroundColor will become HighlightColor, making the svg graphics (for instance an icon) will look correct together selected text

See also: Plasma::Svg::status

Since: 5.23

Definition at line 179 of file framesvgitem.h.

◆ usedPrefix

QString Plasma::FrameSvgItem::usedPrefix

read

the actual prefix that was used, if a fallback chain array was set as "prefix"

Since: 5.34

Definition at line 123 of file framesvgitem.h.

Member Function Documentation

◆ hasElement()

bool Plasma::FrameSvgItem::hasElement ( const QString & elementName ) const

Check if the SVG has a certain element.

This is a convenience function that forwards to Svg::hasElement.

See also: Svg::hasElement

Definition at line 489 of file framesvgitem.cpp.

◆ hasElementPrefix()

bool Plasma::FrameSvgItem::hasElementPrefix ( const QString & prefix ) const

Returns: true if the svg has the necessary elements with the given prefix to draw a frame

Parameters

prefix the given prefix we want to check if drawable

Definition at line 484 of file framesvgitem.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Plasma

Plasma::FrameSvgItem

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ colorGroup

◆ enabledBorders

◆ fixedMargins

◆ fromCurrentTheme

◆ imagePath

◆ inset

◆ margins

◆ mask

◆ minimumDrawingHeight

◆ minimumDrawingWidth

◆ prefix

◆ status

◆ usedPrefix

Member Function Documentation

◆ hasElement()

◆ hasElementPrefix()