diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 73fd64b9..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,48 +0,0 @@ -# Contributing to ScreenPlay - -### Basic - -Every changes to ScreenPlay are done via Gitlab issues and merge requests (pull request for github people). These follow the normal contributing pattern: press the big blue fork button at the top of the repository, make changes, open a merge request. - -### Development - -1. Accept the Contributing Agreement: - * [For regular contributors](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/Legal/individual_contributor_license_agreement.md) - * [For members of a company](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/Legal/corporate_contributor_license_agreement.md) -2. Download and set up ScreenPlay as described in the main [Readme](https://gitlab.com/kelteseth/ScreenPlay). -2. Choose an issue to work on: - * Your own ideas or thinks you want to improve. Alternatively you can tackle existing open issues: - * You can find simple problems by [searching for problems labeled "Accepting merge requests" sorted by weight.](https://gitlab.com/kelteseth/ScreenPlay/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=0&sort=weight). Low-weight issues will be the easiest to accomplish. - * Make sure that no one else is working on the problem and make sure that we are still interested in a particular post. - * You can also make comments and ask for help if you are new or stuck. We will be happy to help you! -3. Add the feature or fix the bug you’ve chosen to work on. -4. Open a merge request to merge your code and its documentation (preferably via [draw.io]( http://draw.io/) embedded graphs). The sooner you open a merge request, the sooner you can get feedback. You can mark it as Work in Progress to indicate that you are not finished. -6. Make sure the CI builds are passing. -7. Make sure to update the translations if you've added any text via the qsTr("text) macro. It is ok to not translate your text for all the supported languages. You can always ask other contributors from other countries to verify your translations. -7. Wait for a reviewer. You’ll likely need to change some things once the reviewer has completed a code review for your merge request. You may also need multiple reviews depending on the size of the change. -8. Get your changes merged! - - -### Programming rules - -1. Use the Qt naming conventions for [C++](https://wiki.qt.io/Coding_Conventions) and [QML](https://doc.qt.io/qt-5/qml-codingconventions.html) -2. Use all the available Qt container and classes for things like (Q)Strings and (Q)Vector. -3. Use the c++17 std smart pointer. -4. Use the webkit formatting style. You can automatically format your code via the Beautifier QtCreator plugin: - * To activate this plugin you have to navigate inside your QtCreator: Help -> About Plugins -> Beautifier. - * [Download and install LLVM](http://releases.llvm.org/download.html) to format the code - * In QtCreator navigate to: Tools -> Options -> Beautifier -> Clang format -> Options -> Use predefined style: Webkit - * Add a formatting shortcut via: Tools -> Options -> Environment -> Keyboard -> Search for "format" and add your shortcut to ClangFormat, FormatFile -3. Use this [git commit message style](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) - -### Documentation - -To contribute to the [documentation](https://kelteseth.gitlab.io/ScreenPlayDocs/) you only have to press the pen icon on the top right of every page. We mostly use [draw.io]( http://draw.io/) for every diagram because it is free and you can embed the code inside a png when exporting the document. - -### Translation - -We use the [Qt Linguist] for translating ScreenPlay. This tool lets you open the ScreenPlay_.ts files and edit these easily. If is included in the open source Qt SDK and normally inside your Qt bin folder: "C:\Qt\5.XX.0\msvc2017_64\bin\linguist.exe" - -### Design - -To design ScreenPlay we use [Affinity Designer](https://affinity.serif.com/en-gb/designer/) as superior alternative to Photoshop. But you can use any tool you like. If you have any ideas on how to improve any design aspect of ScreenPlay just open a issue with the "Design" tag and paste you mockups into the description (preferably as png or/and the source *.afdesign file) \ No newline at end of file diff --git a/Docs/configWindows.qdocconf b/Docs/configWindows.qdocconf index c3b19f6f..363c6033 100644 --- a/Docs/configWindows.qdocconf +++ b/Docs/configWindows.qdocconf @@ -1,11 +1,11 @@ # Run: -# C:\Qt\5.14.0\msvc2017_64\bin\qdoc.exe config.qdocconf +# C:\Qt\5.15.0\msvc2017_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\5.14.0\msvc2017_64\doc\global/qt-cpp-defines.qdocconf) -include(C:\Qt\5.14.0\msvc2017_64\doc\global/compat.qdocconf) -include(C:\Qt\5.14.0\msvc2017_64\doc\global/fileextensions.qdocconf) +include(C:\Qt\5.15.0\msvc2017_64\doc\global\qt-cpp-defines.qdocconf) +include(C:\Qt\5.15.0\msvc2017_64\doc\global\compat.qdocconf) +include(C:\Qt\5.15.0\msvc2017_64\doc\global\fileextensions.qdocconf) descripton = ScreenPlay is an open source cross plattform app for displaying Wallpaper, Widgets and AppDrawer. language = Cpp diff --git a/Docs/html/qml-closeicon-members.html b/Docs/html/qml-closeicon-members.html index 67f15227..892e2f12 100644 --- a/Docs/html/qml-closeicon-members.html +++ b/Docs/html/qml-closeicon-members.html @@ -1,8 +1,7 @@ - - + List of All Members for CloseIcon | ScreenPlay diff --git a/Docs/html/qml-closeicon.html b/Docs/html/qml-closeicon.html index 9639b138..c42adffe 100644 --- a/Docs/html/qml-closeicon.html +++ b/Docs/html/qml-closeicon.html @@ -1,8 +1,7 @@ - - + CloseIcon QML Type | ScreenPlay @@ -41,21 +40,21 @@
- + -

