summaryrefslogtreecommitdiff
path: root/src/QGst/Ui/graphicsvideowidget.h
blob: e6434b7d09ffd0292e1839ea70928201ad9db11f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
    Copyright (C) 2012 Collabora Ltd. <info@collabora.com>
      @author George Kiagiadakis <george.kiagiadakis@collabora.com>

    This library is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation; either version 2.1 of the License, or
    (at your option) any later version.

    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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef QGST_UI_GRAPHICSVIDEOWIDGET_H
#define QGST_UI_GRAPHICSVIDEOWIDGET_H

#include "graphicsvideosurface.h"
#include <QtCore/QPointer>

#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
# include <QtWidgets/QGraphicsWidget>
#else
# include <QtGui/QGraphicsWidget>
#endif

namespace QGst {
namespace Ui {

/*! \headerfile graphicsvideowidget.h <QGst/Ui/GraphicsVideoWidget>
 * \brief A QGraphicsWidget for displaying video on a QGraphicsScene
 *
 * This is a QGraphicsWidget subclass that can display video. To use it,
 * you have to create a GraphicsVideoSurface and connect it with this
 * widget using the setSurface() method or the surface property.
 * See the GraphicsVideoSurface documentation for details and examples.
 *
 * \sa GraphicsVideoSurface
 */
class QTGSTREAMERUI_EXPORT GraphicsVideoWidget : public QGraphicsWidget
{
    Q_OBJECT
    Q_DISABLE_COPY(GraphicsVideoWidget)
    Q_PROPERTY(QGst::Ui::GraphicsVideoSurface* surface READ surface WRITE setSurface)
public:
    explicit GraphicsVideoWidget(QGraphicsItem *parent = 0, Qt::WindowFlags wFlags = 0);
    virtual ~GraphicsVideoWidget();

    /*! Reimplemented from QGraphicsWidget. Do not call directly. */
    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);

    GraphicsVideoSurface *surface() const;
    void setSurface(GraphicsVideoSurface *surface);

private:
    QPointer<GraphicsVideoSurface> m_surface;
};

} // namespace Ui
} // namespace QGst

#endif // QGST_UI_GRAPHICSVIDEOWIDGET_H