MirSurfaceInterface.h

/*
 * Copyright (C) 2015-2016 Canonical, Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LOMIRI_SHELL_APPLICATION_MIRSURFACE_H
#define LOMIRI_SHELL_APPLICATION_MIRSURFACE_H
 
#include <QObject>
#include <QRect>
#include <QSize>
 
#include "Mir.h"
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
Q_MOC_INCLUDE("MirSurfaceListInterface.h")
#endif
 
namespace lomiri
{
namespace shell
{
namespace application
{
 
class MirSurfaceListInterface;

class MirSurfaceInterface : public QObject
{
    Q_OBJECT

    Q_PROPERTY(Mir::Type type READ type NOTIFY typeChanged)
 
    
    Q_PROPERTY(QString name READ name NOTIFY nameChanged)

    Q_PROPERTY(QString persistentId READ persistentId CONSTANT)

    Q_PROPERTY(QString appId READ appId CONSTANT)

    Q_PROPERTY(QPoint position READ position NOTIFY positionChanged)

    Q_PROPERTY(QPoint requestedPosition READ requestedPosition WRITE setRequestedPosition NOTIFY requestedPositionChanged)

    Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)

    Q_PROPERTY(Mir::State state READ state NOTIFY stateChanged)

    Q_PROPERTY(bool live READ live NOTIFY liveChanged)

    Q_PROPERTY(bool isReady READ isReady NOTIFY ready)

    Q_PROPERTY(bool visible READ visible NOTIFY visibleChanged)

    Q_PROPERTY(Mir::OrientationAngle orientationAngle READ orientationAngle WRITE setOrientationAngle
               NOTIFY orientationAngleChanged DESIGNABLE false)

    Q_PROPERTY(int minimumWidth READ minimumWidth NOTIFY minimumWidthChanged)

    Q_PROPERTY(int minimumHeight READ minimumHeight NOTIFY minimumHeightChanged)

    Q_PROPERTY(int maximumWidth READ maximumWidth NOTIFY maximumWidthChanged)

    Q_PROPERTY(int maximumHeight READ maximumHeight NOTIFY maximumHeightChanged)

    Q_PROPERTY(int widthIncrement READ widthIncrement NOTIFY widthIncrementChanged)

    Q_PROPERTY(int heightIncrement READ heightIncrement NOTIFY heightIncrementChanged)

    Q_PROPERTY(Mir::ShellChrome shellChrome READ shellChrome NOTIFY shellChromeChanged)

    Q_PROPERTY(QString keymap READ keymap WRITE setKeymap NOTIFY keymapChanged)

    Q_PROPERTY(bool focused READ focused NOTIFY focusedChanged)

    Q_PROPERTY(QRect inputBounds READ inputBounds NOTIFY inputBoundsChanged)

    Q_PROPERTY(bool confinesMousePointer READ confinesMousePointer NOTIFY confinesMousePointerChanged)

    Q_PROPERTY(bool allowClientResize READ allowClientResize WRITE setAllowClientResize NOTIFY allowClientResizeChanged)

    Q_PROPERTY(MirSurfaceInterface* parentSurface READ parentSurface CONSTANT)

    Q_PROPERTY(lomiri::shell::application::MirSurfaceListInterface* childSurfaceList READ childSurfaceList CONSTANT)
 
public:
    MirSurfaceInterface(QObject *parent = nullptr) : QObject(parent) {}
    virtual ~MirSurfaceInterface() {}
 
    virtual Mir::Type type() const = 0;
 
    virtual QString name() const = 0;
 
    virtual QString persistentId() const = 0;
 
    virtual QString appId() const = 0;
 
    virtual QPoint position() const = 0;
 
    virtual QSize size() const = 0;
    virtual void resize(int width, int height) = 0;
    virtual void resize(const QSize &size) = 0;
 
    virtual Mir::State state() const = 0;
 
    virtual bool live() const = 0;
    virtual bool isReady() const = 0;
    virtual bool visible() const = 0;
 
    virtual Mir::OrientationAngle orientationAngle() const = 0;
    virtual void setOrientationAngle(Mir::OrientationAngle angle) = 0;
 
    virtual int minimumWidth() const = 0;
    virtual int minimumHeight() const = 0;
    virtual int maximumWidth() const = 0;
    virtual int maximumHeight() const = 0;
    virtual int widthIncrement() const = 0;
    virtual int heightIncrement() const = 0;
 
    virtual void setKeymap(const QString &) = 0;
    virtual QString keymap() const = 0;
 
    virtual Mir::ShellChrome shellChrome() const = 0;
 
    virtual bool focused() const = 0;
 
    virtual QRect inputBounds() const = 0;
 
    virtual bool confinesMousePointer() const = 0;
 
    virtual bool allowClientResize() const = 0;
    virtual void setAllowClientResize(bool) = 0;
 
    virtual QPoint requestedPosition() const = 0;
    virtual void setRequestedPosition(const QPoint &) = 0;
 
    virtual MirSurfaceInterface* parentSurface() const = 0;
 
    virtual lomiri::shell::application::MirSurfaceListInterface* childSurfaceList() const = 0;

    Q_INVOKABLE virtual void close() = 0;

    Q_INVOKABLE virtual void forceClose() = 0;

    Q_INVOKABLE virtual void activate() = 0;
 
public Q_SLOTS:
    virtual void requestState(Mir::State state) = 0;
 
Q_SIGNALS:
    void ready();
    void typeChanged(Mir::Type value);
    void liveChanged(bool value);
    void visibleChanged(bool visible);
    void stateChanged(Mir::State value);
    void orientationAngleChanged(Mir::OrientationAngle value);
    void positionChanged(QPoint position);
    void requestedPositionChanged(QPoint position);
    void sizeChanged(const QSize &value);
    void nameChanged(const QString &name);
    void minimumWidthChanged(int value);
    void minimumHeightChanged(int value);
    void maximumWidthChanged(int value);
    void maximumHeightChanged(int value);
    void widthIncrementChanged(int value);
    void heightIncrementChanged(int value);
    void shellChromeChanged(Mir::ShellChrome value);
    void keymapChanged(const QString &value);
    void focusedChanged(bool value);
    void inputBoundsChanged(QRect value);
    void confinesMousePointerChanged(bool value);
    void allowClientResizeChanged(bool value);

    void focusRequested();

    void closeRequested();
};
 
} // namespace application
} // namespace shell
} // namespace lomiri
 
Q_DECLARE_METATYPE(lomiri::shell::application::MirSurfaceInterface*)
 
#endif // LOMIRI_SHELL_APPLICATION_MIRSURFACE_H