PlasmaQuick::PopupPlasmaWindow Class Reference

#include <popupplasmawindow.h>

Inheritance diagram for PlasmaQuick::PopupPlasmaWindow:

Public Types
enum	RemoveBorder { Never = 0x0 , AtScreenEdges = 0x1 , AtPanelEdges = 0x2 }
typedef QFlags< RemoveBorder >	RemoveBorders

Properties
bool	animated
Qt::Edge	effectivePopupDirection
bool	floating
int	margin
Qt::Edge	popupDirection
RemoveBorders	removeBorderStrategy
QQuickItem *	visualParent

Signals
void	animatedChanged ()
void	effectivePopupDirectionChanged ()
void	floatingChanged ()
void	marginChanged ()
void	nearbyBordersChanged ()
void	popupDirectionChanged ()
void	removeBorderStrategyChanged ()
void	visualParentChanged ()

Public Member Functions
	PopupPlasmaWindow (const QString &svgPrefix=QStringLiteral("dialogs/background"))
bool	animated () const
Qt::Edge	effectivePopupDirection () const
bool	event (QEvent *event) override
bool	floating () const
int	margin () const
Qt::Edges	nearbyBorders () const
Qt::Edge	popupDirection () const
	Q_ENUM (RemoveBorder)
RemoveBorders	removeBorderStrategy () const
void	setAnimated (bool animated)
void	setFloating (bool floating)
void	setMargin (int margin)
void	setPopupDirection (Qt::Edge popupDirection)
void	setRemoveBorderStrategy (RemoveBorders borders)
void	setVisualParent (QQuickItem *parent)
QQuickItem *	visualParent () const

Protected Slots
void	queuePositionUpdate ()

Detailed Description

The PopupPlasmaWindow class is a styled Plasma window that can be positioned relative to an existing Item on another window.

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

Definition at line 24 of file popupplasmawindow.h.

Member Typedef Documentation

RemoveBorders

QFlags< RemoveBorder > PlasmaQuick::PopupPlasmaWindow::RemoveBorders

Definition at line 67 of file popupplasmawindow.h.

Member Enumeration Documentation

RemoveBorder

enum PlasmaQuick::PopupPlasmaWindow::RemoveBorder

Definition at line 66 of file popupplasmawindow.h.

Property Documentation

animated

bool PlasmaQuick::PopupPlasmaWindow::animated

readwrite

Defines whether the popup is animated on show and close.

The default is false.

Definition at line 53 of file popupplasmawindow.h.

effectivePopupDirection

Qt::Edge PlasmaQuick::PopupPlasmaWindow::effectivePopupDirection

read

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.

Definition at line 43 of file popupplasmawindow.h.

floating

bool PlasmaQuick::PopupPlasmaWindow::floating

readwrite

Defines whether the popup can appaer (float) over the parent window.

The default is false.

Definition at line 48 of file popupplasmawindow.h.

margin

int PlasmaQuick::PopupPlasmaWindow::margin

readwrite

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

Definition at line 63 of file popupplasmawindow.h.

popupDirection

Qt::Edge PlasmaQuick::PopupPlasmaWindow::popupDirection

readwrite

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

Definition at line 36 of file popupplasmawindow.h.

removeBorderStrategy

RemoveBorders PlasmaQuick::PopupPlasmaWindow::removeBorderStrategy

readwrite

Defines which borders should be enabled/disabled when the popup is shown.

The default is to show all borders

Definition at line 58 of file popupplasmawindow.h.

visualParent

QQuickItem * PlasmaQuick::PopupPlasmaWindow::visualParent

readwrite

The anchor item to place the popup relative to.

Definition at line 31 of file popupplasmawindow.h.

Constructor & Destructor Documentation

PopupPlasmaWindow()

PlasmaQuick::PopupPlasmaWindow::PopupPlasmaWindow

(

const QString &

svgPrefix = QStringLiteral("dialogs/background")

)

Definition at line 281 of file popupplasmawindow.cpp.

~PopupPlasmaWindow()

PlasmaQuick::PopupPlasmaWindow::~PopupPlasmaWindow ( )

override

Definition at line 287 of file popupplasmawindow.cpp.

Member Function Documentation

animated()

bool PlasmaQuick::PopupPlasmaWindow::animated

(

)

const

Definition at line 357 of file popupplasmawindow.cpp.

effectivePopupDirection()

Qt::Edge PlasmaQuick::PopupPlasmaWindow::effectivePopupDirection

(

)

const

Definition at line 337 of file popupplasmawindow.cpp.

event()

bool PlasmaQuick::PopupPlasmaWindow::event ( QEvent * event )

overridevirtual

Reimplemented from QQuickWindow.

Definition at line 406 of file popupplasmawindow.cpp.

floating()

bool PlasmaQuick::PopupPlasmaWindow::floating

(

)

const

Definition at line 342 of file popupplasmawindow.cpp.

margin()

int PlasmaQuick::PopupPlasmaWindow::margin

(

)

const

Definition at line 385 of file popupplasmawindow.cpp.

nearbyBorders()

Qt::Edges PlasmaQuick::PopupPlasmaWindow::nearbyBorders

(

)

const

Definition at line 390 of file popupplasmawindow.cpp.

popupDirection()

Qt::Edge PlasmaQuick::PopupPlasmaWindow::popupDirection

(

)

const

Definition at line 317 of file popupplasmawindow.cpp.

queuePositionUpdate

void PlasmaQuick::PopupPlasmaWindow::queuePositionUpdate ( )

protectedslot

Definition at line 426 of file popupplasmawindow.cpp.

removeBorderStrategy()

PopupPlasmaWindow::RemoveBorders PlasmaQuick::PopupPlasmaWindow::removeBorderStrategy

(

)

const

Definition at line 369 of file popupplasmawindow.cpp.

setAnimated()

void PlasmaQuick::PopupPlasmaWindow::setAnimated

(

bool

animated

)

Definition at line 362 of file popupplasmawindow.cpp.

setFloating()

void PlasmaQuick::PopupPlasmaWindow::setFloating

(

bool

floating

)

Definition at line 347 of file popupplasmawindow.cpp.

setMargin()

void PlasmaQuick::PopupPlasmaWindow::setMargin

(

int

margin

)

Definition at line 395 of file popupplasmawindow.cpp.

setPopupDirection()

void PlasmaQuick::PopupPlasmaWindow::setPopupDirection

(

Qt::Edge

popupDirection

)

Definition at line 322 of file popupplasmawindow.cpp.

setRemoveBorderStrategy()

void PlasmaQuick::PopupPlasmaWindow::setRemoveBorderStrategy

(

PopupPlasmaWindow::RemoveBorders

strategy

)

Definition at line 374 of file popupplasmawindow.cpp.

setVisualParent()

void PlasmaQuick::PopupPlasmaWindow::setVisualParent

(

QQuickItem *

parent

)

Definition at line 291 of file popupplasmawindow.cpp.

visualParent()

QQuickItem * PlasmaQuick::PopupPlasmaWindow::visualParent

(

)

const

Definition at line 312 of file popupplasmawindow.cpp.

---

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

• popupplasmawindow.h
• popupplasmawindow.cpp