MirSurfaceItemInterface.h

/*
 * Copyright (C) 2015 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_MIRSURFACEITEM_H
#define LOMIRI_SHELL_APPLICATION_MIRSURFACEITEM_H
 
#include "Mir.h"
 
#include <QQuickItem>
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
Q_MOC_INCLUDE("MirSurfaceInterface.h")
#endif
 
namespace lomiri
{
namespace shell
{
namespace application
{
 
class MirSurfaceInterface;
 
class MirSurfaceItemInterface : public QQuickItem
{
    Q_OBJECT
 
    Q_PROPERTY(lomiri::shell::application::MirSurfaceInterface* surface READ surface WRITE setSurface NOTIFY surfaceChanged)
 
    
    Q_PROPERTY(Mir::Type type READ type NOTIFY typeChanged)
 
    Q_PROPERTY(Mir::State surfaceState READ surfaceState NOTIFY surfaceStateChanged)
 
    Q_PROPERTY(QString name READ name NOTIFY nameChanged)
 
    Q_PROPERTY(bool live READ live NOTIFY liveChanged)
 
    Q_PROPERTY(Mir::OrientationAngle orientationAngle READ orientationAngle WRITE setOrientationAngle
               NOTIFY orientationAngleChanged DESIGNABLE false)
 
 
    Q_PROPERTY(bool consumesInput READ consumesInput
                                  WRITE setConsumesInput
                                  NOTIFY consumesInputChanged)
 
    Q_PROPERTY(int surfaceWidth READ surfaceWidth
                                WRITE setSurfaceWidth
                                NOTIFY surfaceWidthChanged)
 
    Q_PROPERTY(int surfaceHeight READ surfaceHeight
                                WRITE setSurfaceHeight
                                NOTIFY surfaceHeightChanged)
 
    Q_PROPERTY(FillMode fillMode READ fillMode WRITE setFillMode NOTIFY fillModeChanged)
 
    Q_PROPERTY(Mir::ShellChrome shellChrome READ shellChrome NOTIFY shellChromeChanged)
 
public:
 
    enum FillMode {
        Stretch,
        PadOrCrop
    };
    Q_ENUM(FillMode)
 
    
    MirSurfaceItemInterface(QQuickItem *parent = 0) : QQuickItem(parent) {}
    virtual ~MirSurfaceItemInterface() {}
 
    virtual Mir::Type type() const = 0;
    virtual QString name() const = 0;
    virtual bool live() const = 0;
 
    virtual Mir::State surfaceState() const = 0;
 
    virtual Mir::OrientationAngle orientationAngle() const = 0;
    virtual void setOrientationAngle(Mir::OrientationAngle angle) = 0;
 
    virtual MirSurfaceInterface* surface() const = 0;
    virtual void setSurface(MirSurfaceInterface*) = 0;
 
    virtual bool consumesInput() const = 0;
    virtual void setConsumesInput(bool value) = 0;
 
    virtual int surfaceWidth() const = 0;
    virtual void setSurfaceWidth(int value) = 0;
 
    virtual int surfaceHeight() const = 0;
    virtual void setSurfaceHeight(int value) = 0;
 
    virtual FillMode fillMode() const = 0;
    virtual void setFillMode(FillMode value) = 0;
 
    virtual Mir::ShellChrome shellChrome() const = 0;
 
Q_SIGNALS:
    void typeChanged(Mir::Type);
    void surfaceStateChanged(Mir::State);
    void liveChanged(bool live);
    void orientationAngleChanged(Mir::OrientationAngle angle);
    void surfaceChanged(lomiri::shell::application::MirSurfaceInterface* surface);
    void consumesInputChanged(bool value);
    void surfaceWidthChanged(int value);
    void surfaceHeightChanged(int value);
    void nameChanged(const QString &name);
    void fillModeChanged(FillMode value);
    void shellChromeChanged(Mir::ShellChrome value);
};
 
} // namespace application
} // namespace shell
} // namespace lomiri
 
#endif // LOMIRI_SHELL_APPLICATION_MIRSURFACEITEM_H