KWin::PlasmaWindowInterface Class Reference

#include <plasmawindowmanagement.h>

Inheritance diagram for KWin::PlasmaWindowInterface:

Signals
void	closeRequested ()
void	moveRequested ()
void	resizeRequested ()
void	activeRequested (bool set)
void	minimizedRequested (bool set)
void	maximizedRequested (bool set)
void	fullscreenRequested (bool set)
void	keepAboveRequested (bool set)
void	keepBelowRequested (bool set)
void	demandsAttentionRequested (bool set)
void	closeableRequested (bool set)
void	minimizeableRequested (bool set)
void	maximizeableRequested (bool set)
void	fullscreenableRequested (bool set)
void	skipTaskbarRequested (bool set)
void	skipSwitcherRequested (bool set)
QRect	minimizedGeometriesChanged ()
void	shadeableRequested (bool set)
void	shadedRequested (bool set)
void	movableRequested (bool set)
void	resizableRequested (bool set)
void	virtualDesktopChangeableRequested (bool set)
void	enterPlasmaVirtualDesktopRequested (const QString &desktop)
void	enterNewPlasmaVirtualDesktopRequested ()
void	leavePlasmaVirtualDesktopRequested (const QString &desktop)
void	enterPlasmaActivityRequested (const QString &activity)
void	leavePlasmaActivityRequested (const QString &activity)
void	sendToOutput (KWin::OutputInterface *output)

Public Member Functions
	~PlasmaWindowInterface () override
void	setTitle (const QString &title)
void	setAppId (const QString &appId)
void	setPid (quint32 pid)
void	setActive (bool set)
void	setMinimized (bool set)
void	setMaximized (bool set)
void	setFullscreen (bool set)
void	setKeepAbove (bool set)
void	setKeepBelow (bool set)
void	setOnAllDesktops (bool set)
void	setDemandsAttention (bool set)
void	setCloseable (bool set)
void	setMinimizeable (bool set)
void	setMaximizeable (bool set)
void	setFullscreenable (bool set)
void	setSkipTaskbar (bool skip)
void	setSkipSwitcher (bool skip)
void	setShadeable (bool set)
void	setShaded (bool set)
void	setMovable (bool set)
void	setResizable (bool set)
void	setResourceName (const QString &resourceName)
void	setVirtualDesktopChangeable (bool set)
void	unmap ()
QHash< SurfaceInterface *, QRect >	minimizedGeometries () const
void	setParentWindow (PlasmaWindowInterface *parentWindow)
void	setGeometry (const QRect &geometry)
void	setIcon (const QIcon &icon)
void	addPlasmaVirtualDesktop (const QString &id)
void	removePlasmaVirtualDesktop (const QString &id)
QStringList	plasmaVirtualDesktops () const
void	addPlasmaActivity (const QString &id)
void	removePlasmaActivity (const QString &id)
QStringList	plasmaActivities () const
void	setApplicationMenuPaths (const QString &serviceName, const QString &objectPath)
quint32	internalId () const
QString	uuid () const

Friends
class	PlasmaWindowManagementInterface
class	PlasmaWindowInterfacePrivate
class	PlasmaWindowManagementInterfacePrivate

Detailed Description

Todo

Add documentation

Definition at line 106 of file plasmawindowmanagement.h.

Constructor & Destructor Documentation

~PlasmaWindowInterface()

KWin::PlasmaWindowInterface::~PlasmaWindowInterface ( )

overridedefault

Member Function Documentation

activeRequested

void KWin::PlasmaWindowInterface::activeRequested ( bool set )

signal

addPlasmaActivity()

void KWin::PlasmaWindowInterface::addPlasmaActivity

(

const QString &

id

)

Adds an activity to this window: a window can be on an arbitrary subset of activities. If it's on none it will be considered on all activities.

Definition at line 947 of file plasmawindowmanagement.cpp.

addPlasmaVirtualDesktop()

void KWin::PlasmaWindowInterface::addPlasmaVirtualDesktop

