KWaylandServer::LayerSurfaceV1Interface

Search for usage in LXR

KWaylandServer::LayerSurfaceV1Interface Class Reference

#include <layershell_v1_interface.h>

Inheritance diagram for KWaylandServer::LayerSurfaceV1Interface:

Public Types

enum  Layer { BackgroundLayer, BottomLayer, TopLayer, OverlayLayer }
 

Signals

void aboutToBeDestroyed ()
 
void acceptsFocusChanged ()
 
void anchorChanged ()
 
void configureAcknowledged (quint32 serial)
 
void desiredSizeChanged ()
 
void exclusiveZoneChanged ()
 
void layerChanged ()
 
void marginsChanged ()
 

Public Member Functions

 LayerSurfaceV1Interface (LayerShellV1Interface *shell, SurfaceInterface *surface, OutputInterface *output, Layer layer, const QString &scope, wl_resource *resource)
 
bool acceptsFocus () const
 
Qt::Edges anchor () const
 
int bottomMargin () const
 
QSize desiredSize () const
 
Qt::Edge exclusiveEdge () const
 
int exclusiveZone () const
 
bool isCommitted () const
 
Layer layer () const
 
int leftMargin () const
 
QMargins margins () const
 
OutputInterfaceoutput () const
 
int rightMargin () const
 
QString scope () const
 
void sendClosed ()
 
quint32 sendConfigure (const QSize &size)
 
SurfaceInterfacesurface () const
 
int topMargin () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

The LayerSurfaceV1Interface class represents a desktop shell surface, e.g.

panel, etc.

The LayerSurfaceV1Interface corresponds to the Wayland interface zwlr_layer_surface_v1.

Definition at line 57 of file layershell_v1_interface.h.

Member Function Documentation

bool KWaylandServer::LayerSurfaceV1Interface::acceptsFocus ( ) const

Returns true if the surface accepts keyboard input; otherwise returns false.

Definition at line 369 of file layershell_v1_interface.cpp.

Qt::Edges KWaylandServer::LayerSurfaceV1Interface::anchor ( ) const

Returns the anchor point relative to which the surface will be positioned.

If no edges have been specified, the center of the screen is assumed to be the anchor point.

Definition at line 359 of file layershell_v1_interface.cpp.

int KWaylandServer::LayerSurfaceV1Interface::bottomMargin ( ) const

Returns the value of the bottom margin.

This is equivalent to calling margins().bottom().

Definition at line 399 of file layershell_v1_interface.cpp.

QSize KWaylandServer::LayerSurfaceV1Interface::desiredSize ( ) const

Returns the desired size for this layer shell surface, in the surface-local coordinates.

Definition at line 364 of file layershell_v1_interface.cpp.

Qt::Edge KWaylandServer::LayerSurfaceV1Interface::exclusiveEdge ( ) const

If the exclusive zone is positive, this function returns the corresponding exclusive anchor edge, otherwise returns a Qt::Edge() value.

Definition at line 409 of file layershell_v1_interface.cpp.

int KWaylandServer::LayerSurfaceV1Interface::exclusiveZone ( ) const

Returns the distance from the anchor edge that should not be occluded.

An exlusive zone of 0 means that the layer surface has to be moved to avoid occluding surfaces with a positive exclusion zone. If the exclusive zone is -1, the layer surface indicates that it doesn't want to be moved to accomodate for other surfaces.

Definition at line 404 of file layershell_v1_interface.cpp.

bool KWaylandServer::LayerSurfaceV1Interface::isCommitted ( ) const

Returns true if the initial commit has been performed; otherwise returns false.

Definition at line 349 of file layershell_v1_interface.cpp.

LayerSurfaceV1Interface::Layer KWaylandServer::LayerSurfaceV1Interface::layer ( ) const

Returns the stacking order layer where this layer surface has to be rendered.

Definition at line 374 of file layershell_v1_interface.cpp.

int KWaylandServer::LayerSurfaceV1Interface::leftMargin ( ) const

Returns the value of the left margin.

This is equivalent to calling margins().left().

Definition at line 384 of file layershell_v1_interface.cpp.

QMargins KWaylandServer::LayerSurfaceV1Interface::margins ( ) const

Returns the margins object that indicates the distance between an anchor edge and the corresponding surface edge.

Definition at line 379 of file layershell_v1_interface.cpp.

OutputInterface * KWaylandServer::LayerSurfaceV1Interface::output ( ) const

Returns the output where the surface wants to be displayed.

This function can return null, in which case the compositor is free to choose the output where the surface has to be placed.

Definition at line 429 of file layershell_v1_interface.cpp.

int KWaylandServer::LayerSurfaceV1Interface::rightMargin ( ) const

Returns the value of the right margin.

This is equivalent to calling margins().right().

Definition at line 394 of file layershell_v1_interface.cpp.

QString KWaylandServer::LayerSurfaceV1Interface::scope ( ) const

Returns the scope of this layer surface.

The scope defines the purpose of the surface.

Definition at line 434 of file layershell_v1_interface.cpp.

void KWaylandServer::LayerSurfaceV1Interface::sendClosed ( )

Sends a closed event to the client.

The client should destroy the surface after receiving this event. Further changes to the surface will be ignored.

Definition at line 455 of file layershell_v1_interface.cpp.

quint32 KWaylandServer::LayerSurfaceV1Interface::sendConfigure ( const QSize size)

Sends a configure event to the client.

size contains the desired size in surface-local coordinates. A size of zero means that the client is free to choose its own dimensions.

See also
configureAcknowledged()

Definition at line 439 of file layershell_v1_interface.cpp.

SurfaceInterface * KWaylandServer::LayerSurfaceV1Interface::surface ( ) const

Returns the underlying Wayland surface for this layer shell surface.

Definition at line 354 of file layershell_v1_interface.cpp.

int KWaylandServer::LayerSurfaceV1Interface::topMargin ( ) const

Returns the value of the top margin.

This is equivalent to calling margins().top().

Definition at line 389 of file layershell_v1_interface.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Oct 19 2021 23:10:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.