LayerShellQt::Window Class
A window. More...
| Header: | #include <LayerShellQt/Window> |
| CMake: | find_package(LayerShellQt REQUIRED)target_link_libraries(mytarget PRIVATE LayerShellQt::Interface) |
| In QML: | Window |
Public Types
| enum | Anchor { AnchorNone, AnchorTop, AnchorBottom, AnchorLeft, AnchorRight } |
| flags | Anchors |
| enum | KeyboardInteractivity { KeyboardInteractivityNone, KeyboardInteractivityExclusive, KeyboardInteractivityOnDemand } |
| enum | Layer { LayerBackground, LayerBottom, LayerTop, LayerOverlay } |
| enum | ScreenConfiguration { ScreenFromQWindow, ScreenFromCompositor } |
Properties
- scope : QString
Public Functions
| LayerShellQt::Window::Anchors | anchors() const |
| int32_t | exclusionZone() const |
| LayerShellQt::Window::KeyboardInteractivity | keyboardInteractivity() const |
| LayerShellQt::Window::Layer | layer() const |
| QMargins | margins() const |
| QString | scope() const |
| LayerShellQt::Window::ScreenConfiguration | screenConfiguration() const |
| void | setAnchors(LayerShellQt::Window::Anchors anchor) |
| void | setCloseOnDismissed(bool close) |
| void | setExclusiveZone(int32_t zone) |
| void | setKeyboardInteractivity(LayerShellQt::Window::KeyboardInteractivity interactivity) |
| void | setLayer(LayerShellQt::Window::Layer layer) |
| void | setMargins(const QMargins &margins) |
| void | setScope(const QString &scope) |
| void | setScreenConfiguration(LayerShellQt::Window::ScreenConfiguration screenConfiguration) |
Signals
| void | anchorsChanged() |
| void | exclusionZoneChanged() |
| void | keyboardInteractivityChanged() |
| void | layerChanged() |
| void | marginsChanged() |
Static Public Members
| LayerShellQt::Window * | get(QWindow *window) |
Detailed Description
Member Type Documentation
enum Window::Anchor
flags Window::Anchors
| Constant | Value | Description |
|---|---|---|
LayerShellQt::Window::AnchorNone | 0 | |
LayerShellQt::Window::AnchorTop | 1 | The top edge of the anchor rectangle |
LayerShellQt::Window::AnchorBottom | 2 | The bottom edge of the anchor rectangle |
LayerShellQt::Window::AnchorLeft | 4 | The left edge of the anchor rectangle |
LayerShellQt::Window::AnchorRight | 8 | The right edge of the anchor rectangle |
The Anchors type is a typedef for QFlags<Anchor>. It stores an OR combination of Anchor values.
enum Window::KeyboardInteractivity
This enum type is used to specify how the layer surface handles keyboard focus.
enum Window::Layer
This enum type is used to specify the layer where a surface can be put in.
enum Window::ScreenConfiguration
This enum type is used to specify which screen to place the surface on. ScreenFromQWindow (the default) reads QWindow::screen() while ScreenFromCompositor passes nil and lets the compositor decide.
Property Documentation
scope : QString
Access functions:
Member Function Documentation
[static] LayerShellQt::Window *Window::get(QWindow *window)
Gets the LayerShell Window for a given Qt Window Ownership is not transferred
QString Window::scope() const
A string based identifier for this window. This may be used by a compositor to determine stacking order within a given layer.
May also be referred to as a role
Note: Getter function for property scope.
See also setScope().
void Window::setCloseOnDismissed(bool close)
Whether the QWindow should be closed when the layer surface is dismissed by the compositor. For example, if the associated screen has been removed.
This can be used to map the window on another screen.
void Window::setScope(const QString &scope)
Sets a string based identifier for this window. This may be used by a compositor to determine stacking order within a given layer.
May also be referred to as a role
Note: Setter function for property scope.
See also scope().