color : color

-

Color if the icon.

+
+

Color if the icon.


- + -

icon : string

-

Icon image if the icon.

+
+

Icon image if the icon.


diff --git a/Docs/html/qml-imageselector-members.html b/Docs/html/qml-imageselector-members.html index 478f4a76..21e3d927 100644 --- a/Docs/html/qml-imageselector-members.html +++ b/Docs/html/qml-imageselector-members.html @@ -1,8 +1,7 @@ - - + List of All Members for ImageSelector | ScreenPlay diff --git a/Docs/html/qml-imageselector.html b/Docs/html/qml-imageselector.html index da25ce06..915af3eb 100644 --- a/Docs/html/qml-imageselector.html +++ b/Docs/html/qml-imageselector.html @@ -1,8 +1,7 @@ - - + ImageSelector QML Type | ScreenPlay diff --git a/Docs/html/screenplay-app-members.html b/Docs/html/screenplay-app-members.html index c2bae249..c36911cc 100644 --- a/Docs/html/screenplay-app-members.html +++ b/Docs/html/screenplay-app-members.html @@ -1,8 +1,7 @@ - - + List of All Members for App | ScreenPlay @@ -16,6 +15,7 @@
+ @@ -66,9 +66,9 @@

Member Function Documentation

- -

ScreenPlayManager::ScreenPlayManager(const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const shared_ptr<ScreenPlay::MonitorListModel> &mlm, const shared_ptr<ScreenPlay::SDKConnector> &sdkc, const int &telemetry, QObject *parent = nullptr)

-

Constructor

+ +

ScreenPlayManager::ScreenPlayManager(const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const shared_ptr<ScreenPlay::MonitorListModel> &mlm, const shared_ptr<ScreenPlay::SDKConnector> &sdkc, const int &telemetry, const shared_ptr<ScreenPlay::Settings> &settings, QObject *parent = nullptr)

+

Constructor-.

[slot] void ScreenPlayManager::createWallpaper(QVector<int> monitorIndex, const QString &absoluteStoragePath, const QString &previewImage, const float volume, const QString &fillMode, const QString &type, const bool saveToProfilesConfigFile = true)

@@ -86,6 +86,10 @@

[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] void ScreenPlayManager::removeAllWidgets()

+

Removes all widgets and resets the activeWidgetCounter to 0.

+

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

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

