Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

PlasmaQuick::PlasmaWindow Class

Creates a QQuickWindow themed in a Plasma style with background. More...

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

List of all members, including inherited members

#Public Types

• enum PlasmaWindow::BackgroundHints

#Properties

• backgroundHints : BackgroundHints
• borders : Qt::Edges
• [read-only] bottomPadding : qreal
• [read-only] leftPadding : qreal
• mainItem : QQuickItem*
• [read-only] rightPadding : qreal
• [read-only] topPadding : qreal

#Public Functions

• QMargins padding() const
• void setBorders(Qt::Edges bordersToShow)
• void setMainItem(QQuickItem *mainItem)

#Detailed Description

#Member Type Documentation

#enum PlasmaWindow::BackgroundHints

Constant	Value	Description
PlasmaQuick::PlasmaWindow::StandardBackground	0	The standard background from the theme is drawn
PlasmaQuick::PlasmaWindow::SolidBackground	1	The solid version of the background is preferred

#Property Documentation

#backgroundHints : BackgroundHints

Defines the background used for the window

Access functions:

• PlasmaQuick::PlasmaWindow::BackgroundHints backgroundHints() const
• void setBackgroundHints(PlasmaQuick::PlasmaWindow::BackgroundHints hints)

Notifier signal:

• void backgroundHintsChanged()

#borders : Qt::Edges

Tells what borders are enabled of its background

Access functions:

• Qt::Edges borders()
• void setBorders(Qt::Edges bordersToShow)

Notifier signal:

• void bordersChanged()

#[read-only] bottomPadding : qreal

Access functions:

• qreal bottomPadding() const

Notifier signal:

• void paddingChanged()

#[read-only] leftPadding : qreal

Access functions:

• qreal leftPadding() const

Notifier signal:

• void paddingChanged()

#mainItem : QQuickItem*

The main QML item that will be displayed in the Dialog

Access functions:

• QQuickItem *mainItem() const
• void setMainItem(QQuickItem *mainItem)

Notifier signal:

• void mainItemChanged()

#[read-only] rightPadding : qreal

Access functions:

• qreal rightPadding() const

Notifier signal:

• void paddingChanged()

#[read-only] topPadding : qreal

Access functions:

• qreal topPadding() const

Notifier signal:

• void paddingChanged()

#Member Function Documentation

#QMargins PlasmaWindow::padding() const

Returns the padding that are placed around the mainItem When setting size hints on the window this should be factored in.

#void PlasmaWindow::setBorders(Qt::Edges bordersToShow)

Changes which rounded corners are shown on the window. Margins remain the same The default is all borders

Note: Setter function for property borders.

See also borders()

#void PlasmaWindow::setMainItem(QQuickItem *mainItem)

The main QML item that will be displayed in the Dialog

Note: Setter function for property mainItem.

See also mainItem()