calamares/src/libcalamaresui/viewpages/Slideshow.h
Adriaan de Groot 736f99768a [libcalamaresui] Don't build QML bits if they're not wanted
When WITH_QML is off (by explicit choice)

- don't build the QmlViewStep
- don't build the QML slideshow
2020-05-14 16:31:59 +02:00

148 lines
4.1 KiB
C++

/* === This file is part of Calamares - <https://github.com/calamares> ===
*
* Copyright 2014, Aurélien Gâteau <agateau@kde.org>
* Copyright 2014-2015, Teo Mrnjavac <teo@kde.org>
* Copyright 2018, Adriaan de Groot <groot@kde.org>
*
* Calamares 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, either version 3 of the License, or
* (at your option) any later version.
*
* Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBCALAMARESUI_SLIDESHOW_H
#define LIBCALAMARESUI_SLIDESHOW_H
#include "CalamaresConfig.h"
#include <QMutex>
#include <QStringList>
#include <QWidget>
class QLabel;
class QTimer;
#ifdef WITH_QML
class QQmlComponent;
class QQuickItem;
class QQuickWidget;
#endif
namespace Calamares
{
/** @brief API for Slideshow objects
*
* A Slideshow (subclass) object is created by the ExecutionViewStep
* and needs to manage its own configuration (e.g. from Branding).
* The slideshow is started and stopped when it becomes visible
* and when installation is over, by calling changeSlideShowState()
* as appropriate.
*/
class Slideshow : public QObject
{
Q_OBJECT
public:
/// @brief State-change of the slideshow, for changeSlideShowState()
enum Action
{
Start,
Stop
};
Slideshow( QWidget* parent = nullptr )
: QObject( parent )
{
}
virtual ~Slideshow();
/// @brief Is the slideshow being shown **right now**?
bool isActive() const { return m_state == Start; }
/** @brief The actual widget to show the user.
*
* Depending on the style of slideshow, this might be a QQuickWidget,
* or a QLabel, or something else entirely.
*/
virtual QWidget* widget() = 0;
/** @brief Tells the slideshow we activated or left the show.
*
* If @p state is @c Slideshow::Start, calls suitable activation procedures.
* If @p state is @c Slideshow::Stop, calls deactivation procedures.
*/
virtual void changeSlideShowState( Action a ) = 0;
protected:
QMutex m_mutex;
Action m_state = Stop;
};
#ifdef WITH_QML
/** @brief Slideshow using a QML file
*
* This is the "classic" slideshow in Calamares, which runs some QML
* while the installation is in progress. It is configured through
* Branding settings *slideshow* and *slideshowAPI*, showing the QML
* file from *slideshow*. The API version influences when and how the
* QML is loaded; version 1 does so only when the slideshow is activated,
* while version 2 does so asynchronously.
*/
class SlideshowQML : public Slideshow
{
Q_OBJECT
public:
SlideshowQML( QWidget* parent );
virtual ~SlideshowQML() override;
QWidget* widget() override;
void changeSlideShowState( Action a ) override;
public slots:
void loadQmlV2Complete();
void loadQmlV2(); ///< Loads the slideshow QML (from branding) for API version 2
private:
QQuickWidget* m_qmlShow;
QQmlComponent* m_qmlComponent;
QQuickItem* m_qmlObject; ///< The actual show
};
#endif
/** @brief Slideshow using images
*
* This is an "oldschool" slideshow, but new in Calamares, which
* displays static image files one-by-one. It is for systems that
* do not use QML at all. It is configured through the Branding
* setting *slideshow*. When using this widget, the setting must
* be a list of filenames; the API is set to -1.
*/
class SlideshowPictures : public Slideshow
{
Q_OBJECT
public:
SlideshowPictures( QWidget* parent );
virtual ~SlideshowPictures() override;
QWidget* widget() override;
virtual void changeSlideShowState( Action a ) override;
public slots:
void next();
private:
QLabel* m_label;
QTimer* m_timer;
int m_imageIndex;
QStringList m_images;
};
} // namespace Calamares
#endif