(

const QString &

id

)

Adds a new desktop to this window: a window can be on an arbitrary subset of virtual desktops. If it's on none it will be considered on all desktops.

Definition at line 898 of file plasmawindowmanagement.cpp.

closeableRequested

void KWin::PlasmaWindowInterface::closeableRequested ( bool set )

signal

closeRequested

void KWin::PlasmaWindowInterface::closeRequested ( )

signal

demandsAttentionRequested

void KWin::PlasmaWindowInterface::demandsAttentionRequested ( bool set )

signal

enterNewPlasmaVirtualDesktopRequested

void KWin::PlasmaWindowInterface::enterNewPlasmaVirtualDesktopRequested ( )

signal

Emitted when the client wishes this window to enter in a new virtual desktop to be created for it. The server will decide whether to consent this request

enterPlasmaActivityRequested

void KWin::PlasmaWindowInterface::enterPlasmaActivityRequested ( const QString & activity )

signal

Emitted when the client wishes this window to enter an activity. The server will decide whether to consent this request

enterPlasmaVirtualDesktopRequested

void KWin::PlasmaWindowInterface::enterPlasmaVirtualDesktopRequested ( const QString & desktop )

signal

Emitted when the client wishes this window to enter in a new virtual desktop. The server will decide whether to consent this request

fullscreenableRequested

void KWin::PlasmaWindowInterface::fullscreenableRequested ( bool set )

signal

fullscreenRequested

void KWin::PlasmaWindowInterface::fullscreenRequested ( bool set )

signal

internalId()

quint32 KWin::PlasmaWindowInterface::internalId

(

)

const

Return the window internal id

Definition at line 1022 of file plasmawindowmanagement.cpp.

keepAboveRequested

void KWin::PlasmaWindowInterface::keepAboveRequested ( bool set )

signal

keepBelowRequested

void KWin::PlasmaWindowInterface::keepBelowRequested ( bool set )

signal

leavePlasmaActivityRequested

void KWin::PlasmaWindowInterface::leavePlasmaActivityRequested ( const QString & activity )

signal

Emitted when the client wishes to remove this window from an activity. The server will decide whether to consent this request

leavePlasmaVirtualDesktopRequested

void KWin::PlasmaWindowInterface::leavePlasmaVirtualDesktopRequested ( const QString & desktop )

signal

Emitted when the client wishes to remove this window from a virtual desktop. The server will decide whether to consent this request

maximizeableRequested

void KWin::PlasmaWindowInterface::maximizeableRequested ( bool set )

signal

maximizedRequested

void KWin::PlasmaWindowInterface::maximizedRequested ( bool set )

signal

minimizeableRequested

void KWin::PlasmaWindowInterface::minimizeableRequested ( bool set )

signal

minimizedGeometries()

QHash< SurfaceInterface *, QRect > KWin::PlasmaWindowInterface::minimizedGeometries

(

)

const

Returns

Geometries of the taskbar entries, indicized by the surface of the panels

Definition at line 780 of file plasmawindowmanagement.cpp.

minimizedGeometriesChanged

QRect KWin::PlasmaWindowInterface::minimizedGeometriesChanged ( )

signal

minimizedRequested

void KWin::PlasmaWindowInterface::minimizedRequested ( bool set )

signal

movableRequested

void KWin::PlasmaWindowInterface::movableRequested ( bool set )

signal

moveRequested

void KWin::PlasmaWindowInterface::moveRequested ( )

signal

plasmaActivities()

QStringList KWin::PlasmaWindowInterface::plasmaActivities

(

)

const

The ids of all the activities currently associated with this window. When an activity is deleted it will be automatically removed from this list

Definition at line 977 of file plasmawindowmanagement.cpp.

plasmaVirtualDesktops()

QStringList KWin::PlasmaWindowInterface::plasmaVirtualDesktops

(

)

const

The ids of all the desktops currently associated with this window. When a desktop is deleted it will be automatically removed from this list

Definition at line 942 of file plasmawindowmanagement.cpp.

removePlasmaActivity()

void KWin::PlasmaWindowInterface::removePlasmaActivity

(

const QString &

id

)

Removes an activity from a window

Definition at line 963 of file plasmawindowmanagement.cpp.

removePlasmaVirtualDesktop()

void KWin::PlasmaWindowInterface::removePlasmaVirtualDesktop

(

const QString &

id

)

Removes a visrtual desktop from a window

Definition at line 924 of file plasmawindowmanagement.cpp.

resizableRequested

void KWin::PlasmaWindowInterface::resizableRequested ( bool set )

signal

resizeRequested

void KWin::PlasmaWindowInterface::resizeRequested ( )

signal

sendToOutput

void KWin::PlasmaWindowInterface::sendToOutput ( KWin::OutputInterface * output )

signal

Requests sending the window to output

setActive()

void KWin::PlasmaWindowInterface::setActive

(

bool

set

)

Definition at line 785 of file plasmawindowmanagement.cpp.

setAppId()

void KWin::PlasmaWindowInterface::setAppId

(

const QString &

appId

)

Definition at line 760 of file plasmawindowmanagement.cpp.

setApplicationMenuPaths()

void KWin::PlasmaWindowInterface::setApplicationMenuPaths	(	const QString &	serviceName,
		const QString &	objectPath )

Set the application menu D-BUS service name and object path for the window.

Definition at line 1017 of file plasmawindowmanagement.cpp.

setCloseable()

void KWin::PlasmaWindowInterface::setCloseable

(

bool

set

)

Definition at line 858 of file plasmawindowmanagement.cpp.

setDemandsAttention()

void KWin::PlasmaWindowInterface::setDemandsAttention

(

bool

set

)

Definition at line 853 of file plasmawindowmanagement.cpp.

setFullscreen()

void KWin::PlasmaWindowInterface::setFullscreen

(

bool

set

)

Definition at line 790 of file plasmawindowmanagement.cpp.

setFullscreenable()

void KWin::PlasmaWindowInterface::setFullscreenable

(

bool

set

)

Definition at line 863 of file plasmawindowmanagement.cpp.

setGeometry()

void KWin::PlasmaWindowInterface::setGeometry

(

const QRect &

geometry

)

Sets the window geometry of this PlasmaWindow.

Parameters

geometry

The geometry in absolute coordinates

Definition at line 1012 of file plasmawindowmanagement.cpp.

setIcon()

void KWin::PlasmaWindowInterface::setIcon

(

const QIcon &

icon

)

Set the icon of the PlasmaWindowInterface.

In case the icon has a themed name, only the name is sent to the client. Otherwise the client is only informed that there is an icon and the client can request the icon in an asynchronous way by passing a file descriptor into which the icon will be serialized.

Parameters

icon	The new icon

Definition at line 888 of file plasmawindowmanagement.cpp.

setKeepAbove()

void KWin::PlasmaWindowInterface::setKeepAbove

(

bool

set

)

Definition at line 795 of file plasmawindowmanagement.cpp.

setKeepBelow()

void KWin::PlasmaWindowInterface::setKeepBelow

(

bool

set

)

Definition at line 800 of file plasmawindowmanagement.cpp.

setMaximizeable()

void KWin::PlasmaWindowInterface::setMaximizeable

(

bool

set

)

Definition at line 868 of file plasmawindowmanagement.cpp.

setMaximized()

void KWin::PlasmaWindowInterface::setMaximized

(

bool

set

)

Definition at line 805 of file plasmawindowmanagement.cpp.

setMinimizeable()

void KWin::PlasmaWindowInterface::setMinimizeable

(

bool

set

)

Definition at line 873 of file plasmawindowmanagement.cpp.

setMinimized()

void KWin::PlasmaWindowInterface::setMinimized

(

bool

set

)

Definition at line 810 of file plasmawindowmanagement.cpp.

setMovable()

void KWin::PlasmaWindowInterface::setMovable

(

bool

set

)

Definition at line 992 of file plasmawindowmanagement.cpp.

setOnAllDesktops()

void KWin::PlasmaWindowInterface::setOnAllDesktops

(

bool

set

)

Definition at line 815 of file plasmawindowmanagement.cpp.

setParentWindow()

void KWin::PlasmaWindowInterface::setParentWindow

(

PlasmaWindowInterface *

parentWindow

)

Sets this PlasmaWindowInterface as a transient window to parentWindow. If parentWindow is nullptr, the PlasmaWindowInterface is a toplevel window and does not have a parent window.

Definition at line 1007 of file plasmawindowmanagement.cpp.

setPid()

void KWin::PlasmaWindowInterface::setPid

(

quint32

pid

)

Definition at line 765 of file plasmawindowmanagement.cpp.

setResizable()

void KWin::PlasmaWindowInterface::setResizable

(

bool

set

)

Definition at line 997 of file plasmawindowmanagement.cpp.

setResourceName()

void KWin::PlasmaWindowInterface::setResourceName

(

const QString &

resourceName

)

Definition at line 893 of file plasmawindowmanagement.cpp.

setShadeable()

void KWin::PlasmaWindowInterface::setShadeable

(

bool

set

)

Definition at line 982 of file plasmawindowmanagement.cpp.

setShaded()

void KWin::PlasmaWindowInterface::setShaded

(

bool

set

)

Definition at line 987 of file plasmawindowmanagement.cpp.

setSkipSwitcher()

void KWin::PlasmaWindowInterface::setSkipSwitcher

(

bool

skip

)

Definition at line 883 of file plasmawindowmanagement.cpp.

setSkipTaskbar()

void KWin::PlasmaWindowInterface::setSkipTaskbar

(

bool

skip

)

Definition at line 878 of file plasmawindowmanagement.cpp.

setTitle()

void KWin::PlasmaWindowInterface::setTitle

(

const QString &

title

)

Definition at line 770 of file plasmawindowmanagement.cpp.

setVirtualDesktopChangeable()

void KWin::PlasmaWindowInterface::setVirtualDesktopChangeable

(

bool

set

)

FIXME: still relevant with new desktops?

Definition at line 1002 of file plasmawindowmanagement.cpp.

shadeableRequested

void KWin::PlasmaWindowInterface::shadeableRequested ( bool set )

signal

shadedRequested

void KWin::PlasmaWindowInterface::shadedRequested ( bool set )

signal

skipSwitcherRequested

void KWin::PlasmaWindowInterface::skipSwitcherRequested ( bool set )

signal

skipTaskbarRequested

void KWin::PlasmaWindowInterface::skipTaskbarRequested ( bool set )

signal

unmap()

void KWin::PlasmaWindowInterface::unmap

(

)

This method removes the Window and the Client is supposed to release the resource bound for this Window.

No more events should be sent afterwards.

Definition at line 775 of file plasmawindowmanagement.cpp.

uuid()

QString KWin::PlasmaWindowInterface::uuid

(

)

const

Returns

a unique string that identifies this window

Definition at line 1027 of file plasmawindowmanagement.cpp.

virtualDesktopChangeableRequested

void KWin::PlasmaWindowInterface::virtualDesktopChangeableRequested ( bool set )

signal

FIXME: still relevant with new virtual desktops?

Friends And Related Symbol Documentation

PlasmaWindowInterfacePrivate

friend class PlasmaWindowInterfacePrivate

friend

Definition at line 295 of file plasmawindowmanagement.h.

PlasmaWindowManagementInterface

friend class PlasmaWindowManagementInterface

friend

Definition at line 294 of file plasmawindowmanagement.h.

PlasmaWindowManagementInterfacePrivate

friend class PlasmaWindowManagementInterfacePrivate

friend

Definition at line 296 of file plasmawindowmanagement.h.

---

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

• src/wayland/plasmawindowmanagement.h
• src/wayland/plasmawindowmanagement.cpp