Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

PlasmaQuick::PopupPlasmaWindow Class

Styled Plasma window that can be positioned relative to an existing Item on another window. More...

• Header: #include <PlasmaQuick/PopupPlasmaWindow>
• CMake: find_package(PlasmaQuick REQUIRED)
target_link_libraries(mytarget PRIVATE Plasma::PlasmaQuick)
• Inherits: PlasmaQuick::PlasmaWindow
• Inherited By: PlasmaQuick::AppletPopup

List of all members, including inherited members

#Properties

• animated : bool
• [read-only] effectivePopupDirection : Qt::Edge
• floating : bool
• margin : int
• popupDirection : Qt::Edge
• removeBorderStrategy : RemoveBorders
• visualParent : QQuickItem*

#Public Functions

• PopupPlasmaWindow(const QString &svgPrefix = QStringLiteral("dialogs/background"))

#Detailed Description

When shown the popup is placed correctly.

On Wayland this is currently an XdgTopLevel with the PlasmaShellSurface used on top. Do not rely on that implementation detail

#Property Documentation

#animated : bool

Defines whether the popup is animated on show and close. The default is false.

Access functions:

• bool animated() const
• void setAnimated(bool animated)

Notifier signal:

• void animatedChanged()

#[read-only] effectivePopupDirection : Qt::Edge

Defines the direction the popup was placed relative to the visualParent. This property is read-only and is updated when the popup is shown. The value whilst the popup is hidden is undefined.

Access functions:

• Qt::Edge effectivePopupDirection() const

Notifier signal:

• void effectivePopupDirectionChanged()

#floating : bool

Defines whether the popup can appear (float) over the parent window. The default is false.

Access functions:

• bool floating() const
• void setFloating(bool floating)

Notifier signal:

• void floatingChanged()

#margin : int

If set provides a gap between the parent window and all screen edges

Access functions:

• int margin() const
• void setMargin(int margin)

Notifier signal:

• void marginChanged()

#popupDirection : Qt::Edge

Defines the default direction to place the popup relative to the visualParent.

Access functions:

• Qt::Edge popupDirection() const
• void setPopupDirection(Qt::Edge popupDirection)

Notifier signal:

• void popupDirectionChanged()

#removeBorderStrategy : RemoveBorders

Defines which borders should be enabled/disabled when the popup is shown. The default is to show all borders

Access functions:

• PlasmaQuick::PopupPlasmaWindow::RemoveBorders removeBorderStrategy() const
• void setRemoveBorderStrategy(PlasmaQuick::PopupPlasmaWindow::RemoveBorders borders)

Notifier signal:

• void removeBorderStrategyChanged()

#visualParent : QQuickItem*

The anchor item to place the popup relative to.

Access functions:

• QQuickItem *visualParent() const
• void setVisualParent(QQuickItem *parent)

Notifier signal:

• void visualParentChanged()

#Member Function Documentation

#PopupPlasmaWindow::PopupPlasmaWindow(const QString &svgPrefix = QStringLiteral("dialogs/background"))

Constructor