mirror of
https://invent.kde.org/plasma/layer-shell-qt.git
synced 2025-06-03 17:18:16 -04:00
1618161af3
If we are designing our UI's windows from QML, it makes sense that we might want to configure how they're placed from the same place. Everything was already in place but for a few technical bits which this change adds. Signed-off-by: Victoria Fischer <victoria.fischer@mbition.io>
123 lines
3.5 KiB
C++
123 lines
3.5 KiB
C++
/*
|
|
* SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
|
|
* SPDX-FileCopyrightText: 2018 Drew DeVault <sir@cmpwn.com>
|
|
*
|
|
* SPDX-License-Identifier: LGPL-3.0-or-later
|
|
*/
|
|
|
|
#ifndef LAYERSHELLQTWINDOW_H
|
|
#define LAYERSHELLQTWINDOW_H
|
|
|
|
#include <QObject>
|
|
#include <QScreen>
|
|
#include <QWindow>
|
|
|
|
#include "layershellqt_export.h"
|
|
|
|
namespace LayerShellQt
|
|
{
|
|
class WindowPrivate;
|
|
|
|
class LAYERSHELLQT_EXPORT Window : public QObject
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(int anchors READ anchors WRITE setAnchorsInt NOTIFY anchorsChanged)
|
|
Q_PROPERTY(QString scope READ scope WRITE setScope)
|
|
Q_PROPERTY(QMargins margins READ margins WRITE setMargins NOTIFY marginsChanged)
|
|
Q_PROPERTY(qint32 exclusionZone READ exclusionZone WRITE setExclusiveZone NOTIFY exclusionZoneChanged)
|
|
Q_PROPERTY(Layer layer READ layer WRITE setLayer NOTIFY layerChanged)
|
|
Q_PROPERTY(KeyboardInteractivity keyboardInteractivity READ keyboardInteractivity WRITE setKeyboardInteractivity NOTIFY keyboardInteractivityChanged)
|
|
|
|
public:
|
|
Window(QWindow *window = nullptr);
|
|
~Window() override;
|
|
|
|
enum Anchor {
|
|
AnchorTop = 1, ///< The top edge of the anchor rectangle
|
|
AnchorBottom = 2, ///< The bottom edge of the anchor rectangle
|
|
AnchorLeft = 4, ///< The left edge of the anchor rectangle
|
|
AnchorRight = 8, ///< The right edge of the anchor rectangle
|
|
};
|
|
Q_ENUM(Anchor);
|
|
Q_DECLARE_FLAGS(Anchors, Anchor)
|
|
|
|
/**
|
|
* This enum type is used to specify the layer where a surface can be put in.
|
|
*/
|
|
enum Layer {
|
|
LayerBackground = 0,
|
|
LayerBottom = 1,
|
|
LayerTop = 2,
|
|
LayerOverlay = 3,
|
|
};
|
|
Q_ENUM(Layer)
|
|
|
|
/**
|
|
* This enum type is used to specify how the layer surface handles keyboard focus.
|
|
*/
|
|
enum KeyboardInteractivity {
|
|
KeyboardInteractivityNone = 0,
|
|
KeyboardInteractivityExclusive = 1,
|
|
KeyboardInteractivityOnDemand = 2,
|
|
};
|
|
Q_ENUM(KeyboardInteractivity)
|
|
|
|
void setAnchors(Anchors anchor);
|
|
Anchors anchors() const;
|
|
|
|
void setExclusiveZone(int32_t zone);
|
|
int32_t exclusionZone() const;
|
|
|
|
void setMargins(const QMargins &margins);
|
|
QMargins margins() const;
|
|
|
|
void setKeyboardInteractivity(KeyboardInteractivity interactivity);
|
|
KeyboardInteractivity keyboardInteractivity() const;
|
|
|
|
void setLayer(Layer layer);
|
|
Layer layer() const;
|
|
|
|
/**
|
|
* If set, the compositor will try to put the window on the given screen.
|
|
* If its not set, then the compositor will decide where to put the window.
|
|
* Under normal circumstances, this should be the active output.
|
|
*/
|
|
void setDesiredOutput(QScreen *output);
|
|
QScreen *desiredOutput() const;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
void setScope(const QString &scope);
|
|
QString scope() const;
|
|
|
|
/// Workaround needed for Qt 5 not to get confused with types, not necessary on Qt 6
|
|
void setAnchorsInt(int x) { setAnchors(Anchors(x)); }
|
|
|
|
/**
|
|
* Gets the LayerShell Window for a given Qt Window
|
|
* Ownership is not transferred
|
|
*/
|
|
static Window *get(QWindow *window);
|
|
|
|
static Window *qmlAttachedProperties(QObject *object);
|
|
|
|
Q_SIGNALS:
|
|
void anchorsChanged();
|
|
void exclusionZoneChanged();
|
|
void marginsChanged();
|
|
void keyboardInteractivityChanged();
|
|
void layerChanged();
|
|
|
|
private:
|
|
QScopedPointer<WindowPrivate> d;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|