KWaylandServer::XdgPositioner

KWaylandServer::XdgPositioner Class Reference

#include <xdgshell_interface.h>

Public Member Functions

 XdgPositioner ()
 
 XdgPositioner (const XdgPositioner &other)
 
 ~XdgPositioner ()
 
Qt::Edges anchorEdges () const
 
QRect anchorRect () const
 
Qt::Orientations flipConstraintAdjustments () const
 
Qt::Edges gravityEdges () const
 
bool isComplete () const
 
QPoint offset () const
 
XdgPositioneroperator= (const XdgPositioner &other)
 
Qt::Orientations resizeConstraintAdjustments () const
 
QSize size () const
 
Qt::Orientations slideConstraintAdjustments () const
 

Static Public Member Functions

static XdgPositioner get (::wl_resource *resource)
 

Detailed Description

The XdgPositioner class provides a collection of rules for the placement of a popup surface.

XdgPositioner corresponds to the Wayland interface xdg_positioner.

Since
5.20

Definition at line 381 of file xdgshell_interface.h.

Constructor & Destructor Documentation

KWaylandServer::XdgPositioner::XdgPositioner ( )

Constructs an incomplete XdgPositioner object.

Definition at line 936 of file xdgshell_interface.cpp.

KWaylandServer::XdgPositioner::XdgPositioner ( const XdgPositioner other)

Constructs a copy of the XdgPositioner object.

Definition at line 941 of file xdgshell_interface.cpp.

KWaylandServer::XdgPositioner::~XdgPositioner ( )

Destructs the XdgPositioner object.

Definition at line 946 of file xdgshell_interface.cpp.

Member Function Documentation

Qt::Edges KWaylandServer::XdgPositioner::anchorEdges ( ) const

Returns the set of edges on the anchor rectangle that the surface should be positioned around.

Definition at line 976 of file xdgshell_interface.cpp.

QRect KWaylandServer::XdgPositioner::anchorRect ( ) const

Returns the anchor rectangle relative to the upper left corner of the window geometry of the parent surface that the popup should be positioned around.

Definition at line 991 of file xdgshell_interface.cpp.

Qt::Orientations KWaylandServer::XdgPositioner::flipConstraintAdjustments ( ) const

Returns the set of orientations along which the compositor may flip the popup to ensure that it is entirely inside the compositor's defined "work area.".

Definition at line 966 of file xdgshell_interface.cpp.

XdgPositioner KWaylandServer::XdgPositioner::get ( ::wl_resource *  resource)
static

Returns the current state of the xdg positioner object identified by resource.

Definition at line 1001 of file xdgshell_interface.cpp.

Qt::Edges KWaylandServer::XdgPositioner::gravityEdges ( ) const

Returns the direction in which the surface should be positioned, relative to the anchor point of the parent surface.

Definition at line 981 of file xdgshell_interface.cpp.

bool KWaylandServer::XdgPositioner::isComplete ( ) const

Returns true if the positioner object is complete; otherwise returns false.

An xdg positioner considered complete if it has a valid size and a valid anchor rect.

Definition at line 956 of file xdgshell_interface.cpp.

QPoint KWaylandServer::XdgPositioner::offset ( ) const

Returns the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface.

Definition at line 996 of file xdgshell_interface.cpp.

XdgPositioner & KWaylandServer::XdgPositioner::operator= ( const XdgPositioner other)

Assigns the value of other to this XdgPositioner object.

Definition at line 950 of file xdgshell_interface.cpp.

Qt::Orientations KWaylandServer::XdgPositioner::resizeConstraintAdjustments ( ) const

Returns the set of orientations along which the compositor can resize the popup to ensure that it is entirely inside the compositor's defined "work area.".

Definition at line 971 of file xdgshell_interface.cpp.

QSize KWaylandServer::XdgPositioner::size ( ) const

Returns the window geometry size of the surface that is to be positioned.

Definition at line 986 of file xdgshell_interface.cpp.

Qt::Orientations KWaylandServer::XdgPositioner::slideConstraintAdjustments ( ) const

Returns the set of orientations along which the compositor may slide the popup to ensure that it is entirely inside the compositor's defined "work area.".

Definition at line 961 of file xdgshell_interface.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Sep 18 2020 23:06:16 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.