Search for usage in LXR

Plasma::FrameSvgItem Class Reference

#include <framesvgitem.h>

Inheritance diagram for Plasma::FrameSvgItem:


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
- Properties inherited from QObject


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)
QQuickItemchildAt (qreal x, qreal y) const const
QList< QQuickItem * > childItems () const const
QRectF childrenRect ()
void childrenRectChanged (const QRectF &)
bool clip () const const
void clipChanged (bool)
QObjectcontainmentMask () 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< QQuickItemGrabResultgrabToImage (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
QQuickItemnextItemInFocusChain (bool forward)
qreal opacity () const const
void opacityChanged ()
void parentChanged (QQuickItem *)
QQuickItemparentItem () const const
void polish ()
void resetAntialiasing ()
void resetHeight ()
void resetWidth ()
qreal rotation () const const
void rotationChanged ()
qreal scale () const const
void scaleChanged ()
QQuickItemscopedFocusItem () 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 QSGTextureProvidertextureProvider () 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 ()
QQuickWindowwindow () 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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
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 QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
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)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
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)
QThreadthread () 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
typedef Flags
- 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 QSGNodeupdatePaintNode (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
QObjectsender () 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

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

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

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

See also

Definition at line 136 of file framesvgitem.h.

◆ fromCurrentTheme

bool Plasma::FrameSvgItem::fromCurrentTheme

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

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

Definition at line 106 of file framesvgitem.h.

◆ inset

FrameSvgItemMargins * Plasma::FrameSvgItem::inset

The inset of the frame read only.

See also

Definition at line 144 of file framesvgitem.h.

◆ margins

FrameSvgItemMargins * Plasma::FrameSvgItem::margins

The margins of the frame, read only.

See also

Definition at line 129 of file framesvgitem.h.

◆ mask

QRegion Plasma::FrameSvgItem::mask

The mask that tightly contains the painted areas.


Definition at line 185 of file framesvgitem.h.

◆ minimumDrawingHeight

int Plasma::FrameSvgItem::minimumDrawingHeight

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


Definition at line 192 of file framesvgitem.h.

◆ minimumDrawingWidth

int Plasma::FrameSvgItem::minimumDrawingWidth

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


Definition at line 199 of file framesvgitem.h.

◆ prefix

QVariant Plasma::FrameSvgItem::prefix

prefix for the 9 piece svg, like "pushed" or "normal" for the button see 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


Definition at line 117 of file framesvgitem.h.

◆ status

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

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

Definition at line 179 of file framesvgitem.h.

◆ usedPrefix

QString Plasma::FrameSvgItem::usedPrefix

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


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

Definition at line 489 of file framesvgitem.cpp.

◆ hasElementPrefix()

bool Plasma::FrameSvgItem::hasElementPrefix ( const QString prefix) const
true if the svg has the necessary elements with the given prefix to draw a frame
prefixthe 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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:07:39 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.