diff --git a/Docs/html/screenplay-screenplaywallpaper-members.html b/Docs/html/screenplay-screenplaywallpaper-members.html index 7798443b..f2b4a570 100644 --- a/Docs/html/screenplay-screenplaywallpaper-members.html +++ b/Docs/html/screenplay-screenplaywallpaper-members.html @@ -1,8 +1,7 @@ - - + List of All Members for ScreenPlayWallpaper | ScreenPlay @@ -15,13 +14,14 @@

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

  • createChanged(ScreenPlay::Create *)
    • +
  • exit()
  • globalVariablesChanged(ScreenPlay::GlobalVariables *)
  • installedListFilterChanged(ScreenPlay::InstalledListFilter *)
  • installedListModelChanged(ScreenPlay::InstalledListModel *)
    • @@ -40,6 +40,7 @@
  • utilChanged(ScreenPlay::Util *)
  • create() const : ScreenPlay::Create *
  • globalVariables() const : ScreenPlay::GlobalVariables *
    • +
  • init()
  • installedListFilter() const : ScreenPlay::InstalledListFilter *
  • installedListModel() const : ScreenPlay::InstalledListModel *
  • mainWindowEngine() const : QQmlApplicationEngine *
    • diff --git a/Docs/html/screenplay-app.html b/Docs/html/screenplay-app.html index c00ccdfa..452720c9 100644 --- a/Docs/html/screenplay-app.html +++ b/Docs/html/screenplay-app.html @@ -1,8 +1,7 @@ - - + App Class | ScreenPlay @@ -22,7 +21,7 @@

    App Class

    -(ScreenPlay::App)
     +class ScreenPlay::App

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

    @@ -36,6 +35,7 @@
    + @@ -49,6 +49,7 @@

    Public Slots

    ScreenPlay::Create *create() const
    ScreenPlay::GlobalVariables *globalVariables() const
    void init()
    ScreenPlay::InstalledListFilter *installedListFilter() const
    ScreenPlay::InstalledListModel *installedListModel() const
    QQmlApplicationEngine *mainWindowEngine() const
    + @@ -105,5 +106,16 @@ +
    +

    Member Function Documentation

    + +

    [slot] void App::exit()

    +

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

    + + +

    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.

    + +
    diff --git a/Docs/html/screenplay-create-members.html b/Docs/html/screenplay-create-members.html index 770e9fc3..a90e4e1a 100644 --- a/Docs/html/screenplay-create-members.html +++ b/Docs/html/screenplay-create-members.html @@ -1,8 +1,7 @@ - - + List of All Members for Create | ScreenPlay @@ -13,14 +12,19 @@

    List of All Members for Create

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

    -
      +
    void exit()
    void setCreate(ScreenPlay::Create *create)
    void setGlobalVariables(ScreenPlay::GlobalVariables *globalVariables)
    void setInstalledListFilter(ScreenPlay::InstalledListFilter *installedListFilter)
    + +
    +
    diff --git a/Docs/html/screenplay-create.html b/Docs/html/screenplay-create.html index 1df6100a..41999bdc 100644 --- a/Docs/html/screenplay-create.html +++ b/Docs/html/screenplay-create.html @@ -1,8 +1,7 @@ - - + Create Class | ScreenPlay @@ -22,7 +21,7 @@

    Create Class

    -(ScreenPlay::Create)
     +class ScreenPlay::Create

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

    @@ -43,9 +42,12 @@

    Public Slots

    + - - + + + +
    void abortAndCleanup()
    void appendFfmpegOutput(QString ffmpegOutput)
    void createWallpaperStart(QString videoPath)
    void saveWallpaper(QString title, QString description, QString filePath, QString previewImagePath, QString youtube, QVector<QString> tags)
    void createHTMLWallpaper(const QString &localStoragePath, const QString &title, const QString &previewThumbnail, const QString &license, const QVector<QString> &tags)
    void createWallpaperStart(QString videoPath, Create::VideoCodec codec)
    void createWidget(const QString &localStoragePath, const QString &title, const QString &previewThumbnail, const QString &createdBy, const QString &license, const QString &type, const QVector<QString> &tags)
    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)
    @@ -73,12 +75,24 @@

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

    Constructor.

    - -

    [slot] void Create::createWallpaperStart(QString videoPath)

    + +

    [slot] void Create::abortAndCleanup()

    +

    .

    + + +

    [slot] void Create::createHTMLWallpaper(const QString &localStoragePath, const QString &title, const QString &previewThumbnail, const QString &license, const QVector<QString> &tags)

    +

    Creates a HTML wallpaper.

    + + +

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

    Starts the process.

    - -

    [slot] void Create::saveWallpaper(QString title, QString description, QString filePath, QString previewImagePath, QString youtube, QVector<QString> tags)

    + +

    [slot] void Create::createWidget(const QString &localStoragePath, const QString &title, const QString &previewThumbnail, const QString &createdBy, const QString &license, const QString &type, const QVector<QString> &tags)

    +

    Creates a new widget.

    + + +

    [slot] void Create::saveWallpaper(QString title, QString description, QString filePath, QString previewImagePath, QString youtube, ScreenPlay::Create::VideoCodec codec, QVector<QString> tags)

    When converting of the wallpaper steps where successful.

    diff --git a/Docs/html/screenplay-createimportvideo-members.html b/Docs/html/screenplay-createimportvideo-members.html index 8535db0a..bece196b 100644 --- a/Docs/html/screenplay-createimportvideo-members.html +++ b/Docs/html/screenplay-createimportvideo-members.html @@ -1,8 +1,7 @@ - - + List of All Members for CreateImportVideo | ScreenPlay @@ -14,12 +13,13 @@

    List of All Members for CreateImportVideo

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

      -
    • CreateImportVideo(const QString &, const QString &, QObject *)
      • +
    • CreateImportVideo(const QString &, const QString &, const QStringList &, QObject *)
    • CreateImportVideo(QObject *)
    • createWallpaperGifPreview() : bool
      • +
    • createWallpaperImagePreview() : bool
    • createWallpaperImageThumbnailPreview() : bool
    • createWallpaperInfo() : bool
      • -
    • createWallpaperVideo() : bool
      • +
    • createWallpaperVideo(const QString &) : bool
    • createWallpaperVideoPreview() : bool
    • extractWallpaperAudio() : bool
    • process()
      • diff --git a/Docs/html/screenplay-createimportvideo.html b/Docs/html/screenplay-createimportvideo.html index e1a8ed5c..e05732a4 100644 --- a/Docs/html/screenplay-createimportvideo.html +++ b/Docs/html/screenplay-createimportvideo.html @@ -1,8 +1,7 @@ - - + CreateImportVideo Class | ScreenPlay @@ -22,7 +21,7 @@

      CreateImportVideo Class

      -(ScreenPlay::CreateImportVideo)
       +class ScreenPlay::CreateImportVideo

      This class imports (copies) and creates wallaper previews. More...

      @@ -34,7 +33,7 @@

      Public Functions

      - +
      CreateImportVideo(const QString &videoPath, const QString &exportPath, QObject *parent = nullptr)
      CreateImportVideo(const QString &videoPath, const QString &exportPath, const QStringList &codecs, QObject *parent = nullptr)
      CreateImportVideo(QObject *parent = nullptr)
      float progress() const
      @@ -42,9 +41,10 @@

      Public Slots

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

      Member Function Documentation

      - -

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

      + +

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

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

      @@ -86,6 +86,10 @@ args.append(m_exportPath +<
    • Generally broken.
      • + +

      [slot] bool CreateImportVideo::createWallpaperImagePreview()

      +

      .

      +

      [slot] bool CreateImportVideo::createWallpaperImageThumbnailPreview()

      Starts ffmpeg and tries to covert the given video to a image preview. Returns false if :

      @@ -104,8 +108,8 @@ args.append(m_exportPath +<
    • Is a wrong file format or generally broken.
      • - -

      [slot] bool CreateImportVideo::createWallpaperVideo()

      + +

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

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

      //[...]
 args.append("-c:v");
@@ -159,7 +163,7 @@ args.append(m_exportPath +<
 
      [slot] void CreateImportVideo::process()
      
 
      Processes the multiple steps of creating a wallpaper.
      
 
      1. createWallpaperInfo()
        2. 
-
      2. createWallpaperImagePreview()
        3. 
+
      3. createWallpaperImagePreview()
        4. 
 
      4. createWallpaperVideoPreview()
        5. 
 
      5. createWallpaperGifPreview()
        6. 
 
      6. createWallpaperVideo() - skiped if already a webm
        7. 
diff --git a/Docs/html/screenplay-installedlistfilter-members.html b/Docs/html/screenplay-installedlistfilter-members.html
index d8ad7ac6..bcf24c84 100644
--- a/Docs/html/screenplay-installedlistfilter-members.html
+++ b/Docs/html/screenplay-installedlistfilter-members.html
@@ -1,8 +1,7 @@
-
 
 
 
-  
+  
 
   List of All Members for InstalledListFilter | ScreenPlay
  
diff --git a/Docs/html/screenplay-installedlistfilter.html b/Docs/html/screenplay-installedlistfilter.html
index 30a6ee12..fcb6f49d 100644
--- a/Docs/html/screenplay-installedlistfilter.html
+++ b/Docs/html/screenplay-installedlistfilter.html
@@ -1,8 +1,7 @@
-
 
 
 
-  
+  
 
   InstalledListFilter Class | ScreenPlay
  
@@ -21,7 +20,7 @@

      InstalledListFilter Class

      -(ScreenPlay::InstalledListFilter)
       +class ScreenPlay::InstalledListFilter

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

      @@ -65,7 +64,7 @@

      [slot] void InstalledListFilter::sortByRoleType(QString type)

      -

      Set the filter proxy to sort by the given type. This can be

      +

      Set the filter proxy to sort by the given type. This can be:

      • All
      • Videos
        • diff --git a/Docs/html/screenplay-installedlistmodel-members.html b/Docs/html/screenplay-installedlistmodel-members.html index 5261b089..035a164a 100644 --- a/Docs/html/screenplay-installedlistmodel-members.html +++ b/Docs/html/screenplay-installedlistmodel-members.html @@ -1,8 +1,7 @@ - - + List of All Members for InstalledListModel | ScreenPlay diff --git a/Docs/html/screenplay-installedlistmodel.html b/Docs/html/screenplay-installedlistmodel.html index 6278b9e3..65f49f75 100644 --- a/Docs/html/screenplay-installedlistmodel.html +++ b/Docs/html/screenplay-installedlistmodel.html @@ -1,8 +1,7 @@ - - + InstalledListModel Class | ScreenPlay @@ -23,7 +22,7 @@

        InstalledListModel Class

        -(ScreenPlay::InstalledListModel)
         +class ScreenPlay::InstalledListModel

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

        @@ -69,25 +68,29 @@

        Member Function Documentation

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

        -

        Constructor

        +

        Constructor.

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

        [slot] void InstalledListModel::init()

        +

        Init function that needs to be called after the constructor because we need the GlobalVariables to finish loading.

        [slot] void InstalledListModel::loadInstalledContent()

        [override virtual] QVariant InstalledListModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

        +

        Retruns the data member of the ProjectFile.

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

        +

        Returns the variable names for QML.

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

        +

        Returns the length of the installed items.

        diff --git a/Docs/html/screenplay-monitorlistmodel-members.html b/Docs/html/screenplay-monitorlistmodel-members.html index 4459f208..3beabddc 100644 --- a/Docs/html/screenplay-monitorlistmodel-members.html +++ b/Docs/html/screenplay-monitorlistmodel-members.html @@ -1,8 +1,7 @@ - - + List of All Members for MonitorListModel | ScreenPlay @@ -15,6 +14,14 @@

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

        diff --git a/Docs/html/screenplay-monitorlistmodel.html b/Docs/html/screenplay-monitorlistmodel.html index 12398d9d..4b0728a9 100644 --- a/Docs/html/screenplay-monitorlistmodel.html +++ b/Docs/html/screenplay-monitorlistmodel.html @@ -1,8 +1,7 @@ - - + MonitorListModel Class | ScreenPlay @@ -15,12 +14,14 @@

        Contents

        MonitorListModel Class

        -(ScreenPlay::MonitorListModel)
         +class ScreenPlay::MonitorListModel

        MonitorListModel. More...

        @@ -33,6 +34,22 @@

        Public Functions

      bool createWallpaperGifPreview()
      bool createWallpaperImagePreview()
      bool createWallpaperImageThumbnailPreview()
      bool createWallpaperInfo()
      bool createWallpaperVideo()
      bool createWallpaperVideo(const QString &codec)
      bool createWallpaperVideoPreview()
      bool extractWallpaperAudio()
      void process()
      + + +
      MonitorListModel(QObject *parent = nullptr)
      int getAppIDByMonitorIndex(const int) const
      void setWallpaperActiveMonitor(const std::shared_ptr<ScreenPlayWallpaper> &wallpaper, const QVector<int> monitors)
      + +

      Reimplemented Public Functions

      +
      + + + +
      virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override
      virtual QHash<int, QByteArray> roleNames() const override
      virtual int rowCount(const QModelIndex &parent = QModelIndex()) const override
      + +

      Public Slots

      +
      + + +
      void clearActiveWallpaper()
      void closeWallpaper(const QString &appID)
      void reset()
      @@ -51,8 +68,40 @@

      Member Function Documentation

      MonitorListModel::MonitorListModel(QObject *parent = nullptr)

      -

      Constructor

      +

      Constructor.

      + +

      [slot] void MonitorListModel::clearActiveWallpaper()

      +

      Clears the listmodel.

      + + +

      [slot] void MonitorListModel::closeWallpaper(const QString &appID)

      +

      Removes the preview image and appID inside an monitor item.

      + + +

      [slot] void MonitorListModel::reset()

      +

      Removes all items and loads them vida loadMonitors() again.

      + + +

      [override virtual] QVariant MonitorListModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

      +

      Retruns the data member of the Monitor.

      + + +

      int MonitorListModel::getAppIDByMonitorIndex(const int) const

      +

      If successful this function returns an AppID. Otherwhise std::nullopt.

      + + +

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

      +

      Returns the variable names for QML.

      + + +

      [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.

      + diff --git a/Docs/html/screenplay-profilelistmodel-members.html b/Docs/html/screenplay-profilelistmodel-members.html index 38784eb8..d75f9d55 100644 --- a/Docs/html/screenplay-profilelistmodel-members.html +++ b/Docs/html/screenplay-profilelistmodel-members.html @@ -1,8 +1,7 @@ - - + List of All Members for ProfileListModel | ScreenPlay diff --git a/Docs/html/screenplay-profilelistmodel.html b/Docs/html/screenplay-profilelistmodel.html index 3d2e076f..8043b1db 100644 --- a/Docs/html/screenplay-profilelistmodel.html +++ b/Docs/html/screenplay-profilelistmodel.html @@ -1,8 +1,7 @@ - - + ProfileListModel Class | ScreenPlay @@ -20,7 +19,7 @@

      ProfileListModel 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 949728a6..8f13d2f1 100644 --- a/Docs/html/screenplay-projectsettingslistmodel-members.html +++ b/Docs/html/screenplay-projectsettingslistmodel-members.html @@ -1,8 +1,7 @@ - - + List of All Members for ProjectSettingsListModel | ScreenPlay diff --git a/Docs/html/screenplay-projectsettingslistmodel.html b/Docs/html/screenplay-projectsettingslistmodel.html index ae9d610d..65ac3f66 100644 --- a/Docs/html/screenplay-projectsettingslistmodel.html +++ b/Docs/html/screenplay-projectsettingslistmodel.html @@ -1,8 +1,7 @@ - - + ProjectSettingsListModel Class | ScreenPlay @@ -20,7 +19,7 @@

      ProjectSettingsListModel Class

      -(ScreenPlay::ProjectSettingsListModel)
       +class ScreenPlay::ProjectSettingsListModel

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

      diff --git a/Docs/html/screenplay-screenplaymanager-members.html b/Docs/html/screenplay-screenplaymanager-members.html index 4f7ad4ae..72b6f99b 100644 --- a/Docs/html/screenplay-screenplaymanager-members.html +++ b/Docs/html/screenplay-screenplaymanager-members.html @@ -1,8 +1,7 @@ - - + List of All Members for ScreenPlayManager | ScreenPlay @@ -14,13 +13,14 @@

      List of All Members for ScreenPlayManager

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

void createWidget(const QUrl &absoluteStoragePath, const QString &previewImage, const QString &type)
int getWallpaperByAppID(const QString &)
void removeAllWallpapers()
void removeAllWidgets()
void requestProjectSettingsListModelAt(const int index)
void setActiveWallpaperCounter(int activeWallpaperCounter)
void setActiveWidgetsCounter(int activeWidgetsCounter)
    -
  • ScreenPlayWallpaper(const QVector<int> &, const shared_ptr<ScreenPlay::GlobalVariables> &, const QString &, const QString &, const QString &, const QString &, const QJsonObject &, QObject *)
    • -
  • ScreenPlayWallpaper(const QVector<int> &, const shared_ptr<ScreenPlay::GlobalVariables> &, const QString &, const QString &, const QString &, const float , const QString &, const QString &, QObject *)
    • +
  • ScreenPlayWallpaper(const QVector<int> &, const shared_ptr<ScreenPlay::GlobalVariables> &, const QString &, const QString &, const QString &, const float , const QString &, const QString &, const bool , QObject *)
  • absolutePathChanged(QString )
  • appIDChanged(QString )
  • fileChanged(QString )
  • fillModeChanged(QString )
  • previewImageChanged(QString )
    • +
  • processError(QProcess::ProcessError )
    • +
  • processExit(int , QProcess::ExitStatus )
  • profileJsonObjectChanged(QJsonObject )
  • screenNumberChanged(QVector<int> )
  • setAbsolutePath(QString )
    • diff --git a/Docs/html/screenplay-screenplaywallpaper.html b/Docs/html/screenplay-screenplaywallpaper.html index fb0c96bf..d3de9d8c 100644 --- a/Docs/html/screenplay-screenplaywallpaper.html +++ b/Docs/html/screenplay-screenplaywallpaper.html @@ -1,8 +1,7 @@ - - + ScreenPlayWallpaper Class | ScreenPlay @@ -22,7 +21,7 @@

    ScreenPlayWallpaper Class

    -(ScreenPlay::ScreenPlayWallpaper)
     +class ScreenPlay::ScreenPlayWallpaper

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

    @@ -34,8 +33,7 @@

    Public Functions

    - - + @@ -48,6 +46,8 @@

    Public Slots

    ScreenPlayWallpaper(const QVector<int> &screenNumber, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const QString &type, const QJsonObject &profileJsonObject, QObject *parent = nullptr)
    ScreenPlayWallpaper(const QVector<int> &screenNumber, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const float volume, const QString &fillMode, const QString &type, QObject *parent = nullptr)
    ScreenPlayWallpaper(const QVector<int> &screenNumber, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const float volume, const QString &fillMode, const QString &type, const bool checkWallpaperVisible, QObject *parent = nullptr)
    QString absolutePath() const
    QString appID() const
    QString file() const
    + + @@ -78,14 +78,18 @@

    Member Function Documentation

    - -

    ScreenPlayWallpaper::ScreenPlayWallpaper(const QVector<int> &screenNumber, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const QString &type, const QJsonObject &profileJsonObject, QObject *parent = nullptr)

    -

    Constructor for scene Wallpaper with multile json settings.

    - - -

    ScreenPlayWallpaper::ScreenPlayWallpaper(const QVector<int> &screenNumber, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const float volume, const QString &fillMode, const QString &type, QObject *parent = nullptr)

    + +

    ScreenPlayWallpaper::ScreenPlayWallpaper(const QVector<int> &screenNumber, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &appID, const QString &absolutePath, const QString &previewImage, const float volume, const QString &fillMode, const QString &type, const bool checkWallpaperVisible, QObject *parent = nullptr)

    Constructor for video Wallpaper.

    + +

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

    +

    Prints the exit code error.

    + + +

    [slot] void ScreenPlayWallpaper::processExit(int exitCode, QProcess::ExitStatus exitStatus)

    +

    Prints the exit code if != 0.

    +
    diff --git a/Docs/html/screenplay-screenplaywidget-members.html b/Docs/html/screenplay-screenplaywidget-members.html index d773ce95..ffe975df 100644 --- a/Docs/html/screenplay-screenplaywidget-members.html +++ b/Docs/html/screenplay-screenplaywidget-members.html @@ -1,8 +1,7 @@ - - + List of All Members for ScreenPlayWidget | ScreenPlay diff --git a/Docs/html/screenplay-screenplaywidget.html b/Docs/html/screenplay-screenplaywidget.html index 58e87c41..2c8bb136 100644 --- a/Docs/html/screenplay-screenplaywidget.html +++ b/Docs/html/screenplay-screenplaywidget.html @@ -1,8 +1,7 @@ - - + ScreenPlayWidget Class | ScreenPlay @@ -22,7 +21,7 @@

    ScreenPlayWidget Class

    -(ScreenPlay::ScreenPlayWidget)
     +class ScreenPlay::ScreenPlayWidget

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

    @@ -70,7 +69,7 @@

    Member Function Documentation

    ScreenPlayWidget::ScreenPlayWidget(const QString &appID, const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, const QString &projectPath, const QString &previewImage, const QString &fullPath, const QString &type)

    -

    Constructor

    +

    Constructor.

    diff --git a/Docs/html/screenplay-sdkconnector-members.html b/Docs/html/screenplay-sdkconnector-members.html index f3c20b65..d461b763 100644 --- a/Docs/html/screenplay-sdkconnector-members.html +++ b/Docs/html/screenplay-sdkconnector-members.html @@ -1,8 +1,7 @@ - - + List of All Members for SDKConnector | ScreenPlay @@ -17,10 +16,11 @@
  • SDKConnector(QObject *)
  • closeAllConnections()
  • closeAllWallpapers()
    • +
  • closeAllWidgets()
    • +
  • closeConntectionByType(const QStringList &)
  • closeWallpaper(const QString &)
  • closeWallpapersAt(int )
  • newConnection()
    • -
  • setSceneValue(QString , QString , QString )
  • setWallpaperValue(QString , QString , QString )
    • diff --git a/Docs/html/screenplay-sdkconnector.html b/Docs/html/screenplay-sdkconnector.html index 8a7f0678..9672b596 100644 --- a/Docs/html/screenplay-sdkconnector.html +++ b/Docs/html/screenplay-sdkconnector.html @@ -1,8 +1,7 @@ - - + SDKConnector Class | ScreenPlay @@ -21,7 +20,7 @@

    SDKConnector Class

    -(ScreenPlay::SDKConnector)
     +class ScreenPlay::SDKConnector

    SDKConnector is used for the QLocalSocket connection between ScreenPlay and the standalone ScreenPlayWallpaper and ScreenPlayWidget executables. More...

    @@ -40,10 +39,11 @@
    void processError(QProcess::ProcessError error)
    void processExit(int exitCode, QProcess::ExitStatus exitStatus)
    void setAbsolutePath(QString absolutePath)
    void setAppID(QString appID)
    void setFile(QString file)
    + + -
    void closeAllConnections()
    void closeAllWallpapers()
    void closeAllWidgets()
    void closeConntectionByType(const QStringList &list)
    void closeWallpaper(const QString &appID)
    void closeWallpapersAt(int at)
    void newConnection()
    void setSceneValue(QString appID, QString key, QString value)
    void setWallpaperValue(QString appID, QString key, QString value)
    @@ -73,6 +73,19 @@
  • godotWallpaper
+ +

[slot] void SDKConnector::closeAllWidgets()

+

Closes all widgets connection with the following type:

+
    +
  • qmlWidget
    • +
  • htmlWidget
    • +
  • standaloneWidget
    • +
+ + +

[slot] void SDKConnector::closeConntectionByType(const QStringList &list)

+

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

+

[slot] void SDKConnector::closeWallpaper(const QString &appID)

Closes a wallpaper by the given appID.

@@ -85,10 +98,6 @@

[slot] void SDKConnector::newConnection()

Appends a new SDKConnection object shared_ptr to the m_clients list.

- -

[slot] void SDKConnector::setSceneValue(QString appID, QString key, QString value)

-

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

-

[slot] void SDKConnector::setWallpaperValue(QString appID, QString key, QString value)

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

diff --git a/Docs/html/screenplay-settings-members.html b/Docs/html/screenplay-settings-members.html index 58e11569..f7bb25ca 100644 --- a/Docs/html/screenplay-settings-members.html +++ b/Docs/html/screenplay-settings-members.html @@ -1,8 +1,7 @@ - - + List of All Members for Settings | ScreenPlay @@ -18,36 +17,42 @@
  • Settings(const shared_ptr<ScreenPlay::GlobalVariables> &, QObject *)
  • anonymousTelemetryChanged(bool )
  • autostartChanged(bool )
    • +
  • checkWallpaperVisibleChanged(bool )
  • decoderChanged(QString )
    • +
  • fontChanged(QString )
  • gitBuildHashChanged(QString )
  • highPriorityStartChanged(bool )
    • -
  • languageChanged(QString )
    • +
  • languageChanged(ScreenPlay::Settings::Language )
  • offlineModeChanged(bool )
    • -
  • pauseWallpaperWhenIngameChanged(bool )
    • +
  • retranslateUI() : bool
  • setAnonymousTelemetry(bool )
  • setAutostart(bool )
    • +
  • setCheckWallpaperVisible(bool )
  • setDecoder(QString )
    • +
  • setFont(QString )
  • setGitBuildHash(QString )
  • setHighPriorityStart(bool )
    • -
  • setLanguage(QString )
    • -
  • setOfflineMode(bool )
    • +
  • setLanguage(ScreenPlay::Settings::Language )
    		•
    diff --git a/Docs/html/screenplay-settings.html b/Docs/html/screenplay-settings.html index fe4055df..0bccb4df 100644 --- a/Docs/html/screenplay-settings.html +++ b/Docs/html/screenplay-settings.html @@ -1,8 +1,7 @@ - - + Settings Class | ScreenPlay @@ -22,7 +21,7 @@

    Settings Class

    -(ScreenPlay::Settings)
     +class ScreenPlay::Settings

    Global settings class for reading and writing settings. More...

    @@ -37,43 +36,49 @@ Settings(const shared_ptr<ScreenPlay::GlobalVariables> &globalVariables, QObject *parent = nullptr) bool anonymousTelemetry() const bool autostart() const + bool checkWallpaperVisible() const QString decoder() const + QString font() const QString gitBuildHash() const bool highPriorityStart() const - QString language() const + ScreenPlay::Settings::Language language() const bool offlineMode() const - bool pauseWallpaperWhenIngame() const + void setupLanguage() bool silentStart() const - QVersionNumber version() const + ScreenPlay::Settings::FillMode videoFillMode() const

    Public Slots

    + + + - + - + -
    bool retranslateUI()
    void setAnonymousTelemetry(bool anonymousTelemetry)
    void setAutostart(bool autostart)
    void setCheckWallpaperVisible(bool checkWallpaperVisible)
    void setDecoder(QString decoder)
    void setFont(QString font)
    void setGitBuildHash(QString gitBuildHash)
    void setHighPriorityStart(bool highPriorityStart)
    void setLanguage(QString language)
    void setLanguage(ScreenPlay::Settings::Language language)
    void setOfflineMode(bool offlineMode)
    void setPauseWallpaperWhenIngame(bool pauseWallpaperWhenIngame)
    void setSilentStart(bool silentStart)
    void setVideoFillMode(ScreenPlay::Settings::FillMode videoFillMode)
    void setupWidgetAndWindowPaths()
    void writeJsonFileFromResource(const QString &filename)
    bool writeSingleSettingConfig(QString name, QVariant value)

    Signals

    + + - + - +
    void anonymousTelemetryChanged(bool anonymousTelemetry)
    void autostartChanged(bool autostart)
    void checkWallpaperVisibleChanged(bool checkWallpaperVisible)
    void decoderChanged(QString decoder)
    void fontChanged(QString font)
    void gitBuildHashChanged(QString gitBuildHash)
    void highPriorityStartChanged(bool highPriorityStart)
    void languageChanged(QString language)
    void languageChanged(ScreenPlay::Settings::Language language)
    void offlineModeChanged(bool offlineMode)
    void pauseWallpaperWhenIngameChanged(bool pauseWallpaperWhenIngame)
    void silentStartChanged(bool silentStart)
    void videoFillModeChanged(ScreenPlay::Settings::FillMode videoFillMode)
    @@ -81,9 +86,8 @@

    Detailed Description

    Used for: