KWin::ClientConnection Class Reference

Convenient Class which represents a wl_client. More...

#include <clientconnection.h>

Inheritance diagram for KWin::ClientConnection:

Signals
void	aboutToBeDestroyed ()
void	disconnected (KWin::ClientConnection *)
void	scaleOverrideChanged ()

Public Member Functions
virtual	~ClientConnection ()
void	flush ()
wl_resource *	getResource (quint32 id) const
wl_client *	client () const
Display *	display () const
pid_t	processId () const
uid_t	userId () const
gid_t	groupId () const
QString	executablePath () const
	operator wl_client * ()
	operator wl_client * () const
void	destroy ()
void	setScaleOverride (qreal scaleOverride)
qreal	scaleOverride () const
void	setSecurityContextAppId (const QString &appId)
QString	securityContextAppId () const

Friends
class	Display

Detailed Description

Convenient Class which represents a wl_client.

The ClientConnection gets automatically created for a wl_client. In particular, the signal Display::clientConnected will be emitted.

See also

Display

Definition at line 31 of file clientconnection.h.

Constructor & Destructor Documentation

~ClientConnection()

KWin::ClientConnection::~ClientConnection ( )

virtualdefault

Member Function Documentation

aboutToBeDestroyed

void KWin::ClientConnection::aboutToBeDestroyed ( )

signal

This signal is emitted when the client is about to be destroyed.

client()

wl_client * KWin::ClientConnection::client

(

)

const

Returns

the native wl_client this ClientConnection represents.

Definition at line 117 of file clientconnection.cpp.

destroy()

void KWin::ClientConnection::destroy

(

)

Destroys this ClientConnection. This is a convenient wrapper around wl_client_destroy. The use case is in combination with ClientConnections created through Display::createClient. E.g. once the process for the ClientConnection exited, the ClientConnection needs to be destroyed, too.

Definition at line 107 of file clientconnection.cpp.

disconnected

void KWin::ClientConnection::disconnected ( KWin::ClientConnection * )

signal

Signal emitted when the ClientConnection got disconnected from the server.

display()

Display * KWin::ClientConnection::display

(

)

const

Returns

The Display this ClientConnection is connected to

Definition at line 132 of file clientconnection.cpp.

executablePath()

QString KWin::ClientConnection::executablePath

(

)

const

The absolute path to the executable.

Please note: if the ClientConnection got created with Display::createClient the executablePath will be identical to the process running the KWin::Display.

If the executable path cannot be resolved an empty QString is returned.

See also

processId

Definition at line 152 of file clientconnection.cpp.

flush()

void KWin::ClientConnection::flush

(

)

Flushes the connection to this client. Ensures that all events are pushed to the client.

Definition at line 102 of file clientconnection.cpp.

getResource()

wl_resource * KWin::ClientConnection::getResource

(

quint32

id

)

const

Get the wl_resource associated with the given id.

Definition at line 112 of file clientconnection.cpp.

groupId()

gid_t KWin::ClientConnection::groupId

(

)

const

The gid of the ClientConnection endpoint.

Please note: if the ClientConnection got created with Display::createClient the gid will be identical to the process running the KWin::Display.

Returns

The gid of the connection.

Definition at line 137 of file clientconnection.cpp.

operator wl_client *() [1/2]

KWin::ClientConnection::operator wl_client *

(

)

Cast operator the native wl_client this ClientConnection represents.

Definition at line 122 of file clientconnection.cpp.

operator wl_client *() [2/2]

KWin::ClientConnection::operator wl_client *

(

)

const

Cast operator the native wl_client this ClientConnection represents.

Definition at line 127 of file clientconnection.cpp.

processId()

pid_t KWin::ClientConnection::processId

(

)

const

The pid of the ClientConnection endpoint.

Please note: if the ClientConnection got created with Display::createClient the pid will be identical to the process running the KWin::Display.

Returns

The pid of the connection.

Definition at line 142 of file clientconnection.cpp.

scaleOverride()

qreal KWin::ClientConnection::scaleOverride

(

)

const

Definition at line 164 of file clientconnection.cpp.

scaleOverrideChanged

void KWin::ClientConnection::scaleOverrideChanged ( )

signal

securityContextAppId()

QString KWin::ClientConnection::securityContextAppId

(

)

const

Definition at line 174 of file clientconnection.cpp.

setScaleOverride()

void KWin::ClientConnection::setScaleOverride

(

qreal

scaleOverride

)

Set an additional mapping between kwin's logical co-ordinate space and the client's logical co-ordinate space.

This is used in the same way as if the client was setting the surface.buffer_scale on every surface i.e a value of 2.0 will make the windows appear smaller on a regular DPI monitor.

Only the minimal set of protocols used by xwayland have support.

Buffer sizes are unaffected.

Definition at line 157 of file clientconnection.cpp.

setSecurityContextAppId()

void KWin::ClientConnection::setSecurityContextAppId

(

const QString &

appId

)

Definition at line 169 of file clientconnection.cpp.

userId()

uid_t KWin::ClientConnection::userId

(

)

const

The uid of the ClientConnection endpoint.

Please note: if the ClientConnection got created with Display::createClient the uid will be identical to the process running the KWin::Display.

Returns

The uid of the connection.

Definition at line 147 of file clientconnection.cpp.

Friends And Related Symbol Documentation

Display

friend class Display

friend

Definition at line 143 of file clientconnection.h.

---

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

• src/wayland/clientconnection.h
• src/wayland/clientconnection.cpp