From e8fbe8e5655de3bf699e5d86172c3bdf290d05f7 Mon Sep 17 00:00:00 2001 From: Elias Steurer Date: Thu, 13 May 2021 13:05:05 +0200 Subject: [PATCH] Add ScreenPlayUtil and ScreenPlayShader to developer docs Update to qdoc Qt 6.1 Add module for every project --- Docs/config.qdocconf | 33 +-- Docs/css/style.css | 7 +- Docs/html/basewindow-members.html | 89 ++++++++ Docs/html/basewindow.html | 138 ++++++++++++ Docs/html/cpu-members.html | 23 ++ Docs/html/cpu.html | 56 +++++ Docs/html/gpu-members.html | 33 +++ Docs/html/gpu.html | 66 ++++++ Docs/html/ram-members.html | 32 +++ Docs/html/ram.html | 60 ++++++ Docs/html/screenplay-app.html | 12 +- Docs/html/screenplay-create-members.html | 2 +- Docs/html/screenplay-create.html | 8 +- .../screenplay-createimportvideo-members.html | 4 +- Docs/html/screenplay-createimportvideo.html | 16 +- Docs/html/screenplay-globalvariables.html | 2 +- ...creenplay-installedlistfilter-members.html | 2 +- Docs/html/screenplay-installedlistfilter.html | 12 +- ...screenplay-installedlistmodel-members.html | 2 +- Docs/html/screenplay-installedlistmodel.html | 14 +- Docs/html/screenplay-module.html | 58 +++++ .../screenplay-monitorlistmodel-members.html | 2 +- Docs/html/screenplay-monitorlistmodel.html | 12 +- Docs/html/screenplay-profilelistmodel.html | 2 +- ...play-projectsettingslistmodel-members.html | 1 - .../screenplay-projectsettingslistmodel.html | 8 +- .../screenplay-screenplaymanager-members.html | 21 +- Docs/html/screenplay-screenplaymanager.html | 88 ++------ ...creenplay-screenplaywallpaper-members.html | 19 +- Docs/html/screenplay-screenplaywallpaper.html | 41 ++-- .../screenplay-screenplaywidget-members.html | 11 +- Docs/html/screenplay-screenplaywidget.html | 21 +- .../screenplay-sdkconnection-members.html | 4 +- Docs/html/screenplay-sdkconnection.html | 12 +- Docs/html/screenplay-settings-members.html | 6 +- Docs/html/screenplay-settings.html | 12 +- Docs/html/screenplay-util-members.html | 16 +- Docs/html/screenplay-util.html | 61 +----- Docs/html/screenplay-wizards.html | 10 +- Docs/html/screenplay.html | 2 +- Docs/html/screenplaysdk-members.html | 27 +++ Docs/html/screenplaysdk-module.html | 37 ++++ Docs/html/screenplaysdk.html | 60 ++++++ Docs/html/screenplayshader-module.html | 37 ++++ Docs/html/screenplaysysinfo-module.html | 42 ++++ Docs/html/screenplayutil-module.html | 37 ++++ Docs/html/screenplayutil.html | 142 ++++++++++++ Docs/html/screenplaywallpaper-module.html | 39 ++++ Docs/html/screenplaywidget-module.html | 37 ++++ Docs/html/shaderlibrary-members.html | 24 +++ Docs/html/shaderlibrary.html | 57 +++++ Docs/html/storage.html | 35 +++ Docs/html/sysinfo-members.html | 28 +++ Docs/html/sysinfo.html | 56 +++++ Docs/html/uptime-members.html | 33 +++ Docs/html/uptime.html | 66 ++++++ Docs/html/widgetwindow-members.html | 33 +++ Docs/html/widgetwindow.html | 66 ++++++ .../windowsdesktopproperties-members.html | 40 ++++ Docs/html/windowsdesktopproperties.html | 69 ++++++ Docs/html/winwindow-members.html | 92 ++++++++ Docs/html/winwindow.html | 54 +++++ Docs/index.html | 203 ++++++++---------- ScreenPlay/app.cpp | 6 +- ScreenPlaySDK/src/screenplaysdk.cpp | 12 ++ ScreenPlayShader/shaderlibrary.cpp | 12 ++ ScreenPlaySysInfo/cpu.cpp | 7 + ScreenPlaySysInfo/gpu.cpp | 45 ++-- ScreenPlaySysInfo/ram.cpp | 7 + ScreenPlaySysInfo/storage.cpp | 7 + ScreenPlaySysInfo/sysinfo.cpp | 13 ++ ScreenPlaySysInfo/uptime.cpp | 6 + .../inc/public/ScreenPlayUtil/contenttypes.h | 20 +- ScreenPlayUtil/src/util.cpp | 11 + ScreenPlayWallpaper/src/basewindow.cpp | 12 ++ .../src/windowsdesktopproperties.cpp | 7 + ScreenPlayWallpaper/src/winwindow.cpp | 21 +- ScreenPlayWidget/src/widgetwindow.cpp | 12 ++ Tools/qdoc.py | 16 ++ 79 files changed, 2112 insertions(+), 434 deletions(-) create mode 100644 Docs/html/basewindow-members.html create mode 100644 Docs/html/basewindow.html create mode 100644 Docs/html/cpu-members.html create mode 100644 Docs/html/cpu.html create mode 100644 Docs/html/gpu-members.html create mode 100644 Docs/html/gpu.html create mode 100644 Docs/html/ram-members.html create mode 100644 Docs/html/ram.html create mode 100644 Docs/html/screenplay-module.html create mode 100644 Docs/html/screenplaysdk-members.html create mode 100644 Docs/html/screenplaysdk-module.html create mode 100644 Docs/html/screenplaysdk.html create mode 100644 Docs/html/screenplayshader-module.html create mode 100644 Docs/html/screenplaysysinfo-module.html create mode 100644 Docs/html/screenplayutil-module.html create mode 100644 Docs/html/screenplayutil.html create mode 100644 Docs/html/screenplaywallpaper-module.html create mode 100644 Docs/html/screenplaywidget-module.html create mode 100644 Docs/html/shaderlibrary-members.html create mode 100644 Docs/html/shaderlibrary.html create mode 100644 Docs/html/storage.html create mode 100644 Docs/html/sysinfo-members.html create mode 100644 Docs/html/sysinfo.html create mode 100644 Docs/html/uptime-members.html create mode 100644 Docs/html/uptime.html create mode 100644 Docs/html/widgetwindow-members.html create mode 100644 Docs/html/widgetwindow.html create mode 100644 Docs/html/windowsdesktopproperties-members.html create mode 100644 Docs/html/windowsdesktopproperties.html create mode 100644 Docs/html/winwindow-members.html create mode 100644 Docs/html/winwindow.html create mode 100644 Tools/qdoc.py diff --git a/Docs/config.qdocconf b/Docs/config.qdocconf index 355102a7..fdc786fe 100644 --- a/Docs/config.qdocconf +++ b/Docs/config.qdocconf @@ -1,11 +1,11 @@ # Run: -# C:\Qt\6.0.0\msvc2019_64\bin\qdoc.exe config.qdocconf +# C:\Qt\6.1.0\msvc2019_64\bin\qdoc.exe config.qdocconf # in this directory. You can shift + right click in this explorer # window and select "Open PowerShell Window here" for this. -include(C:\Qt\6.0.0\msvc2019_64\doc\global\qt-cpp-defines.qdocconf) -include(C:\Qt\6.0.0\msvc2019_64\doc\global\compat.qdocconf) -include(C:\Qt\6.0.0\msvc2019_64\doc\global\fileextensions.qdocconf) +include(C:\Qt\6.1.0\msvc2019_64\doc\global\qt-cpp-defines.qdocconf) +include(C:\Qt\6.1.0\msvc2019_64\doc\global\compat.qdocconf) +include(C:\Qt\6.1.0\msvc2019_64\doc\global\fileextensions.qdocconf) descripton = ScreenPlay is an open source cross plattform app for displaying Wallpaper, Widgets and AppDrawer. language = Cpp @@ -20,36 +20,45 @@ sourcedirs += ../ScreenPlayWallpaper/src/ sourcedirs += ../ScreenPlayWallpaper/ sourcedirs += ../ScreenPlayWidget/src/ sourcedirs += ../ScreenPlayWidget/ +sourcedirs += ../ScreenPlayShader/ +sourcedirs += ../ScreenPlayUtil/ +sourcedirs += ../ScreenPlayUtil/src/ # Header headerdirs += ../ScreenPlay/src/ headerdirs += ../ScreenPlay/ headerdirs += ../ScreenPlaySDK/ +headerdirs += ../ScreenPlaySDK/inc/ headerdirs += ../ScreenPlaySysInfo/ headerdirs += ../ScreenPlayWallpaper/src/ headerdirs += ../ScreenPlayWallpaper/ headerdirs += ../ScreenPlayWidget/src/ headerdirs += ../ScreenPlayWidget/ +headerdirs += ../ScreenPlayShader/ +headerdirs += ../ScreenPlayUtil/inc/ # Include includepaths += ../ScreenPlay/src/ includepaths += ../ScreenPlay/ includepaths += ../ScreenPlaySDK/ +includepaths += ../ScreenPlaySDK/src/ includepaths += ../ScreenPlaySysInfo/ includepaths += ../ScreenPlayWallpaper/src/ includepaths += ../ScreenPlayWallpaper/ includepaths += ../ScreenPlayWidget/src/ includepaths += ../ScreenPlayWidget/ +includepaths += ../ScreenPlayShader/ +includepaths += ../ScreenPlayUtil/ # qt -includepaths += C:/Qt/6.0.0/msvc2019_64/include/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtCore/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtGui/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtQml/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtWebEngine/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtNetwork/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtQuick/ -includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtQuickControls2/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtCore/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtGui/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtQml/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtWebEngine/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtNetwork/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtQuick/ +includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtQuickControls2/ diff --git a/Docs/css/style.css b/Docs/css/style.css index 28cb7013..5432a960 100644 --- a/Docs/css/style.css +++ b/Docs/css/style.css @@ -16,12 +16,17 @@ h2 { } a { - color:#41cd52 !important; + color:#ff6e42 !important; + text-decoration: none !important; } img { box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24); } +.table > :not(caption) > * > * { + border-color: #ececec; +} + p { color: #546E7A; } diff --git a/Docs/html/basewindow-members.html b/Docs/html/basewindow-members.html new file mode 100644 index 00000000..30babe10 --- /dev/null +++ b/Docs/html/basewindow-members.html @@ -0,0 +1,89 @@ + + + + + + List of All Members for BaseWindow | ScreenPlay + + + +
Home
+
  • BaseWindow
    • +
    +

    List of All Members for BaseWindow

    +

    This is the complete list of members for BaseWindow, including inherited members.

    +
    + +
    +
    + + diff --git a/Docs/html/basewindow.html b/Docs/html/basewindow.html new file mode 100644 index 00000000..26f9c8e3 --- /dev/null +++ b/Docs/html/basewindow.html @@ -0,0 +1,138 @@ + + + + + + BaseWindow Class | ScreenPlay + + + +
    Home
    +
  • BaseWindow
    • +
    +
    +

    Contents

    + +
    +
    +

    BaseWindow Class

    + +

    . More...

    + +
    +
    Header: #include <BaseWindow> +
    Inherited By:

    WinWindow

    +
    + +

    Public Functions

    +
    + + + + + + + + + + + + + + + + + + + + + +
    QString OSVersion() const
    QVector<int> activeScreensList() const
    QString appID() const
    QString basePath() const
    bool canFade() const
    bool checkWallpaperVisible() const
    const QString &contentBasePath() const
    float currentTime() const
    bool debugMode() const
    QString fillMode() const
    QString fullContentPath() const
    int height() const
    bool isPlaying() const
    bool loops() const
    bool muted() const
    float playbackRate() const
    int *sdk() const
    int type() const
    bool visualsPaused() const
    float volume() const
    int width() const
    + +

    Public Slots

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    QString getApplicationPath()
    QString loadFromFile(const QString &filename)
    virtual void messageReceived(QString key, QString value)
    virtual void replaceWallpaper(const QString absolutePath, const QString file, const float volume, const QString fillMode, const QString type, const bool checkWallpaperVisible)
    void setActiveScreensList(QVector<int> activeScreensList)
    void setAppID(QString appID)
    void setBasePath(QString basePath)
    void setCanFade(bool canFade)
    void setCheckWallpaperVisible(bool checkWallpaperVisible)
    void setContentBasePath(const QString &contentBasePath)
    void setCurrentTime(float currentTime)
    void setDebugMode(bool debugMode)
    void setFillMode(QString fillMode)
    void setFullContentPath(QString fullContentPath)
    void setHeight(int height)
    void setIsPlaying(bool isPlaying)
    void setLoops(bool loops)
    void setMuted(bool muted)
    void setOSVersion(QString OSVersion)
    void setPlaybackRate(float playbackRate)
    void setSdk(int *sdk)
    void setType(int type)
    void setVisualsPaused(bool visualsPaused)
    void setVolume(float volume)
    void setWidth(int width)
    + +

    Signals

    +
    + + + + + + + + + + + + + + + + + + + + + +
    void OSVersionChanged(QString OSVersion)
    void activeScreensListChanged(QVector<int> activeScreensList)
    void appIDChanged(QString appID)
    void basePathChanged(QString basePath)
    void canFadeChanged(bool canFade)
    void checkWallpaperVisibleChanged(bool checkWallpaperVisible)
    void contentBasePathChanged(const QString &)
    void currentTimeChanged(float currentTime)
    void debugModeChanged(bool debugMode)
    void fillModeChanged(QString fillMode)
    void fullContentPathChanged(QString fullContentPath)
    void heightChanged(int height)
    void isPlayingChanged(bool isPlaying)
    void loopsChanged(bool loops)
    void mutedChanged(bool muted)
    void playbackRateChanged(float playbackRate)
    void sdkChanged(int *sdk)
    void typeChanged(int type)
    void visualsPausedChanged(bool visualsPaused)
    void volumeChanged(float volume)
    void widthChanged(int width)
    + + +
    +

    Detailed Description

    +
    + +
    +

    Member Function Documentation

    + +

    [slot] QString BaseWindow::getApplicationPath()

    +

    This public slot is for QML usage.

    + + +

    [slot] QString BaseWindow::loadFromFile(const QString &filename)

    +

    Used for loading shader. Loading shader relative to the qml file will be available in Qt 6

    + + +

    [virtual slot] void BaseWindow::messageReceived(QString key, QString value)

    +

    messageReceived.

    + + +

    [virtual slot] void BaseWindow::replaceWallpaper(const QString absolutePath, const QString file, const float volume, const QString fillMode, const QString type, const bool checkWallpaperVisible)

    +

    replaceWallpaper.

    + +
    + + diff --git a/Docs/html/cpu-members.html b/Docs/html/cpu-members.html new file mode 100644 index 00000000..fc2a9fc6 --- /dev/null +++ b/Docs/html/cpu-members.html @@ -0,0 +1,23 @@ + + + + + + List of All Members for CPU | ScreenPlay + + + +
    Home
    +
  • CPU
    • +
    +

    List of All Members for CPU

    +

    This is the complete list of members for CPU, including inherited members.

    + + + diff --git a/Docs/html/cpu.html b/Docs/html/cpu.html new file mode 100644 index 00000000..34f9aec7 --- /dev/null +++ b/Docs/html/cpu.html @@ -0,0 +1,56 @@ + + + + + + CPU Class | ScreenPlay + + + +
    Home
    +
  • CPU
    • +
    +
    +

    Contents

    + +
    +
    +

    CPU Class

    + +

    . More...

    + +
    +
    Header: #include <CPU> +
    + +

    Public Functions

    +
    + + +
    int tickRate() const
    float usage() const
    + +

    Public Slots

    +
    + +
    void setTickRate(int tickRate)
    + +

    Signals

    +
    + + +
    void tickRateChanged(int tickRate)
    void usageChanged(float usage)
    + + +
    +

    Detailed Description

    +
    + + + diff --git a/Docs/html/gpu-members.html b/Docs/html/gpu-members.html new file mode 100644 index 00000000..4f331978 --- /dev/null +++ b/Docs/html/gpu-members.html @@ -0,0 +1,33 @@ + + + + + + List of All Members for GPU | ScreenPlay + + + +
    Home
    +
  • GPU
    • +
    +

    List of All Members for GPU

    +

    This is the complete list of members for GPU, including inherited members.

    + + + diff --git a/Docs/html/gpu.html b/Docs/html/gpu.html new file mode 100644 index 00000000..7e48bd57 --- /dev/null +++ b/Docs/html/gpu.html @@ -0,0 +1,66 @@ + + + + + + GPU Class | ScreenPlay + + + +
    Home
    +
  • GPU
    • +
    +
    +

    Contents

    + +
    +
    +

    GPU Class

    + +

    . More...

    + +
    +
    Header: #include <GPU> +
    + +

    Public Functions

    +
    + + + + + +
    int cacheSize() const
    int maxFrequency() const
    const QString &name() const
    int ramSize() const
    const QString &vendor() const
    + +

    Public Slots

    +
    + + + + + +
    void setCacheSize(int cacheSize)
    void setMaxFrequency(int maxFrequency)
    void setName(const QString &name)
    void setRamSize(int ramSize)
    void setVendor(const QString &vendor)
    + +

    Signals

    +
    + + + + + +
    void cacheSizeChanged(int cacheSize)
    void maxFrequencyChanged(int maxFrequency)
    void nameChanged(const QString &name)
    void ramSizeChanged(int ramSize)
    void vendorChanged(const QString &vendor)
    + + +
    +

    Detailed Description

    +
    + + + diff --git a/Docs/html/ram-members.html b/Docs/html/ram-members.html new file mode 100644 index 00000000..4af14cd9 --- /dev/null +++ b/Docs/html/ram-members.html @@ -0,0 +1,32 @@ + + + + + + List of All Members for RAM | ScreenPlay + + + +
    Home
    +
  • RAM
    • +
    +

    List of All Members for RAM

    +

    This is the complete list of members for RAM, including inherited members.

    + + + diff --git a/Docs/html/ram.html b/Docs/html/ram.html new file mode 100644 index 00000000..b64a16d0 --- /dev/null +++ b/Docs/html/ram.html @@ -0,0 +1,60 @@ + + + + + + RAM Class | ScreenPlay + + + +
    Home
    +
  • RAM
    • +
    +
    +

    Contents

    + +
    +
    +

    RAM Class

    + +

    . More...

    + +
    +
    Header: #include <RAM> +
    + +

    Public Functions

    +
    + + + + + + + +
    unsigned long long totalPagingMemory() const
    unsigned long long totalPhysicalMemory() const
    unsigned long long totalVirtualMemory() const
    float usage() const
    unsigned long long usedPagingMemory() const
    unsigned long long usedPhysicalMemory() const
    unsigned long long usedVirtualMemory() const
    + +

    Signals

    +
    + + + + + + + +
    void totalPagingMemoryChanged(unsigned long long totalPagingMemory)
    void totalPhysicalMemoryChanged(unsigned long long totalPhysicalMemory)
    void totalVirtualMemoryChanged(unsigned long long totalVirtualMemory)
    void usageChanged(float usage)
    void usedPagingMemoryChanged(unsigned long long usedPagingMemory)
    void usedPhysicalMemoryChanged(unsigned long long usedPhysicalMemory)
    void usedVirtualMemoryChanged(unsigned long long usedVirtualMemory)
    + + +
    +

    Detailed Description

    +
    + + + diff --git a/Docs/html/screenplay-app.html b/Docs/html/screenplay-app.html index 9b760f48..643e80c7 100644 --- a/Docs/html/screenplay-app.html +++ b/Docs/html/screenplay-app.html @@ -21,9 +21,9 @@

    App Class

    -class ScreenPlay::App +class ScreenPlay::App -

    The App class contains all members for ScreenPlay. More...

    +

    The App class contains all members for ScreenPlay. More...

    - + @@ -64,8 +64,8 @@

    Member Function Documentation

    - -

    CreateImportVideo::CreateImportVideo(const QString &videoPath, const QString &exportPath, const QStringList &codecs, QObject *parent = nullptr)

    + +

    CreateImportVideo::CreateImportVideo(const QString &videoPath, const QString &exportPath, const QString &codec, const int quality, QObject *parent = nullptr)

    Creates a CreateImportVideo object to be used in a different thread. A videoPath and a exportPath are needed for convertion.

    @@ -100,7 +100,7 @@ args.append(m_exportPath +<

    [slot] bool CreateImportVideo::createWallpaperInfo()

    -

    Starts ffprobe and tries to parse the resulting json. Returns false if :

    +

    Starts ffprobe and tries to parse the resulting json. If the video is a container that not contains the video length like webm or mkv we need to count the frames ourself. We then call analyzeWebmReadFrames or analyzeVideo to parse the output. Returns false if :

    • Parsing the output json of ffprobe fails.
    • Has no video.
      • @@ -108,8 +108,8 @@ args.append(m_exportPath +<
    • Is a wrong file format or generally broken.
    - -

    [slot] bool CreateImportVideo::createWallpaperVideo(const QString &codec)

    + +

    [slot] bool CreateImportVideo::createWallpaperVideo()

    Starts ffmpeg and tries to covert the given video to a webm video.

    //[...]
 args.append("-c:v");
diff --git a/Docs/html/screenplay-globalvariables.html b/Docs/html/screenplay-globalvariables.html
index 4c653f76..86c81d72 100644
--- a/Docs/html/screenplay-globalvariables.html
+++ b/Docs/html/screenplay-globalvariables.html
@@ -21,7 +21,7 @@

    GlobalVariables Class

    -class ScreenPlay::GlobalVariables +class ScreenPlay::GlobalVariables

    Contains all variables that are globally needed. More...

    diff --git a/Docs/html/screenplay-installedlistfilter-members.html b/Docs/html/screenplay-installedlistfilter-members.html index 8bbaf101..d8b5e13b 100644 --- a/Docs/html/screenplay-installedlistfilter-members.html +++ b/Docs/html/screenplay-installedlistfilter-members.html @@ -15,8 +15,8 @@ diff --git a/Docs/html/screenplay-installedlistfilter.html b/Docs/html/screenplay-installedlistfilter.html index 8432968e..038bd328 100644 --- a/Docs/html/screenplay-installedlistfilter.html +++ b/Docs/html/screenplay-installedlistfilter.html @@ -20,7 +20,7 @@

    InstalledListFilter Class

    -class ScreenPlay::InstalledListFilter +class ScreenPlay::InstalledListFilter

    Proxy between Installed List Model and QML view to filter items. More...

    @@ -38,8 +38,8 @@

    Public Slots

    Header: #include <App> @@ -111,19 +111,19 @@

    Member Function Documentation

    App::App()

    -

    Constructor creates and holds all classes used by ScreenPlay via unique_ptr or shared_ptr.

    +

    Constructor creates and holds all classes used by ScreenPlay via unique_ptr or shared_ptr.

    [slot] void App::exit()

    -

    Tries to send the telemetry quit event before we call quit ourself.

    +

    Calls QApplication quit() and can be used to do additional tasks before exiting.

    [slot] bool App::loadSteamPlugin()

    -

    Loads the Steam plugin when needed. This enables to start ScreenPlay via OS autostart without waiting for Steam first.

    +

    Loads the Steam plugin when needed. This enables to start ScreenPlay via OS autostart without waiting for Steam first.

    void App::init()

    -

    Used for initialization after the constructor. The sole purpose is to check if another ScreenPlay instance is running and then quit early. This is also because we cannot call QApplication::quit(); in the SDKConnector before the app.exec(); ( the Qt main event loop ) has started.

    +

    Used for initialization after the constructor. The sole purpose is to check if another ScreenPlay instance is running and then quit early. This is also because we cannot call QApplication::quit(); in the SDKConnector before the app.exec(); ( the Qt main event loop ) has started.

    diff --git a/Docs/html/screenplay-create-members.html b/Docs/html/screenplay-create-members.html index 933daa53..06ffae3f 100644 --- a/Docs/html/screenplay-create-members.html +++ b/Docs/html/screenplay-create-members.html @@ -17,7 +17,7 @@
  • Create(const std::shared_ptr<GlobalVariables> &, QObject *)
  • abortAndCleanup()
  • appendFfmpegOutput(QString)
    • -
  • createWallpaperStart(QString, Create::VideoCodec)
    • +
  • createWallpaperStart(QString, Create::VideoCodec, const int)
  • ffmpegOutputChanged(QString)
  • progressChanged(float)
  • saveWallpaper(QString, QString, QString, QString, QString, ScreenPlay::Create::VideoCodec, QVector<QString>)
    • diff --git a/Docs/html/screenplay-create.html b/Docs/html/screenplay-create.html index 489e5a8e..2d8207c9 100644 --- a/Docs/html/screenplay-create.html +++ b/Docs/html/screenplay-create.html @@ -21,7 +21,7 @@

    Create Class

    -class ScreenPlay::Create +class ScreenPlay::Create

    Baseclass for creating wallapers, widgets and the corresponding wizards. More...

    @@ -44,7 +44,7 @@
    - + @@ -77,8 +77,8 @@

    [slot] void Create::abortAndCleanup()

    This method is called when the user manually aborts the wallpaper import.

    - -

    [slot] void Create::createWallpaperStart(QString videoPath, Create::VideoCodec codec)

    + +

    [slot] void Create::createWallpaperStart(QString videoPath, Create::VideoCodec codec, const int quality = 50)

    Starts the process.

    diff --git a/Docs/html/screenplay-createimportvideo-members.html b/Docs/html/screenplay-createimportvideo-members.html index 285340a0..1cb4b74c 100644 --- a/Docs/html/screenplay-createimportvideo-members.html +++ b/Docs/html/screenplay-createimportvideo-members.html @@ -13,13 +13,13 @@

    List of All Members for CreateImportVideo

    This is the complete list of members for ScreenPlay::CreateImportVideo, including inherited members.

    void abortAndCleanup()
    void appendFfmpegOutput(QString ffmpegOutput)
    void createWallpaperStart(QString videoPath, Create::VideoCodec codec)
    void createWallpaperStart(QString videoPath, Create::VideoCodec codec, const int quality = 50)
    void saveWallpaper(QString title, QString description, QString filePath, QString previewImagePath, QString youtube, ScreenPlay::Create::VideoCodec codec, QVector<QString> tags)
    void setProgress(float progress)
    void setWorkingDir(const QString &workingDir)
    - +
    CreateImportVideo(const QString &videoPath, const QString &exportPath, const QStringList &codecs, QObject *parent = nullptr)
    CreateImportVideo(const QString &videoPath, const QString &exportPath, const QString &codec, const int quality, QObject *parent = nullptr)
    CreateImportVideo(QObject *parent = nullptr)
    float progress() const
    @@ -44,7 +44,7 @@
    bool createWallpaperImagePreview()
    bool createWallpaperImageThumbnailPreview()
    bool createWallpaperInfo()
    bool createWallpaperVideo(const QString &codec)
    bool createWallpaperVideo()
    bool createWallpaperVideoPreview()
    bool extractWallpaperAudio()
    void process()
    + -
    void resetFilter()
    void setSortOrder(const Qt::SortOrder sortOrder)
    void sortByName(const QString &name)
    void sortBySearchType(const ScreenPlay::SearchType::SearchType searchType)
    @@ -58,14 +58,14 @@

    [slot] void InstalledListFilter::resetFilter()

    Resets the filter and sorts by title.

    + +

    [slot] void InstalledListFilter::setSortOrder(const Qt::SortOrder sortOrder)

    +

    sets the sort order by date.

    +

    [slot] void InstalledListFilter::sortByName(const QString &name)

    Invoked when the user uses the quicksearch at the top right of the installed page. Uses the name to sort by name. This name is saved in the project.json title.

    - -

    [slot] void InstalledListFilter::sortBySearchType(const ScreenPlay::SearchType::SearchType searchType)

    -

    .

    -
    diff --git a/Docs/html/screenplay-installedlistmodel-members.html b/Docs/html/screenplay-installedlistmodel-members.html index 14e71dac..17ed3e22 100644 --- a/Docs/html/screenplay-installedlistmodel-members.html +++ b/Docs/html/screenplay-installedlistmodel-members.html @@ -14,7 +14,7 @@

    This is the complete list of members for ScreenPlay::InstalledListModel, including inherited members.

    • InstalledListModel(const std::shared_ptr<GlobalVariables> &, QObject *)
      • -
    • append(const QJsonObject &, const QString &)
      • +
    • append(const QJsonObject &, const QString &, const QDateTime &)
    • countChanged(int)
    • deinstallItemAt(const int) : bool
    • get(const QString &) const : QVariantMap
      • diff --git a/Docs/html/screenplay-installedlistmodel.html b/Docs/html/screenplay-installedlistmodel.html index cf5046a2..5a3f11d2 100644 --- a/Docs/html/screenplay-installedlistmodel.html +++ b/Docs/html/screenplay-installedlistmodel.html @@ -22,7 +22,7 @@

    InstalledListModel Class

    -class ScreenPlay::InstalledListModel +class ScreenPlay::InstalledListModel

    Lists all installed wallpapers, widgets etc. from a given Path. More...

    @@ -47,7 +47,7 @@

    Public Slots

    - + @@ -73,13 +73,13 @@

    InstalledListModel::InstalledListModel(const std::shared_ptr<GlobalVariables> &globalVariables, QObject *parent = nullptr)

    Constructor.

    - -

    [slot] void InstalledListModel::append(const QJsonObject &obj, const QString &folderName)

    -

    .

    + +

    [slot] void InstalledListModel::append(const QJsonObject &obj, const QString &folderName, const QDateTime &lastModified)

    +

    Append an ProjectFile to the list.

    [slot] bool InstalledListModel::deinstallItemAt(const int index)

    -

    .

    +

    Deleted the item from the local storage and removes it from the installed list.

    [slot] QVariantMap InstalledListModel::get(const QString &folderId) const

    @@ -91,7 +91,7 @@

    [slot] void InstalledListModel::loadInstalledContent()

    -

    .

    +

    Loads all installed content. Skips projects.json without a "type" field.

    [slot] void InstalledListModel::reset()

    diff --git a/Docs/html/screenplay-module.html b/Docs/html/screenplay-module.html new file mode 100644 index 00000000..5b92ceb8 --- /dev/null +++ b/Docs/html/screenplay-module.html @@ -0,0 +1,58 @@ + + + + + + ScreenPlay + + + +
    Home
    +
    +
    +

    Contents

    + +
    +
    +

    ScreenPlay

    + + +

    Module for ScreenPlay. More...

    + + +

    Namespaces

    +
    void append(const QJsonObject &obj, const QString &folderName)
    void append(const QJsonObject &obj, const QString &folderName, const QDateTime &lastModified)
    bool deinstallItemAt(const int index)
    QVariantMap get(const QString &folderId) const
    void init()
    + +

    ScreenPlay

    Namespace for ScreenPlay

    + +

    Classes

    +
    + + + + + + + + + + + + + + + + +

    ScreenPlay::App

    Contains all members for ScreenPlay

    ScreenPlay::Create

    Baseclass for creating wallapers, widgets and the corresponding wizards

    ScreenPlay::CreateImportVideo

    This class imports (copies) and creates wallaper previews

    ScreenPlay::GlobalVariables

    Contains all variables that are globally needed

    ScreenPlay::InstalledListFilter

    Proxy between Installed List Model and QML view to filter items

    ScreenPlay::InstalledListModel

    Lists all installed wallpapers, widgets etc. from a given Path

    ScreenPlay::MonitorListModel

    MonitorListModel

    ScreenPlay::ProfileListModel

    Used to save all active wallpapers and widgets position and configurations after a restart

    ScreenPlay::ProjectSettingsListModel

    Used for the dynamic loading of the properties json object inside a project.json

    ScreenPlay::SDKConnection

    Contains all connections to Wallpaper and Widgets

    ScreenPlay::ScreenPlayManager

    Used to manage multiple ScreenPlayWallpaper and ScreenPlayWidget

    ScreenPlay::ScreenPlayWallpaper

    A Single Object to manage a Wallpaper

    ScreenPlay::ScreenPlayWidget

    A Single Object to manage a Widget

    ScreenPlay::Settings

    Global settings class for reading and writing settings

    ScreenPlay::Util

    Easy to use global object to use when certain functionality is not available in QML

    ScreenPlay::Wizards

    Baseclass for all wizards. Mostly for copying and creating project files

    + + +
    +

    Detailed Description

    +
    + + + diff --git a/Docs/html/screenplay-monitorlistmodel-members.html b/Docs/html/screenplay-monitorlistmodel-members.html index bcecd99b..ed7e62fc 100644 --- a/Docs/html/screenplay-monitorlistmodel-members.html +++ b/Docs/html/screenplay-monitorlistmodel-members.html @@ -22,7 +22,7 @@
  • getAppIDByMonitorIndex(const int) const : std::optional<QString>
  • roleNames() const : QHash<int, QByteArray>
  • rowCount(const QModelIndex &) const : int
    • -
  • setWallpaperActiveMonitor(const std::shared_ptr<ScreenPlayWallpaper> &, const QVector<int>)
    • +
  • setWallpaperMonitor(const std::shared_ptr<ScreenPlayWallpaper> &, const QVector<int>)
    • diff --git a/Docs/html/screenplay-monitorlistmodel.html b/Docs/html/screenplay-monitorlistmodel.html index 4140dcaa..9ecec61f 100644 --- a/Docs/html/screenplay-monitorlistmodel.html +++ b/Docs/html/screenplay-monitorlistmodel.html @@ -21,7 +21,7 @@

    MonitorListModel Class

    -class ScreenPlay::MonitorListModel +class ScreenPlay::MonitorListModel

    MonitorListModel. More...

    @@ -35,7 +35,7 @@
    - +
    MonitorListModel(QObject *parent = nullptr)
    std::optional<QString> getAppIDByMonitorIndex(const int index) const
    void setWallpaperActiveMonitor(const std::shared_ptr<ScreenPlayWallpaper> &wallpaper, const QVector<int> monitors)
    void setWallpaperMonitor(const std::shared_ptr<ScreenPlayWallpaper> &wallpaper, const QVector<int> monitors)

    Reimplemented Public Functions

    @@ -103,10 +103,10 @@

    [override virtual] int MonitorListModel::rowCount(const QModelIndex &parent = QModelIndex()) const

    Returns the amount of active monitors.

    - -

    void MonitorListModel::setWallpaperActiveMonitor(const std::shared_ptr<ScreenPlayWallpaper> &wallpaper, const QVector<int> monitors)

    -

    Sets the previewImage and appID for a list item.

    - + +

    void MonitorListModel::setWallpaperMonitor(const std::shared_ptr<ScreenPlayWallpaper> &wallpaper, const QVector<int> monitors)

    +

    Sets a shared_ptr to the monitor list. This should be used to set and remove the shared_ptr.

    +
    diff --git a/Docs/html/screenplay-profilelistmodel.html b/Docs/html/screenplay-profilelistmodel.html index d8c37c6b..6c3441c6 100644 --- a/Docs/html/screenplay-profilelistmodel.html +++ b/Docs/html/screenplay-profilelistmodel.html @@ -20,7 +20,7 @@

    ProfileListModel Class

    -class ScreenPlay::ProfileListModel +class ScreenPlay::ProfileListModel

    Used to save all active wallpapers and widgets position and configurations after a restart. More...

    diff --git a/Docs/html/screenplay-projectsettingslistmodel-members.html b/Docs/html/screenplay-projectsettingslistmodel-members.html index ef50e80b..086b9d2d 100644 --- a/Docs/html/screenplay-projectsettingslistmodel-members.html +++ b/Docs/html/screenplay-projectsettingslistmodel-members.html @@ -17,7 +17,6 @@
  • append(const ScreenPlay::SettingsItem &&)
  • data(const QModelIndex &, int) const : QVariant
  • getActiveSettingsJson() : QJsonObject
    • -
  • init(const InstalledType::InstalledType &, const QJsonObject &)
  • roleNames() const : QHash<int, QByteArray>
  • rowCount(const QModelIndex &) const : int
    • diff --git a/Docs/html/screenplay-projectsettingslistmodel.html b/Docs/html/screenplay-projectsettingslistmodel.html index e737ba2a..c5078c2a 100644 --- a/Docs/html/screenplay-projectsettingslistmodel.html +++ b/Docs/html/screenplay-projectsettingslistmodel.html @@ -21,7 +21,7 @@

    ProjectSettingsListModel Class

    -class ScreenPlay::ProjectSettingsListModel +class ScreenPlay::ProjectSettingsListModel

    ProjectSettingsListModel used for the dynamic loading of the properties json object inside a project.json. More...

    @@ -35,7 +35,6 @@
    -
    void append(const ScreenPlay::SettingsItem &&item)
    QJsonObject getActiveSettingsJson()
    void init(const InstalledType::InstalledType &type, const QJsonObject &properties)

    Reimplemented Public Functions

    @@ -95,11 +94,6 @@

    QJsonObject ProjectSettingsListModel::getActiveSettingsJson()

    ProjectSettingsListModel::getActiveSettingsJson

    - -

    void ProjectSettingsListModel::init(const InstalledType::InstalledType &type, const QJsonObject &properties)

    -

    Constructor when loading properties from settings.json We need to _flatten_ the json to make it work with a flat list model! See

    -

    See also getActiveSettingsJson, to, make, the, flat, list, to, a, hierarchical, json, and object.

    -

    [override virtual] QHash<int, QByteArray> ProjectSettingsListModel::roleNames() const

    .

    diff --git a/Docs/html/screenplay-screenplaymanager-members.html b/Docs/html/screenplay-screenplaymanager-members.html index d0e4fb01..9582f33a 100644 --- a/Docs/html/screenplay-screenplaymanager-members.html +++ b/Docs/html/screenplay-screenplaymanager-members.html @@ -17,27 +17,20 @@
  • ScreenPlayManager(QObject *)
  • activeWallpaperCounterChanged(int)
  • activeWidgetsCounterChanged(int)
    • -
  • closeAllWallpapers()
    • -
  • closeAllWidgets()
    • -
  • closeConnection(const QString &) : bool
    • -
  • closeConntectionByType(const QStringList &) : bool
    • -
  • createWallpaper(const ScreenPlay::InstalledType::InstalledType, const ScreenPlay::FillMode::FillMode, const QString &, const QString &, const QString &, const QVector<int> &, const float, const float, const QJsonObject &, const bool)
    • -
  • createWidget(const ScreenPlay::InstalledType::InstalledType, const QPoint &, const QString &, const QString &, const QJsonObject &, const bool)
  • getWallpaperByAppID(const QString &) const : ScreenPlay::ScreenPlayWallpaper *
  • newConnection()
    • -
  • removeAllWallpapers()
    • +
  • removeAllWallpapers() : bool
    • +
  • removeAllWidgets() : bool
    • +
  • requestProjectSettingsAtMonitorIndex(const int) : bool
    • diff --git a/Docs/html/screenplay-screenplaymanager.html b/Docs/html/screenplay-screenplaymanager.html index 0727cf2f..9835269b 100644 --- a/Docs/html/screenplay-screenplaymanager.html +++ b/Docs/html/screenplay-screenplaymanager.html @@ -21,7 +21,7 @@

    ScreenPlayManager Class

    -class ScreenPlay::ScreenPlayManager +class ScreenPlay::ScreenPlayManager

    The ScreenPlayManager is used to manage multiple ScreenPlayWallpaper and ScreenPlayWidget. More...

    @@ -36,28 +36,21 @@ ScreenPlayManager(QObject *parent = nullptr) int activeWallpaperCounter() const int activeWidgetsCounter() const - void init(const std::shared_ptr<GlobalVariables> &globalVariables, const std::shared_ptr<MonitorListModel> &mlm, const int &telemetry, const std::shared_ptr<Settings> &settings) + void init(const std::shared_ptr<GlobalVariables> &globalVariables, const std::shared_ptr<MonitorListModel> &mlm, const std::shared_ptr<Settings> &settings)

    Public Slots

    - - - - - - - - - - + + + - - - + + +
    void closeAllWallpapers()
    void closeAllWidgets()
    bool closeConnection(const QString &appID)
    bool closeConntectionByType(const QStringList &types)
    void createWallpaper(const ScreenPlay::InstalledType::InstalledType type, const ScreenPlay::FillMode::FillMode fillMode, const QString &absoluteStoragePath, const QString &previewImage, const QString &file, const QVector<int> &monitorIndex, const float volume, const float playbackRate, const QJsonObject &properties, const bool saveToProfilesConfigFile)
    void createWidget(const ScreenPlay::InstalledType::InstalledType type, const QPoint &position, const QString &absoluteStoragePath, const QString &previewImage, const QJsonObject &properties, const bool saveToProfilesConfigFile)
    ScreenPlay::ScreenPlayWallpaper *getWallpaperByAppID(const QString &appID) const
    void newConnection()
    void removeAllWallpapers()
    void removeAllWidgets()
    bool removeApp(const QString &appID)
    void requestProjectSettingsAtMonitorIndex(const int index)
    bool removeAllWallpapers()
    bool removeAllWidgets()
    bool requestProjectSettingsAtMonitorIndex(const int index)
    void setActiveWallpaperCounter(int activeWallpaperCounter)
    void setActiveWidgetsCounter(int activeWidgetsCounter)
    void setAllWallpaperValue(const QString &key, const QString &value)
    void setWallpaperValue(const QString &appID, const QString &key, const QString &value)
    void setWallpaperValueAtMonitorIndex(const int index, const QString &key, const QString &value)
    bool setAllWallpaperValue(const QString &key, const QString &value)
    bool setWallpaperValue(const QString &appID, const QString &key, const QString &value)
    bool setWallpaperValueAtMonitorIndex(const int index, const QString &key, const QString &value)

    Signals

    @@ -69,89 +62,50 @@

    Detailed Description

    -

    Creates and (indirectly) destroys Wallpaper and Widgets via opening and closing QLocalPipe connectons of the ScreenPlaySDK. Also responsible to set the current active wallpaper to the monitorListModel.

    +

    Creates and (indirectly) destroys Wallpaper and Widgets via opening and closing QLocalPipe connectons of the ScreenPlaySDK. Also responsible to set the current active wallpaper to the monitorListModel.

    Member Function Documentation

    ScreenPlayManager::ScreenPlayManager(QObject *parent = nullptr)

    -

    Constructor that checks if another ScreenPlay instance is running via a localsocket. Starts a save timer to limit the amount of times to save. This is used for limiting slider small value save spam.

    +

    Constructor that checks if another ScreenPlay instance is running via a localsocket. Starts a save timer to limit the amount of times to save. This is used for limiting slider small value save spam.

    - -

    [slot] void ScreenPlayManager::closeAllWallpapers()

    -

    Closes all wallpaper connection with the following type:

    - - - -

    [slot] void ScreenPlayManager::closeAllWidgets()

    -

    Closes all widgets connection with the following type:

    - - - -

    [slot] bool ScreenPlayManager::closeConnection(const QString &appID)

    -

    Closes a Wallpaper or Widget connection by the given appID.

    - - -

    [slot] bool ScreenPlayManager::closeConntectionByType(const QStringList &types)

    -

    Closes a connection by type. Used only by closeAllWidgets() and closeAllWallpapers()

    - - -

    [slot] void ScreenPlayManager::createWallpaper(const ScreenPlay::InstalledType::InstalledType type, const ScreenPlay::FillMode::FillMode fillMode, const QString &absoluteStoragePath, const QString &previewImage, const QString &file, const QVector<int> &monitorIndex, const float volume, const float playbackRate, const QJsonObject &properties, const bool saveToProfilesConfigFile)

    -

    Creates a wallpaper with a given monitorIndex list, a absoluteStoragePath folder, a previewImage (relative path to the absoluteStoragePath), a default volume, a fillMode, a type (htmlWallpaper, qmlWallpaper etc.), a saveToProfilesConfigFile bool only set to flase if we call the method when using via the settings on startup to skip a unnecessary save.

    - - -

    [slot] void ScreenPlayManager::createWidget(const ScreenPlay::InstalledType::InstalledType type, const QPoint &position, const QString &absoluteStoragePath, const QString &previewImage, const QJsonObject &properties, const bool saveToProfilesConfigFile)

    -

    Creates a ScreenPlayWidget object via a absoluteStoragePath and a preview image (relative path).

    -

    [slot] ScreenPlay::ScreenPlayWallpaper *ScreenPlayManager::getWallpaperByAppID(const QString &appID) const

    -

    Returns a ScreenPlayWallpaper if successful, otherwhise std::nullopt.

    +

    Returns a ScreenPlayWallpaper if successful, otherwhise std::nullopt. This function is only used in QML.

    [slot] void ScreenPlayManager::newConnection()

    Appends a new SDKConnection object shared_ptr to the m_clients list.

    -

    [slot] void ScreenPlayManager::removeAllWallpapers()

    -

    Removes all wallpaper entries in the profiles.json. This method will likely be removed when using nlohmann/json in the future.

    +

    [slot] bool ScreenPlayManager::removeAllWallpapers()

    +

    Removes all wallpaper entries in the profiles.json.

    -

    [slot] void ScreenPlayManager::removeAllWidgets()

    +

    [slot] bool ScreenPlayManager::removeAllWidgets()

    Removes all widgets and resets the activeWidgetCounter to 0.

    - -

    [slot] bool ScreenPlayManager::removeApp(const QString &appID)

    -

    Disconnects the connection, remove

    - -

    [slot] void ScreenPlayManager::requestProjectSettingsAtMonitorIndex(const int index)

    +

    [slot] bool ScreenPlayManager::requestProjectSettingsAtMonitorIndex(const int index)

    Request a spesific json profile to display in the active wallpaper popup on the right.

    -

    [slot] void ScreenPlayManager::setAllWallpaperValue(const QString &key, const QString &value)

    +

    [slot] bool ScreenPlayManager::setAllWallpaperValue(const QString &key, const QString &value)

    Convenient function to set a value at a given index and key for all wallaper. For exmaple used to mute all wallpaper.

    -

    [slot] void ScreenPlayManager::setWallpaperValue(const QString &appID, const QString &key, const QString &value)

    +

    [slot] bool ScreenPlayManager::setWallpaperValue(const QString &appID, const QString &key, const QString &value)

    Sets a given value to a given key. The appID is used to identify the receiver socket.

    -

    [slot] void ScreenPlayManager::setWallpaperValueAtMonitorIndex(const int index, const QString &key, const QString &value)

    +

    [slot] bool ScreenPlayManager::setWallpaperValueAtMonitorIndex(const int index, const QString &key, const QString &value)

    Set a wallpaper value at a given index and key.

    - -

    void ScreenPlayManager::init(const std::shared_ptr<GlobalVariables> &globalVariables, const std::shared_ptr<MonitorListModel> &mlm, const int &telemetry, const std::shared_ptr<Settings> &settings)

    -

    Inits this class instead of init in the constructor. This is because we need to check first if another ScreenPlay instance is running. If it is not the case we call this function.

    + +

    void ScreenPlayManager::init(const std::shared_ptr<GlobalVariables> &globalVariables, const std::shared_ptr<MonitorListModel> &mlm, const std::shared_ptr<Settings> &settings)

    +

    Inits this class instead of init in the constructor. This is because we need to check first if another ScreenPlay instance is running. If it is not the case we call this function.

    diff --git a/Docs/html/screenplay-screenplaywallpaper-members.html b/Docs/html/screenplay-screenplaywallpaper-members.html index 9c711975..accb5008 100644 --- a/Docs/html/screenplay-screenplaywallpaper-members.html +++ b/Docs/html/screenplay-screenplaywallpaper-members.html @@ -14,11 +14,10 @@

    This is the complete list of members for ScreenPlay::ScreenPlayWallpaper, including inherited members.

    diff --git a/Docs/html/screenplay-screenplaywallpaper.html b/Docs/html/screenplay-screenplaywallpaper.html index 51a32b60..9e6f8d55 100644 --- a/Docs/html/screenplay-screenplaywallpaper.html +++ b/Docs/html/screenplay-screenplaywallpaper.html @@ -21,7 +21,7 @@

    ScreenPlayWallpaper Class

    -class ScreenPlay::ScreenPlayWallpaper +class ScreenPlay::ScreenPlayWallpaper

    A Single Object to manage a Wallpaper. More...

    @@ -33,19 +33,18 @@

    Public Functions

    - + - + - - - + +
    ScreenPlayWallpaper(const QVector<int> &screenNumber, const std::shared_ptr<GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const QString &file, const float volume, const float playbackRate, const FillMode::FillMode fillMode, const InstalledType::InstalledType type, const QJsonObject &properties, const bool checkWallpaperVisible, QObject *parent = nullptr)
    virtual ~ScreenPlayWallpaper()
    QString absolutePath() const
    QString appID() const
    QString file() const
    FillMode::FillMode fillMode() const
    int fillMode() const
    QJsonObject getActiveSettingsJson()
    bool isLooping() const
    float playbackRate() const
    QString previewImage() const
    void replace(const QString &absolutePath, const QString &previewImage, const QString &file, const float volume, const FillMode::FillMode fillMode, const InstalledType::InstalledType type, const bool checkWallpaperVisible)
    QVector<int> screenNumber() const
    void setSDKConnection(const std::shared_ptr<SDKConnection> &connection)
    InstalledType::InstalledType type() const
    void setSDKConnection(std::unique_ptr<SDKConnection> connection)
    int type() const
    float volume() const
    @@ -56,14 +55,14 @@ void setAbsolutePath(QString absolutePath) void setAppID(QString appID) void setFile(QString file) - void setFillMode(FillMode::FillMode fillMode) + void setFillMode(int fillMode) void setIsLooping(bool isLooping) void setPlaybackRate(float playbackRate) void setPreviewImage(QString previewImage) void setScreenNumber(QVector<int> screenNumber) - void setType(InstalledType::InstalledType type) + void setType(int type) void setVolume(float volume) - void setWallpaperValue(const QString &key, const QString &value, const bool save = false) + bool setWallpaperValue(const QString &key, const QString &value, const bool save = false)

    Signals

    @@ -71,12 +70,12 @@ void absolutePathChanged(QString absolutePath) void appIDChanged(QString appID) void fileChanged(QString file) - void fillModeChanged(FillMode::FillMode fillMode) + void fillModeChanged(int fillMode) void isLoopingChanged(bool isLooping) void playbackRateChanged(float playbackRate) void previewImageChanged(QString previewImage) void screenNumberChanged(QVector<int> screenNumber) - void typeChanged(InstalledType::InstalledType type) + void typeChanged(int type) void volumeChanged(float volume) @@ -88,10 +87,6 @@

    Member Function Documentation

    - -

    ScreenPlayWallpaper::ScreenPlayWallpaper(const QVector<int> &screenNumber, const std::shared_ptr<GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const QString &file, const float volume, const float playbackRate, const FillMode::FillMode fillMode, const InstalledType::InstalledType type, const QJsonObject &properties, const bool checkWallpaperVisible, QObject *parent = nullptr)

    -

    Constructor for ScreenPlayWallpaper.

    -

    [slot] void ScreenPlayWallpaper::processError(QProcess::ProcessError error)

    Prints the exit code error.

    @@ -101,20 +96,20 @@

    Prints the exit code if != 0.

    -

    [slot] void ScreenPlayWallpaper::setWallpaperValue(const QString &key, const QString &value, const bool save = false)

    +

    [slot] bool ScreenPlayWallpaper::setWallpaperValue(const QString &key, const QString &value, const bool save = false)

    Sets a wallpaper value. We directly set the property if it is either volume, playbackRate or fillMode. Otherwise it is a simple key, value json pair.

    + +

    [virtual] ScreenPlayWallpaper::~ScreenPlayWallpaper()

    +

    Destructor for ScreenPlayWallpaper.

    +

    QJsonObject ScreenPlayWallpaper::getActiveSettingsJson()

    Loads the project.json that contains all settings to display the wallpaper.

    - -

    void ScreenPlayWallpaper::replace(const QString &absolutePath, const QString &previewImage, const QString &file, const float volume, const FillMode::FillMode fillMode, const InstalledType::InstalledType type, const bool checkWallpaperVisible)

    -

    Replaces the current wallpaper with the given one.

    - - -

    void ScreenPlayWallpaper::setSDKConnection(const std::shared_ptr<SDKConnection> &connection)

    -

    Connects to ScreenPlay. Start a alive ping check for every 16 seconds.

    + +

    void ScreenPlayWallpaper::setSDKConnection(std::unique_ptr<SDKConnection> connection)

    +

    Connects to ScreenPlay. Start a alive ping check for every GlobalVariables::contentPingAliveIntervalMS seconds.

    diff --git a/Docs/html/screenplay-screenplaywidget-members.html b/Docs/html/screenplay-screenplaywidget-members.html index 13d11896..2a845bf5 100644 --- a/Docs/html/screenplay-screenplaywidget-members.html +++ b/Docs/html/screenplay-screenplaywidget-members.html @@ -14,7 +14,6 @@

    This is the complete list of members for ScreenPlay::ScreenPlayWidget, including inherited members.

    diff --git a/Docs/html/screenplay-screenplaywidget.html b/Docs/html/screenplay-screenplaywidget.html index 0b89392a..eb85cc07 100644 --- a/Docs/html/screenplay-screenplaywidget.html +++ b/Docs/html/screenplay-screenplaywidget.html @@ -21,7 +21,7 @@

    ScreenPlayWidget Class

    -class ScreenPlay::ScreenPlayWidget +class ScreenPlay::ScreenPlayWidget

    A Single Object to manage a Widget. More...

    @@ -33,13 +33,12 @@

    Public Functions

    - - - + +
    ScreenPlayWidget(const QString &appID, const std::shared_ptr<GlobalVariables> &globalVariables, const QPoint &position, const QString &absolutePath, const QString &previewImage, const QJsonObject &properties, const InstalledType::InstalledType type)
    QString absolutePath() const
    QString appID() const
    QPoint position() const
    QString previewImage() const
    void setSDKConnection(const std::shared_ptr<SDKConnection> &connection)
    InstalledType::InstalledType type() const
    void setSDKConnection(std::unique_ptr<SDKConnection> connection)
    int type() const

    Public Slots

    @@ -49,7 +48,7 @@ void setAppID(QString appID) void setPosition(QPoint position) void setPreviewImage(QString previewImage) - void setType(InstalledType::InstalledType type) + void setType(int type)

    Signals

    @@ -58,7 +57,7 @@ void appIDChanged(QString appID) void positionChanged(QPoint position) void previewImageChanged(QString previewImage) - void typeChanged(InstalledType::InstalledType type) + void typeChanged(int type) @@ -69,17 +68,13 @@

    Member Function Documentation

    - -

    ScreenPlayWidget::ScreenPlayWidget(const QString &appID, const std::shared_ptr<GlobalVariables> &globalVariables, const QPoint &position, const QString &absolutePath, const QString &previewImage, const QJsonObject &properties, const InstalledType::InstalledType type)

    -

    Constructs a ScreenPlayWidget

    -

    [slot] QJsonObject ScreenPlayWidget::getActiveSettingsJson()

    Loads the project.json content.

    - -

    void ScreenPlayWidget::setSDKConnection(const std::shared_ptr<SDKConnection> &connection)

    -

    Connects to ScreenPlay. Start a alive ping check for every 16 seconds.

    + +

    void ScreenPlayWidget::setSDKConnection(std::unique_ptr<SDKConnection> connection)

    +

    Connects to ScreenPlay. Start a alive ping check for every GlobalVariables::contentPingAliveIntervalMS seconds.

    diff --git a/Docs/html/screenplay-sdkconnection-members.html b/Docs/html/screenplay-sdkconnection-members.html index 2135dccf..bacd1641 100644 --- a/Docs/html/screenplay-sdkconnection-members.html +++ b/Docs/html/screenplay-sdkconnection-members.html @@ -15,10 +15,10 @@