From fda9bfbe03a2dd529c8afd28f13f5e732f040324 Mon Sep 17 00:00:00 2001 From: Alex Spataru Date: Fri, 8 Jul 2016 22:43:34 -0600 Subject: [PATCH] Remove doxygen sub-dirs --- doc/config/doxyfile | 2 +- .../{d1/d88 => }/_downloader_8h_source.html | 38 +-- .../d2f => }/_q_simple_updater_8h_source.html | 38 +-- doc/output/html/_updater_8h_source.html | 102 ++++++++ doc/output/html/annotated.html | 6 +- doc/output/html/class_downloader-members.html | 108 +++++++++ .../html/{de/dc0 => }/class_downloader.html | 68 +++--- .../html/{de/dc0 => }/class_downloader.png | Bin .../html/class_q_simple_updater-members.html | 125 ++++++++++ .../{d0/d80 => }/class_q_simple_updater.html | 226 +++++++++--------- .../{d0/d80 => }/class_q_simple_updater.png | Bin doc/output/html/class_updater-members.html | 127 ++++++++++ .../html/{d3/d1d => }/class_updater.html | 174 +++++++------- .../html/{d3/d1d => }/class_updater.png | Bin doc/output/html/classes.html | 2 +- .../d1d/class_q_simple_updater-members.html | 125 ---------- .../html/d4/d44/class_updater-members.html | 127 ---------- .../html/d5/d7d/class_downloader-members.html | 108 --------- .../html/dd/d30/_updater_8h_source.html | 102 -------- doc/output/html/files.html | 6 +- doc/output/html/functions.html | 88 +++---- doc/output/html/functions_func.html | 88 +++---- doc/output/html/hierarchy.html | 6 +- doc/output/html/index.html | 18 +- doc/output/html/search/all_0.js | 4 +- doc/output/html/search/all_1.js | 6 +- doc/output/html/search/all_2.js | 22 +- doc/output/html/search/all_4.js | 2 +- doc/output/html/search/all_5.js | 4 +- doc/output/html/search/all_6.js | 4 +- doc/output/html/search/all_7.js | 2 +- doc/output/html/search/all_8.js | 2 +- doc/output/html/search/all_9.js | 18 +- doc/output/html/search/all_a.js | 10 +- doc/output/html/search/classes_0.js | 2 +- doc/output/html/search/classes_1.js | 2 +- doc/output/html/search/classes_2.js | 2 +- doc/output/html/search/functions_0.js | 4 +- doc/output/html/search/functions_1.js | 4 +- doc/output/html/search/functions_2.js | 22 +- doc/output/html/search/functions_3.js | 2 +- doc/output/html/search/functions_4.js | 4 +- doc/output/html/search/functions_5.js | 4 +- doc/output/html/search/functions_6.js | 2 +- doc/output/html/search/functions_7.js | 18 +- doc/output/html/search/functions_8.js | 8 +- 46 files changed, 916 insertions(+), 916 deletions(-) rename doc/output/html/{d1/d88 => }/_downloader_8h_source.html (51%) rename doc/output/html/{d0/d2f => }/_q_simple_updater_8h_source.html (50%) create mode 100644 doc/output/html/_updater_8h_source.html create mode 100644 doc/output/html/class_downloader-members.html rename doc/output/html/{de/dc0 => }/class_downloader.html (66%) rename doc/output/html/{de/dc0 => }/class_downloader.png (100%) create mode 100644 doc/output/html/class_q_simple_updater-members.html rename doc/output/html/{d0/d80 => }/class_q_simple_updater.html (54%) rename doc/output/html/{d0/d80 => }/class_q_simple_updater.png (100%) create mode 100644 doc/output/html/class_updater-members.html rename doc/output/html/{d3/d1d => }/class_updater.html (59%) rename doc/output/html/{d3/d1d => }/class_updater.png (100%) delete mode 100644 doc/output/html/d4/d1d/class_q_simple_updater-members.html delete mode 100644 doc/output/html/d4/d44/class_updater-members.html delete mode 100644 doc/output/html/d5/d7d/class_downloader-members.html delete mode 100644 doc/output/html/dd/d30/_updater_8h_source.html diff --git a/doc/config/doxyfile b/doc/config/doxyfile index 7954d1f..fab6ac5 100644 --- a/doc/config/doxyfile +++ b/doc/config/doxyfile @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = ../output # performance problems for the file system. # The default value is: NO. -CREATE_SUBDIRS = YES +CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII diff --git a/doc/output/html/d1/d88/_downloader_8h_source.html b/doc/output/html/_downloader_8h_source.html similarity index 51% rename from doc/output/html/d1/d88/_downloader_8h_source.html rename to doc/output/html/_downloader_8h_source.html index 184e6b0..530b0fa 100644 --- a/doc/output/html/d1/d88/_downloader_8h_source.html +++ b/doc/output/html/_downloader_8h_source.html @@ -5,16 +5,16 @@ QSimpleUpdater: Downloader.h Source File - - - - - - + + + + + + - +
@@ -22,7 +22,7 @@ - +
QSimpleUpdater
@@ -35,17 +35,17 @@ @@ -81,7 +81,7 @@ var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
@@ -89,13 +89,13 @@ var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
Downloader.h
-
1 /*
2  * Copyright (c) 2014-2016 Alex Spataru <alex_spataru@outlook.com>
3  *
4  * This file is part of the QSimpleUpdater library, which is released under
5  * the DBAD license, you can read a copy of it below:
6  *
7  * DON'T BE A DICK PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING,
8  * DISTRIBUTION AND MODIFICATION:
9  *
10  * Do whatever you like with the original work, just don't be a dick.
11  * Being a dick includes - but is not limited to - the following instances:
12  *
13  * 1a. Outright copyright infringement - Don't just copy this and change the
14  * name.
15  * 1b. Selling the unmodified original with no work done what-so-ever, that's
16  * REALLY being a dick.
17  * 1c. Modifying the original work to contain hidden harmful content.
18  * That would make you a PROPER dick.
19  *
20  * If you become rich through modifications, related works/services, or
21  * supporting the original work, share the love.
22  * Only a dick would make loads off this work and not buy the original works
23  * creator(s) a pint.
24  *
25  * Code is provided with no warranty. Using somebody else's code and bitching
26  * when it goes wrong makes you a DONKEY dick.
27  * Fix the problem yourself. A non-dick would submit the fix back.
28  */
29 
30 #ifndef DOWNLOAD_DIALOG_H
31 #define DOWNLOAD_DIALOG_H
32 
33 #include <QDialog>
34 #include <ui_Downloader.h>
35 
36 namespace Ui {
37 class Downloader;
38 }
39 
40 class QNetworkReply;
41 class QNetworkAccessManager;
42 
46 class Downloader : public QWidget {
47  Q_OBJECT
48 
49  signals:
50  void downloadFinished (const QString& url, const QString& filepath);
51 
52  public:
53  explicit Downloader (QWidget* parent = 0);
54  ~Downloader();
55 
56  bool useCustomInstallProcedures() const;
57 
58  public slots:
59  void startDownload (const QUrl& url);
60  void setUseCustomInstallProcedures (const bool& custom);
61 
62  private slots:
63  void openDownload();
64  void installUpdate();
65  void cancelDownload();
66  void onDownloadFinished();
67  void calculateSizes (qint64 received, qint64 total);
68  void updateProgress (qint64 received, qint64 total);
69  void calculateTimeRemaining (qint64 received, qint64 total);
70 
71  private:
72  qreal round (const qreal& input);
73 
74  private:
75  uint m_startTime;
76  QString m_filePath;
77  Ui::Downloader* m_ui;
78  QNetworkReply* m_reply;
79  bool m_useCustomProcedures;
80  QNetworkAccessManager* m_manager;
81 };
82 
83 #endif
Definition: Downloader.h:36
-
Implements an integrated file downloader with a nice UI.
Definition: Downloader.h:46
+
1 /*
2  * Copyright (c) 2014-2016 Alex Spataru <alex_spataru@outlook.com>
3  *
4  * This file is part of the QSimpleUpdater library, which is released under
5  * the DBAD license, you can read a copy of it below:
6  *
7  * DON'T BE A DICK PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING,
8  * DISTRIBUTION AND MODIFICATION:
9  *
10  * Do whatever you like with the original work, just don't be a dick.
11  * Being a dick includes - but is not limited to - the following instances:
12  *
13  * 1a. Outright copyright infringement - Don't just copy this and change the
14  * name.
15  * 1b. Selling the unmodified original with no work done what-so-ever, that's
16  * REALLY being a dick.
17  * 1c. Modifying the original work to contain hidden harmful content.
18  * That would make you a PROPER dick.
19  *
20  * If you become rich through modifications, related works/services, or
21  * supporting the original work, share the love.
22  * Only a dick would make loads off this work and not buy the original works
23  * creator(s) a pint.
24  *
25  * Code is provided with no warranty. Using somebody else's code and bitching
26  * when it goes wrong makes you a DONKEY dick.
27  * Fix the problem yourself. A non-dick would submit the fix back.
28  */
29 
30 #ifndef DOWNLOAD_DIALOG_H
31 #define DOWNLOAD_DIALOG_H
32 
33 #include <QDialog>
34 #include <ui_Downloader.h>
35 
36 namespace Ui {
37 class Downloader;
38 }
39 
40 class QNetworkReply;
41 class QNetworkAccessManager;
42 
46 class Downloader : public QWidget {
47  Q_OBJECT
48 
49  signals:
50  void downloadFinished (const QString& url, const QString& filepath);
51 
52  public:
53  explicit Downloader (QWidget* parent = 0);
54  ~Downloader();
55 
56  bool useCustomInstallProcedures() const;
57 
58  public slots:
59  void startDownload (const QUrl& url);
60  void setUseCustomInstallProcedures (const bool& custom);
61 
62  private slots:
63  void openDownload();
64  void installUpdate();
65  void cancelDownload();
66  void onDownloadFinished();
67  void calculateSizes (qint64 received, qint64 total);
68  void updateProgress (qint64 received, qint64 total);
69  void calculateTimeRemaining (qint64 received, qint64 total);
70 
71  private:
72  qreal round (const qreal& input);
73 
74  private:
75  uint m_startTime;
76  QString m_filePath;
77  Ui::Downloader* m_ui;
78  QNetworkReply* m_reply;
79  bool m_useCustomProcedures;
80  QNetworkAccessManager* m_manager;
81 };
82 
83 #endif
Definition: Downloader.h:36
+
Implements an integrated file downloader with a nice UI.
Definition: Downloader.h:46
diff --git a/doc/output/html/d0/d2f/_q_simple_updater_8h_source.html b/doc/output/html/_q_simple_updater_8h_source.html similarity index 50% rename from doc/output/html/d0/d2f/_q_simple_updater_8h_source.html rename to doc/output/html/_q_simple_updater_8h_source.html index fe46abc..66cbdc7 100644 --- a/doc/output/html/d0/d2f/_q_simple_updater_8h_source.html +++ b/doc/output/html/_q_simple_updater_8h_source.html @@ -5,16 +5,16 @@ QSimpleUpdater: QSimpleUpdater.h Source File - - - - - - + + + + + + - +
@@ -22,7 +22,7 @@ - +

Begins downloading the file at the given url

-

References useCustomInstallProcedures().

+

References useCustomInstallProcedures().

-

Referenced by Updater::setUseCustomInstallProcedures().

+

Referenced by Updater::setUseCustomInstallProcedures().

@@ -200,21 +200,21 @@ Public Member Functions
QSimpleUpdater
@@ -35,17 +35,17 @@ @@ -81,7 +81,7 @@ var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
@@ -89,13 +89,13 @@ var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
QSimpleUpdater.h
-
1 /*
2  * Copyright (c) 2014-2016 Alex Spataru <alex_spataru@outlook.com>
3  *
4  * This file is part of the QSimpleUpdater library, which is released under
5  * the DBAD license, you can read a copy of it below:
6  *
7  * DON'T BE A DICK PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING,
8  * DISTRIBUTION AND MODIFICATION:
9  *
10  * Do whatever you like with the original work, just don't be a dick.
11  * Being a dick includes - but is not limited to - the following instances:
12  *
13  * 1a. Outright copyright infringement - Don't just copy this and change the
14  * name.
15  * 1b. Selling the unmodified original with no work done what-so-ever, that's
16  * REALLY being a dick.
17  * 1c. Modifying the original work to contain hidden harmful content.
18  * That would make you a PROPER dick.
19  *
20  * If you become rich through modifications, related works/services, or
21  * supporting the original work, share the love.
22  * Only a dick would make loads off this work and not buy the original works
23  * creator(s) a pint.
24  *
25  * Code is provided with no warranty. Using somebody else's code and bitching
26  * when it goes wrong makes you a DONKEY dick.
27  * Fix the problem yourself. A non-dick would submit the fix back.
28  */
29 
30 #ifndef _QSIMPLEUPDATER_MAIN_H
31 #define _QSIMPLEUPDATER_MAIN_H
32 
33 #include <QUrl>
34 #include <QList>
35 #include <QObject>
36 
37 #if defined (QSU_SHARED)
38  #define QSU_DECL Q_DECL_EXPORT
39 #elif defined (QSU_IMPORT)
40  #define QSU_DECL Q_DECL_IMPORT
41 #else
42  #define QSU_DECL
43 #endif
44 
45 class Updater;
46 
66 class QSU_DECL QSimpleUpdater : public QObject {
67  Q_OBJECT
68 
69  signals:
70  void checkingFinished (const QString& url);
71  void downloadFinished (const QString& url, const QString& filepath);
72 
73  public:
74  static QSimpleUpdater* getInstance();
75 
76  bool getNotifyOnUpdate (const QString& url) const;
77  bool getNotifyOnFinish (const QString& url) const;
78  bool getUpdateAvailable (const QString& url) const;
79  bool getDownloaderEnabled (const QString& url) const;
80  bool usesCustomInstallProcedures (const QString& url) const;
81 
82  QString getChangelog (const QString& url) const;
83  QString getModuleName (const QString& url) const;
84  QString getDownloadUrl (const QString& url) const;
85  QString getPlatformKey (const QString& url) const;
86  QString getLatestVersion (const QString& url) const;
87  QString getModuleVersion (const QString& url) const;
88 
89  public slots:
90  void checkForUpdates (const QString& url);
91  void setModuleName (const QString& url, const QString& name);
92  void setNotifyOnUpdate (const QString& url, const bool& notify);
93  void setNotifyOnFinish (const QString& url, const bool& notify);
94  void setPlatformKey (const QString& url, const QString& platform);
95  void setModuleVersion (const QString& url, const QString& version);
96  void setDownloaderEnabled (const QString& url, const bool& enabled);
97  void setUseCustomInstallProcedures (const QString& url, const bool& custom);
98 
99  protected:
100  ~QSimpleUpdater();
101 
102  private:
103  Updater* getUpdater (const QString& url) const;
104 };
105 
106 #endif
Downloads and interprests the update definition file.
Definition: Updater.h:45
-
Manages the updater instances.
Definition: QSimpleUpdater.h:66
+
1 /*
2  * Copyright (c) 2014-2016 Alex Spataru <alex_spataru@outlook.com>
3  *
4  * This file is part of the QSimpleUpdater library, which is released under
5  * the DBAD license, you can read a copy of it below:
6  *
7  * DON'T BE A DICK PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING,
8  * DISTRIBUTION AND MODIFICATION:
9  *
10  * Do whatever you like with the original work, just don't be a dick.
11  * Being a dick includes - but is not limited to - the following instances:
12  *
13  * 1a. Outright copyright infringement - Don't just copy this and change the
14  * name.
15  * 1b. Selling the unmodified original with no work done what-so-ever, that's
16  * REALLY being a dick.
17  * 1c. Modifying the original work to contain hidden harmful content.
18  * That would make you a PROPER dick.
19  *
20  * If you become rich through modifications, related works/services, or
21  * supporting the original work, share the love.
22  * Only a dick would make loads off this work and not buy the original works
23  * creator(s) a pint.
24  *
25  * Code is provided with no warranty. Using somebody else's code and bitching
26  * when it goes wrong makes you a DONKEY dick.
27  * Fix the problem yourself. A non-dick would submit the fix back.
28  */
29 
30 #ifndef _QSIMPLEUPDATER_MAIN_H
31 #define _QSIMPLEUPDATER_MAIN_H
32 
33 #include <QUrl>
34 #include <QList>
35 #include <QObject>
36 
37 #if defined (QSU_SHARED)
38  #define QSU_DECL Q_DECL_EXPORT
39 #elif defined (QSU_IMPORT)
40  #define QSU_DECL Q_DECL_IMPORT
41 #else
42  #define QSU_DECL
43 #endif
44 
45 class Updater;
46 
66 class QSU_DECL QSimpleUpdater : public QObject {
67  Q_OBJECT
68 
69  signals:
70  void checkingFinished (const QString& url);
71  void downloadFinished (const QString& url, const QString& filepath);
72 
73  public:
74  static QSimpleUpdater* getInstance();
75 
76  bool getNotifyOnUpdate (const QString& url) const;
77  bool getNotifyOnFinish (const QString& url) const;
78  bool getUpdateAvailable (const QString& url) const;
79  bool getDownloaderEnabled (const QString& url) const;
80  bool usesCustomInstallProcedures (const QString& url) const;
81 
82  QString getChangelog (const QString& url) const;
83  QString getModuleName (const QString& url) const;
84  QString getDownloadUrl (const QString& url) const;
85  QString getPlatformKey (const QString& url) const;
86  QString getLatestVersion (const QString& url) const;
87  QString getModuleVersion (const QString& url) const;
88 
89  public slots:
90  void checkForUpdates (const QString& url);
91  void setModuleName (const QString& url, const QString& name);
92  void setNotifyOnUpdate (const QString& url, const bool& notify);
93  void setNotifyOnFinish (const QString& url, const bool& notify);
94  void setPlatformKey (const QString& url, const QString& platform);
95  void setModuleVersion (const QString& url, const QString& version);
96  void setDownloaderEnabled (const QString& url, const bool& enabled);
97  void setUseCustomInstallProcedures (const QString& url, const bool& custom);
98 
99  protected:
100  ~QSimpleUpdater();
101 
102  private:
103  Updater* getUpdater (const QString& url) const;
104 };
105 
106 #endif
Downloads and interprests the update definition file.
Definition: Updater.h:45
+
Manages the updater instances.
Definition: QSimpleUpdater.h:66
diff --git a/doc/output/html/_updater_8h_source.html b/doc/output/html/_updater_8h_source.html new file mode 100644 index 0000000..10dfd38 --- /dev/null +++ b/doc/output/html/_updater_8h_source.html @@ -0,0 +1,102 @@ + + + + + + +QSimpleUpdater: Updater.h Source File + + + + + + + + + + +
+
+ + + + + + + +
+
QSimpleUpdater +
+
A simple auto-updater system for Qt applications
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Updater.h
+
+
+
1 /*
2  * Copyright (c) 2014-2016 Alex Spataru <alex_spataru@outlook.com>
3  *
4  * This file is part of the QSimpleUpdater library, which is released under
5  * the DBAD license, you can read a copy of it below:
6  *
7  * DON'T BE A DICK PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING,
8  * DISTRIBUTION AND MODIFICATION:
9  *
10  * Do whatever you like with the original work, just don't be a dick.
11  * Being a dick includes - but is not limited to - the following instances:
12  *
13  * 1a. Outright copyright infringement - Don't just copy this and change the
14  * name.
15  * 1b. Selling the unmodified original with no work done what-so-ever, that's
16  * REALLY being a dick.
17  * 1c. Modifying the original work to contain hidden harmful content.
18  * That would make you a PROPER dick.
19  *
20  * If you become rich through modifications, related works/services, or
21  * supporting the original work, share the love.
22  * Only a dick would make loads off this work and not buy the original works
23  * creator(s) a pint.
24  *
25  * Code is provided with no warranty. Using somebody else's code and bitching
26  * when it goes wrong makes you a DONKEY dick.
27  * Fix the problem yourself. A non-dick would submit the fix back.
28  */
29 
30 #ifndef _QSIMPLEUPDATER_UPDATER_H
31 #define _QSIMPLEUPDATER_UPDATER_H
32 
33 #include <QUrl>
34 #include <QObject>
35 #include <QNetworkReply>
36 #include <QNetworkAccessManager>
37 
38 #include <QSimpleUpdater.h>
39 
40 class Downloader;
41 
45 class QSU_DECL Updater : public QObject {
46  Q_OBJECT
47 
48  signals:
49  void checkingFinished (const QString& url);
50  void downloadFinished (const QString& url, const QString& filepath);
51 
52  public:
53  Updater();
54  ~Updater();
55 
56  QString url() const;
57  QString changelog() const;
58  QString moduleName() const;
59  QString downloadUrl() const;
60  QString platformKey() const;
61  QString moduleVersion() const;
62  QString latestVersion() const;
63 
64  bool notifyOnUpdate() const;
65  bool notifyOnFinish() const;
66  bool updateAvailable() const;
67  bool downloaderEnabled() const;
68  bool useCustomInstallProcedures() const;
69 
70  public slots:
71  void checkForUpdates();
72  void setUrl (const QString& url);
73  void setModuleName (const QString& name);
74  void setNotifyOnUpdate (const bool& notify);
75  void setNotifyOnFinish (const bool& notify);
76  void setModuleVersion (const QString& version);
77  void setDownloaderEnabled (const bool& enabled);
78  void setPlatformKey (const QString& platformKey);
79  void setUseCustomInstallProcedures (const bool& custom);
80 
81  private slots:
82  void onReply (QNetworkReply* reply);
83  void setUpdateAvailable (const bool& available);
84 
85  private:
86  bool compare (const QString& x, const QString& y);
87 
88  private:
89  QString m_url;
90 
91  bool m_notifyOnUpdate;
92  bool m_notifyOnFinish;
93  bool m_updateAvailable;
94  bool m_downloaderEnabled;
95 
96  QString m_openUrl;
97  QString m_platform;
98  QString m_changelog;
99  QString m_moduleName;
100  QString m_downloadUrl;
101  QString m_moduleVersion;
102  QString m_latestVersion;
103 
104  Downloader* m_downloader;
105  QNetworkAccessManager* m_manager;
106 };
107 
108 #endif
Downloads and interprests the update definition file.
Definition: Updater.h:45
+
Implements an integrated file downloader with a nice UI.
Definition: Downloader.h:46
+
+ + + + diff --git a/doc/output/html/annotated.html b/doc/output/html/annotated.html index 716a2b2..12a2e06 100644 --- a/doc/output/html/annotated.html +++ b/doc/output/html/annotated.html @@ -90,9 +90,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - + + +
 CDownloaderImplements an integrated file downloader with a nice UI
 CQSimpleUpdaterManages the updater instances
 CUpdaterDownloads and interprests the update definition file
 CDownloaderImplements an integrated file downloader with a nice UI
 CQSimpleUpdaterManages the updater instances
 CUpdaterDownloads and interprests the update definition file
diff --git a/doc/output/html/class_downloader-members.html b/doc/output/html/class_downloader-members.html new file mode 100644 index 0000000..ffd4911 --- /dev/null +++ b/doc/output/html/class_downloader-members.html @@ -0,0 +1,108 @@ + + + + + + +QSimpleUpdater: Member List + + + + + + + + + + +
+
+ + + + + + + +
+
QSimpleUpdater +
+
A simple auto-updater system for Qt applications
+
+
+ + + + + + +
+
+ + +
+ +
+ +
+
+
+
Downloader Member List
+
+
+ +

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

+ + + + + + + +
Downloader(QWidget *parent=0) (defined in Downloader)Downloaderexplicit
downloadFinished(const QString &url, const QString &filepath) (defined in Downloader)Downloadersignal
setUseCustomInstallProcedures(const bool &custom)Downloaderslot
startDownload(const QUrl &url)Downloaderslot
useCustomInstallProcedures() const Downloader
~Downloader() (defined in Downloader)Downloader
+ + + + diff --git a/doc/output/html/de/dc0/class_downloader.html b/doc/output/html/class_downloader.html similarity index 66% rename from doc/output/html/de/dc0/class_downloader.html rename to doc/output/html/class_downloader.html index 4ed59eb..12e5b2a 100644 --- a/doc/output/html/de/dc0/class_downloader.html +++ b/doc/output/html/class_downloader.html @@ -5,16 +5,16 @@ QSimpleUpdater: Downloader Class Reference - - - - - - + + + + + + - +
@@ -22,7 +22,7 @@ - +
QSimpleUpdater
@@ -35,17 +35,17 @@ @@ -88,30 +88,30 @@ var searchBox = new SearchBox("searchBox", "../../search",false,'Search'); Public Slots | Signals | Public Member Functions | -List of all members +List of all members
Downloader Class Reference

Implements an integrated file downloader with a nice UI. - More...

+ More...

-

#include <Downloader.h>

+

#include <Downloader.h>

Inheritance diagram for Downloader:
- +
- + - +

Public Slots

void startDownload (const QUrl &url)
void startDownload (const QUrl &url)
 
void setUseCustomInstallProcedures (const bool &custom)
void setUseCustomInstallProcedures (const bool &custom)
 
- +

@@ -125,7 +125,7 @@ Public Member Functions

 Downloader (QWidget *parent=0)
 
bool useCustomInstallProcedures () const
bool useCustomInstallProcedures () const
 

Detailed Description

@@ -152,10 +152,10 @@ Public Member Functions
-

If the custom parameter is set to true, then the Downloader will not attempt to open the downloaded file.

-

Use the signals fired by the QSimpleUpdater to implement your own install procedures.

+

If the custom parameter is set to true, then the Downloader will not attempt to open the downloaded file.

+

Use the signals fired by the QSimpleUpdater to implement your own install procedures.

-

Referenced by Updater::setUseCustomInstallProcedures().

+

Referenced by Updater::setUseCustomInstallProcedures().

@@ -182,9 +182,9 @@ Public Member Functions
-

Returns true if the updater shall not intervene when the download has finished (you can use the QSimpleUpdater signals to know when the download is completed).

+

Returns true if the updater shall not intervene when the download has finished (you can use the QSimpleUpdater signals to know when the download is completed).

-

Referenced by startDownload(), and Updater::useCustomInstallProcedures().

+

Referenced by startDownload(), and Updater::useCustomInstallProcedures().


The documentation for this class was generated from the following files: diff --git a/doc/output/html/de/dc0/class_downloader.png b/doc/output/html/class_downloader.png similarity index 100% rename from doc/output/html/de/dc0/class_downloader.png rename to doc/output/html/class_downloader.png diff --git a/doc/output/html/class_q_simple_updater-members.html b/doc/output/html/class_q_simple_updater-members.html new file mode 100644 index 0000000..100b54c --- /dev/null +++ b/doc/output/html/class_q_simple_updater-members.html @@ -0,0 +1,125 @@ + + + + + + +QSimpleUpdater: Member List + + + + + + + + + + +
+
+ + + + + + + +
+
QSimpleUpdater +
+
A simple auto-updater system for Qt applications
+
+
+ + + + + + +
+
+ + +
+ +
+ +
+
+
+
QSimpleUpdater Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + +
checkForUpdates(const QString &url)QSimpleUpdaterslot
checkingFinished(const QString &url) (defined in QSimpleUpdater)QSimpleUpdatersignal
downloadFinished(const QString &url, const QString &filepath) (defined in QSimpleUpdater)QSimpleUpdatersignal
getChangelog(const QString &url) const QSimpleUpdater
getDownloaderEnabled(const QString &url) const QSimpleUpdater
getDownloadUrl(const QString &url) const QSimpleUpdater
getInstance()QSimpleUpdaterstatic
getLatestVersion(const QString &url) const QSimpleUpdater
getModuleName(const QString &url) const QSimpleUpdater
getModuleVersion(const QString &url) const QSimpleUpdater
getNotifyOnFinish(const QString &url) const QSimpleUpdater
getNotifyOnUpdate(const QString &url) const QSimpleUpdater
getPlatformKey(const QString &url) const QSimpleUpdater
getUpdateAvailable(const QString &url) const QSimpleUpdater
setDownloaderEnabled(const QString &url, const bool &enabled)QSimpleUpdaterslot
setModuleName(const QString &url, const QString &name)QSimpleUpdaterslot
setModuleVersion(const QString &url, const QString &version)QSimpleUpdaterslot
setNotifyOnFinish(const QString &url, const bool &notify)QSimpleUpdaterslot
setNotifyOnUpdate(const QString &url, const bool &notify)QSimpleUpdaterslot
setPlatformKey(const QString &url, const QString &platform)QSimpleUpdaterslot
setUseCustomInstallProcedures(const QString &url, const bool &custom)QSimpleUpdaterslot
usesCustomInstallProcedures(const QString &url) const QSimpleUpdater
~QSimpleUpdater() (defined in QSimpleUpdater)QSimpleUpdaterprotected
+ + + + diff --git a/doc/output/html/d0/d80/class_q_simple_updater.html b/doc/output/html/class_q_simple_updater.html similarity index 54% rename from doc/output/html/d0/d80/class_q_simple_updater.html rename to doc/output/html/class_q_simple_updater.html index cbf118c..2ce316b 100644 --- a/doc/output/html/d0/d80/class_q_simple_updater.html +++ b/doc/output/html/class_q_simple_updater.html @@ -5,16 +5,16 @@ QSimpleUpdater: QSimpleUpdater Class Reference - - - - - - + + + + + + - +
@@ -22,7 +22,7 @@ - +
QSimpleUpdater
@@ -35,17 +35,17 @@ @@ -89,42 +89,42 @@ var searchBox = new SearchBox("searchBox", "../../search",false,'Search'); Signals | Public Member Functions | Static Public Member Functions | -List of all members +List of all members
QSimpleUpdater Class Reference

Manages the updater instances. - More...

+ More...

-

#include <QSimpleUpdater.h>

+

#include <QSimpleUpdater.h>

Inheritance diagram for QSimpleUpdater:
- +
- + - + - + - + - + - + - + - +

Public Slots

void checkForUpdates (const QString &url)
void checkForUpdates (const QString &url)
 
void setModuleName (const QString &url, const QString &name)
void setModuleName (const QString &url, const QString &name)
 
void setNotifyOnUpdate (const QString &url, const bool &notify)
void setNotifyOnUpdate (const QString &url, const bool &notify)
 
void setNotifyOnFinish (const QString &url, const bool &notify)
void setNotifyOnFinish (const QString &url, const bool &notify)
 
void setPlatformKey (const QString &url, const QString &platform)
void setPlatformKey (const QString &url, const QString &platform)
 
void setModuleVersion (const QString &url, const QString &version)
void setModuleVersion (const QString &url, const QString &version)
 
void setDownloaderEnabled (const QString &url, const bool &enabled)
void setDownloaderEnabled (const QString &url, const bool &enabled)
 
void setUseCustomInstallProcedures (const QString &url, const bool &custom)
void setUseCustomInstallProcedures (const QString &url, const bool &custom)
 

@@ -138,39 +138,39 @@ void 

downloadFinished
- + - + - + - + - + - + - + - + - + - + - +

Public Member Functions

bool getNotifyOnUpdate (const QString &url) const
bool getNotifyOnUpdate (const QString &url) const
 
bool getNotifyOnFinish (const QString &url) const
bool getNotifyOnFinish (const QString &url) const
 
bool getUpdateAvailable (const QString &url) const
bool getUpdateAvailable (const QString &url) const
 
bool getDownloaderEnabled (const QString &url) const
bool getDownloaderEnabled (const QString &url) const
 
bool usesCustomInstallProcedures (const QString &url) const
bool usesCustomInstallProcedures (const QString &url) const
 
QString getChangelog (const QString &url) const
QString getChangelog (const QString &url) const
 
QString getModuleName (const QString &url) const
QString getModuleName (const QString &url) const
 
QString getDownloadUrl (const QString &url) const
QString getDownloadUrl (const QString &url) const
 
QString getPlatformKey (const QString &url) const
QString getPlatformKey (const QString &url) const
 
QString getLatestVersion (const QString &url) const
QString getLatestVersion (const QString &url) const
 
QString getModuleVersion (const QString &url) const
QString getModuleVersion (const QString &url) const
 
- +

Static Public Member Functions

static QSimpleUpdatergetInstance ()
static QSimpleUpdatergetInstance ()
 

Detailed Description

Manages the updater instances.

-

The QSimpleUpdater class manages the updater system and allows for parallel application modules to check for updates and download them.

-

The behavior of each updater can be regulated by specifying the update definitions URL (from where we download the individual update definitions) and defining the desired options by calling the individual "setter" functions (e.g. setNotifyOnUpdate()).

-

The QSimpleUpdater also implements an integrated downloader. If you need to use a custom install procedure/code, just create a function that is called when the downloadFinished() signal is emitted to implement your own install procedures.

+

The QSimpleUpdater class manages the updater system and allows for parallel application modules to check for updates and download them.

+

The behavior of each updater can be regulated by specifying the update definitions URL (from where we download the individual update definitions) and defining the desired options by calling the individual "setter" functions (e.g. setNotifyOnUpdate()).

+

The QSimpleUpdater also implements an integrated downloader. If you need to use a custom install procedure/code, just create a function that is called when the downloadFinished() signal is emitted to implement your own install procedures.

By default, the downloader will try to open the file as if you opened it from a file manager or a web browser (with the "file:*" url).

Member Function Documentation

@@ -194,10 +194,10 @@ Static Public Member Functions
-

Instructs the Updater instance with the registered url to download and interpret the update definitions file.

-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Instructs the Updater instance with the registered url to download and interpret the update definitions file.

+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::checkForUpdates().

+

References Updater::checkForUpdates().

@@ -214,11 +214,11 @@ Static Public Member Functions
-

Returns the changelog of the Updater instance registered with the given url.

-
Warning
You should call checkForUpdates() before using this function
-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Returns the changelog of the Updater instance registered with the given url.

+
Warning
You should call checkForUpdates() before using this function
+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::changelog().

+

References Updater::changelog().

@@ -235,10 +235,10 @@ Static Public Member Functions
-

Returns true if the Updater instance registered with the given url has the integrated downloader enabled.

-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Returns true if the Updater instance registered with the given url has the integrated downloader enabled.

+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::downloaderEnabled().

+

References Updater::downloaderEnabled().

@@ -255,11 +255,11 @@ Static Public Member Functions
-

Returns the download URL of the Updater instance registered with the given url.

-
Warning
You should call checkForUpdates() before using this function
-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Returns the download URL of the Updater instance registered with the given url.

+
Warning
You should call checkForUpdates() before using this function
+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::downloadUrl().

+

References Updater::downloadUrl().

@@ -271,7 +271,7 @@ Static Public Member Functions - + @@ -300,11 +300,11 @@ Static Public Member Functions
QSimpleUpdater * QSimpleUpdater::getInstance QSimpleUpdater * QSimpleUpdater::getInstance ( )
-

Returns the remote module version of the Updater instance registered with the given url.

-
Warning
You should call checkForUpdates() before using this function
-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Returns the remote module version of the Updater instance registered with the given url.

+
Warning
You should call checkForUpdates() before using this function
+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::latestVersion().

+

References Updater::latestVersion().

@@ -321,12 +321,12 @@ Static Public Member Functions
-

Returns the module name of the Updater instance registered with the given url.

-
Note
If the module name is empty, then the Updater will use the application name as its module name.
+

Returns the module name of the Updater instance registered with the given url.

+
Note
If the module name is empty, then the Updater will use the application name as its module name.
-If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::moduleName().

+

References Updater::moduleName().

@@ -343,12 +343,12 @@ If an -

Returns the module version of the Updater instance registered with the given url.

-
Note
If the module version is empty, then the Updater will use the application version as its module version.
+

Returns the module version of the Updater instance registered with the given url.

+
Note
If the module version is empty, then the Updater will use the application version as its module version.
-If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::moduleVersion().

+

References Updater::moduleVersion().

@@ -365,10 +365,10 @@ If an -

Returns true if the Updater instance registered with the given url shall notify the user when it finishes checking for updates.

-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Returns true if the Updater instance registered with the given url shall notify the user when it finishes checking for updates.

+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::notifyOnFinish().

+

References Updater::notifyOnFinish().

@@ -385,10 +385,10 @@ If an -

Returns true if the Updater instance registered with the given url shall notify the user when an update is available.

-
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
+

Returns true if the Updater instance registered with the given url shall notify the user when an update is available.

+
Note
If an Updater instance registered with the given url is not found, that Updater instance will be initialized automatically
-

References Updater::notifyOnUpdate().

+

References Updater::notifyOnUpdate().

@@ -405,16 +405,16 @@ If an -

Returns the platform key of the Updater registered with the given url. If you do not define a platform key, the system will assign the following platform key:

-

Referenced by QSimpleUpdater::getPlatformKey(), setPlatformKey(), and setUseCustomInstallProcedures().

+

Referenced by QSimpleUpdater::getPlatformKey(), setPlatformKey(), and setUseCustomInstallProcedures().

@@ -385,9 +385,9 @@ Public Member Functions
-

If the enabled parameter is set to true, the Updater will open the integrated downloader if the user agrees to install the update (if any)

+

If the enabled parameter is set to true, the Updater will open the integrated downloader if the user agrees to install the update (if any)

-

Referenced by QSimpleUpdater::setDownloaderEnabled().

+

Referenced by QSimpleUpdater::setDownloaderEnabled().

@@ -414,7 +414,7 @@ Public Member Functions

Changes the module name.

Note
The module name is used on the user prompts. If the module name is empty, then the prompts will show the name of the application.
-

Referenced by QSimpleUpdater::setModuleName().

+

Referenced by QSimpleUpdater::setModuleName().

@@ -439,9 +439,9 @@ Public Member Functions
-

Changes the module version

Note
The module version is used to compare the local and remote versions. If the version parameter is empty, then the Updater will use the application version (referenced by qApp)
+

Changes the module version

Note
The module version is used to compare the local and remote versions. If the version parameter is empty, then the Updater will use the application version (referenced by qApp)
-

Referenced by QSimpleUpdater::setModuleVersion().

+

Referenced by QSimpleUpdater::setModuleVersion().

@@ -466,9 +466,9 @@ Public Member Functions
-

If notify is set to true, then the Updater will notify the user when it has finished interpreting the update definitions file.

+

If notify is set to true, then the Updater will notify the user when it has finished interpreting the update definitions file.

-

Referenced by QSimpleUpdater::setNotifyOnFinish().

+

Referenced by QSimpleUpdater::setNotifyOnFinish().

@@ -493,9 +493,9 @@ Public Member Functions
-

If notify is set to true, then the Updater will notify the user when an update is available.

+

If notify is set to true, then the Updater will notify the user when an update is available.

-

Referenced by QSimpleUpdater::setNotifyOnUpdate().

+

Referenced by QSimpleUpdater::setNotifyOnUpdate().

@@ -528,9 +528,9 @@ Public Member Functions
  • On Microsoft Windows: windows
  • -

    References platformKey().

    +

    References platformKey().

    -

    Referenced by QSimpleUpdater::setPlatformKey().

    +

    Referenced by QSimpleUpdater::setPlatformKey().

    @@ -555,11 +555,11 @@ Public Member Functions
    -

    Changes the url in which the Updater can find the update definitions file.

    +

    Changes the url in which the Updater can find the update definitions file.

    -

    References url().

    +

    References url().

    -

    Referenced by QSimpleUpdater::setUseCustomInstallProcedures().

    +

    Referenced by QSimpleUpdater::setUseCustomInstallProcedures().

    @@ -584,11 +584,11 @@ Public Member Functions
    -

    If the custom parameter is set to true, the Updater will not try to open the downloaded file. Use the signals fired by the QSimpleUpdater to install the update from the downloaded file by yourself.

    +

    If the custom parameter is set to true, the Updater will not try to open the downloaded file. Use the signals fired by the QSimpleUpdater to install the update from the downloaded file by yourself.

    -

    References downloaderEnabled(), downloadUrl(), latestVersion(), moduleName(), moduleVersion(), notifyOnFinish(), notifyOnUpdate(), platformKey(), Downloader::setUseCustomInstallProcedures(), Downloader::startDownload(), updateAvailable(), and url().

    +

    References downloaderEnabled(), downloadUrl(), latestVersion(), moduleName(), moduleVersion(), notifyOnFinish(), notifyOnUpdate(), platformKey(), Downloader::setUseCustomInstallProcedures(), Downloader::startDownload(), updateAvailable(), and url().

    -

    Referenced by QSimpleUpdater::setUseCustomInstallProcedures().

    +

    Referenced by QSimpleUpdater::setUseCustomInstallProcedures().

    @@ -604,9 +604,9 @@ Public Member Functions
    -

    Returns true if there is an update available.

    Warning
    You should call checkForUpdates() before using this function
    +

    Returns true if there is an update available.

    Warning
    You should call checkForUpdates() before using this function
    -

    Referenced by QSimpleUpdater::getUpdateAvailable(), and setUseCustomInstallProcedures().

    +

    Referenced by QSimpleUpdater::getUpdateAvailable(), and setUseCustomInstallProcedures().

    @@ -624,7 +624,7 @@ Public Member Functions

    Returns the URL of the update definitions file

    -

    Referenced by checkForUpdates(), setUrl(), and setUseCustomInstallProcedures().

    +

    Referenced by checkForUpdates(), setUrl(), and setUseCustomInstallProcedures().

    @@ -640,23 +640,23 @@ Public Member Functions
    -

    Returns true if the updater shall not intervene when the download has finished (you can use the QSimpleUpdater signals to know when the download is completed).

    +

    Returns true if the updater shall not intervene when the download has finished (you can use the QSimpleUpdater signals to know when the download is completed).

    -

    References Downloader::useCustomInstallProcedures().

    +

    References Downloader::useCustomInstallProcedures().

    -

    Referenced by QSimpleUpdater::usesCustomInstallProcedures().

    +

    Referenced by QSimpleUpdater::usesCustomInstallProcedures().


    The documentation for this class was generated from the following files: diff --git a/doc/output/html/d3/d1d/class_updater.png b/doc/output/html/class_updater.png similarity index 100% rename from doc/output/html/d3/d1d/class_updater.png rename to doc/output/html/class_updater.png diff --git a/doc/output/html/classes.html b/doc/output/html/classes.html index 0ecead3..7a89a3d 100644 --- a/doc/output/html/classes.html +++ b/doc/output/html/classes.html @@ -95,7 +95,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
      U  
    -Downloader   QSimpleUpdater   Updater    +Downloader   QSimpleUpdater   Updater   
    D | Q | U
    diff --git a/doc/output/html/d4/d1d/class_q_simple_updater-members.html b/doc/output/html/d4/d1d/class_q_simple_updater-members.html deleted file mode 100644 index c9cf382..0000000 --- a/doc/output/html/d4/d1d/class_q_simple_updater-members.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - -QSimpleUpdater: Member List - - - - - - - - - - -
    -
    - - - - - - - -
    -
    QSimpleUpdater -
    -
    A simple auto-updater system for Qt applications
    -
    -
    - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    -
    QSimpleUpdater Member List
    -
    -
    - -

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

    - - - - - - - - - - - - - - - - - - - - - - - - -
    checkForUpdates(const QString &url)QSimpleUpdaterslot
    checkingFinished(const QString &url) (defined in QSimpleUpdater)QSimpleUpdatersignal
    downloadFinished(const QString &url, const QString &filepath) (defined in QSimpleUpdater)QSimpleUpdatersignal
    getChangelog(const QString &url) const QSimpleUpdater
    getDownloaderEnabled(const QString &url) const QSimpleUpdater
    getDownloadUrl(const QString &url) const QSimpleUpdater
    getInstance()QSimpleUpdaterstatic
    getLatestVersion(const QString &url) const QSimpleUpdater
    getModuleName(const QString &url) const QSimpleUpdater
    getModuleVersion(const QString &url) const QSimpleUpdater
    getNotifyOnFinish(const QString &url) const QSimpleUpdater
    getNotifyOnUpdate(const QString &url) const QSimpleUpdater
    getPlatformKey(const QString &url) const QSimpleUpdater
    getUpdateAvailable(const QString &url) const QSimpleUpdater
    setDownloaderEnabled(const QString &url, const bool &enabled)QSimpleUpdaterslot
    setModuleName(const QString &url, const QString &name)QSimpleUpdaterslot
    setModuleVersion(const QString &url, const QString &version)QSimpleUpdaterslot
    setNotifyOnFinish(const QString &url, const bool &notify)QSimpleUpdaterslot
    setNotifyOnUpdate(const QString &url, const bool &notify)QSimpleUpdaterslot
    setPlatformKey(const QString &url, const QString &platform)QSimpleUpdaterslot
    setUseCustomInstallProcedures(const QString &url, const bool &custom)QSimpleUpdaterslot
    usesCustomInstallProcedures(const QString &url) const QSimpleUpdater
    ~QSimpleUpdater() (defined in QSimpleUpdater)QSimpleUpdaterprotected
    - - - - diff --git a/doc/output/html/d4/d44/class_updater-members.html b/doc/output/html/d4/d44/class_updater-members.html deleted file mode 100644 index e232516..0000000 --- a/doc/output/html/d4/d44/class_updater-members.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - -QSimpleUpdater: Member List - - - - - - - - - - -
    -
    - - - - - - - -
    -
    QSimpleUpdater -
    -
    A simple auto-updater system for Qt applications
    -
    -
    - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    -
    Updater Member List
    -
    -
    - -

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

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    changelog() const Updater
    checkForUpdates()Updaterslot
    checkingFinished(const QString &url) (defined in Updater)Updatersignal
    downloaderEnabled() const Updater
    downloadFinished(const QString &url, const QString &filepath) (defined in Updater)Updatersignal
    downloadUrl() const Updater
    latestVersion() const Updater
    moduleName() const Updater
    moduleVersion() const Updater
    notifyOnFinish() const Updater
    notifyOnUpdate() const Updater
    platformKey() const Updater
    setDownloaderEnabled(const bool &enabled)Updaterslot
    setModuleName(const QString &name)Updaterslot
    setModuleVersion(const QString &version)Updaterslot
    setNotifyOnFinish(const bool &notify)Updaterslot
    setNotifyOnUpdate(const bool &notify)Updaterslot
    setPlatformKey(const QString &platformKey)Updaterslot
    setUrl(const QString &url)Updaterslot
    setUseCustomInstallProcedures(const bool &custom)Updaterslot
    updateAvailable() const Updater
    Updater() (defined in Updater)Updater
    url() const Updater
    useCustomInstallProcedures() const Updater
    ~Updater() (defined in Updater)Updater
    - - - - diff --git a/doc/output/html/d5/d7d/class_downloader-members.html b/doc/output/html/d5/d7d/class_downloader-members.html deleted file mode 100644 index a017b11..0000000 --- a/doc/output/html/d5/d7d/class_downloader-members.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - -QSimpleUpdater: Member List - - - - - - - - - - -
    -
    - - - - - - - -
    -
    QSimpleUpdater -
    -
    A simple auto-updater system for Qt applications
    -
    -
    - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    -
    Downloader Member List
    -
    -
    - -

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

    - - - - - - - -
    Downloader(QWidget *parent=0) (defined in Downloader)Downloaderexplicit
    downloadFinished(const QString &url, const QString &filepath) (defined in Downloader)Downloadersignal
    setUseCustomInstallProcedures(const bool &custom)Downloaderslot
    startDownload(const QUrl &url)Downloaderslot
    useCustomInstallProcedures() const Downloader
    ~Downloader() (defined in Downloader)Downloader
    - - - - diff --git a/doc/output/html/dd/d30/_updater_8h_source.html b/doc/output/html/dd/d30/_updater_8h_source.html deleted file mode 100644 index 1ea5f40..0000000 --- a/doc/output/html/dd/d30/_updater_8h_source.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - -QSimpleUpdater: Updater.h Source File - - - - - - - - - - -
    -
    - - - - - - - -
    -
    QSimpleUpdater -
    -
    A simple auto-updater system for Qt applications
    -
    -
    - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    -
    Updater.h
    -
    -
    -
    1 /*
    2  * Copyright (c) 2014-2016 Alex Spataru <alex_spataru@outlook.com>
    3  *
    4  * This file is part of the QSimpleUpdater library, which is released under
    5  * the DBAD license, you can read a copy of it below:
    6  *
    7  * DON'T BE A DICK PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING,
    8  * DISTRIBUTION AND MODIFICATION:
    9  *
    10  * Do whatever you like with the original work, just don't be a dick.
    11  * Being a dick includes - but is not limited to - the following instances:
    12  *
    13  * 1a. Outright copyright infringement - Don't just copy this and change the
    14  * name.
    15  * 1b. Selling the unmodified original with no work done what-so-ever, that's
    16  * REALLY being a dick.
    17  * 1c. Modifying the original work to contain hidden harmful content.
    18  * That would make you a PROPER dick.
    19  *
    20  * If you become rich through modifications, related works/services, or
    21  * supporting the original work, share the love.
    22  * Only a dick would make loads off this work and not buy the original works
    23  * creator(s) a pint.
    24  *
    25  * Code is provided with no warranty. Using somebody else's code and bitching
    26  * when it goes wrong makes you a DONKEY dick.
    27  * Fix the problem yourself. A non-dick would submit the fix back.
    28  */
    29 
    30 #ifndef _QSIMPLEUPDATER_UPDATER_H
    31 #define _QSIMPLEUPDATER_UPDATER_H
    32 
    33 #include <QUrl>
    34 #include <QObject>
    35 #include <QNetworkReply>
    36 #include <QNetworkAccessManager>
    37 
    38 #include <QSimpleUpdater.h>
    39 
    40 class Downloader;
    41 
    45 class QSU_DECL Updater : public QObject {
    46  Q_OBJECT
    47 
    48  signals:
    49  void checkingFinished (const QString& url);
    50  void downloadFinished (const QString& url, const QString& filepath);
    51 
    52  public:
    53  Updater();
    54  ~Updater();
    55 
    56  QString url() const;
    57  QString changelog() const;
    58  QString moduleName() const;
    59  QString downloadUrl() const;
    60  QString platformKey() const;
    61  QString moduleVersion() const;
    62  QString latestVersion() const;
    63 
    64  bool notifyOnUpdate() const;
    65  bool notifyOnFinish() const;
    66  bool updateAvailable() const;
    67  bool downloaderEnabled() const;
    68  bool useCustomInstallProcedures() const;
    69 
    70  public slots:
    71  void checkForUpdates();
    72  void setUrl (const QString& url);
    73  void setModuleName (const QString& name);
    74  void setNotifyOnUpdate (const bool& notify);
    75  void setNotifyOnFinish (const bool& notify);
    76  void setModuleVersion (const QString& version);
    77  void setDownloaderEnabled (const bool& enabled);
    78  void setPlatformKey (const QString& platformKey);
    79  void setUseCustomInstallProcedures (const bool& custom);
    80 
    81  private slots:
    82  void onReply (QNetworkReply* reply);
    83  void setUpdateAvailable (const bool& available);
    84 
    85  private:
    86  bool compare (const QString& x, const QString& y);
    87 
    88  private:
    89  QString m_url;
    90 
    91  bool m_notifyOnUpdate;
    92  bool m_notifyOnFinish;
    93  bool m_updateAvailable;
    94  bool m_downloaderEnabled;
    95 
    96  QString m_openUrl;
    97  QString m_platform;
    98  QString m_changelog;
    99  QString m_moduleName;
    100  QString m_downloadUrl;
    101  QString m_moduleVersion;
    102  QString m_latestVersion;
    103 
    104  Downloader* m_downloader;
    105  QNetworkAccessManager* m_manager;
    106 };
    107 
    108 #endif
    Downloads and interprests the update definition file.
    Definition: Updater.h:45
    -
    Implements an integrated file downloader with a nice UI.
    Definition: Downloader.h:46
    -
    - - - - diff --git a/doc/output/html/files.html b/doc/output/html/files.html index f43c8de..ed9a94b 100644 --- a/doc/output/html/files.html +++ b/doc/output/html/files.html @@ -87,9 +87,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    Here is a list of all documented files with brief descriptions:
    - - - + + +
     Downloader.h
     QSimpleUpdater.h
     Updater.h
     Downloader.h
     QSimpleUpdater.h
     Updater.h
    diff --git a/doc/output/html/functions.html b/doc/output/html/functions.html index 2d7df6a..315bea7 100644 --- a/doc/output/html/functions.html +++ b/doc/output/html/functions.html @@ -107,148 +107,148 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    - c -

    - d -

    - g -

    - l -

    - m -

    - n -

    - p -

    - s -

    - u -

    diff --git a/doc/output/html/functions_func.html b/doc/output/html/functions_func.html index 505976e..776b2bd 100644 --- a/doc/output/html/functions_func.html +++ b/doc/output/html/functions_func.html @@ -107,148 +107,148 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    - c -

    - d -

    - g -

    - l -

    - m -

    - n -

    - p -

    - s -

    - u -

    diff --git a/doc/output/html/hierarchy.html b/doc/output/html/hierarchy.html index 108ded1..4e5944a 100644 --- a/doc/output/html/hierarchy.html +++ b/doc/output/html/hierarchy.html @@ -91,10 +91,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    This inheritance list is sorted roughly, but not completely, alphabetically:
    [detail level 12]
    - - + + - +
     CQObject
     CQSimpleUpdaterManages the updater instances
     CUpdaterDownloads and interprests the update definition file
     CQSimpleUpdaterManages the updater instances
     CUpdaterDownloads and interprests the update definition file
     CQWidget
     CDownloaderImplements an integrated file downloader with a nice UI
     CDownloaderImplements an integrated file downloader with a nice UI
    diff --git a/doc/output/html/index.html b/doc/output/html/index.html index 564af6d..a972aaa 100644 --- a/doc/output/html/index.html +++ b/doc/output/html/index.html @@ -80,26 +80,26 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    Introduction
    -

    QSimpleUpdater is an implementation of an auto-updating system to be used with Qt projects. It allows you to easily check for updates, download them and install them. Additionally, the QSimpleUpdater allows you to check for updates for different "modules" of your application. Check the WTFs for more information.

    -

    Integrating QSimpleUpdater with your projects

    +

    QSimpleUpdater is an implementation of an auto-updating system to be used with Qt projects. It allows you to easily check for updates, download them and install them. Additionally, the QSimpleUpdater allows you to check for updates for different "modules" of your application. Check the WTFs for more information.

    +

    Integrating QSimpleUpdater with your projects

      -
    1. Copy the QSimpleUpdater folder in your "3rd-party" folder.
    2. -
    3. Include the QSimpleUpdater project include (pri) file using the include() function.
    4. +
    5. Copy the QSimpleUpdater folder in your "3rd-party" folder.
    6. +
    7. Include the QSimpleUpdater project include (pri) file using the include() function.
    8. That's all! Check the tutorial project as a reference for your project.

    WTFs Section

    -

    1. How does the QSimpleUpdater check for updates?

    -

    The QSimpleUpdater downloads an update definition file stored in JSON format. This file specifies the latest version, the download links and changelogs for each platform (you can also register your own platform easily if needed).

    +

    1. How does the QSimpleUpdater check for updates?

    +

    The QSimpleUpdater downloads an update definition file stored in JSON format. This file specifies the latest version, the download links and changelogs for each platform (you can also register your own platform easily if needed).

    After downloading this file, the library analyzes the local version and the remote version. If the remote version is greater than the local version, then the library infers that there is an update available and notifies the user.

    2. Can I customize the update notifications shown to the user?

    -

    Yes! You can "toggle" which notifications to show using the library's functions or re-implement by yourself the notifications by "reacting" to the signals emitted by the QSimpleUpdater.

    +

    Yes! You can "toggle" which notifications to show using the library's functions or re-implement by yourself the notifications by "reacting" to the signals emitted by the QSimpleUpdater.

    1 QString url = "https://MyBadassApplication.com/updates.json";
    2 
    3 QSimpleUpdater::getInstance()->setNotifyOnUpdate (url, true);
    4 QSimpleUpdater::getInstance()->setNotifyOnFinish (url, false);
    5 
    6 QSimpleUpdater::getInstance()->checkForUpdates (url);

    3. Is the application able to download the updates directly?

    Yes. If there is an update available, the library will prompt the user if he/she wants to download the update. You can enable or disable the integrated downloader with the following code:

    1 QString url = "https://MyBadassApplication.com/updates.json";
    2 QSimpleUpdater::getInstance()->setDownloaderEnabled (url, true);

    4. Why do I need to specify an URL for each function of the library?

    -

    The QSimpleUpdater allows you to use different updater instances, which can be accessed with the URL of the update definitions. While it is not obligatory to use multiple updater instances, this can be useful for applications that make use of plugins or different modules.

    +

    The QSimpleUpdater allows you to use different updater instances, which can be accessed with the URL of the update definitions. While it is not obligatory to use multiple updater instances, this can be useful for applications that make use of plugins or different modules.

    Say that you are developing a game, in this case, you could use the following code:

    1 // Update the game textures
    2 QString textures_url = "https://MyBadassGame.com/textures.json"
    3 QSimpleUpdater::getInstance()->setModuleName (textures_url, "textures");
    4 QSimpleUpdater::getInstance()->setModuleVersion (textures_url, "0.4");
    5 QSimpleUpdater::getInstance()->checkForUpdates (textures_url);
    6 
    7 // Update the game sounds
    8 QString sounds_url = "https://MyBadassGame.com/sounds.json"
    9 QSimpleUpdater::getInstance()->setModuleName (sounds_url, "sounds");
    10 QSimpleUpdater::getInstance()->setModuleVersion (sounds_url, "0.6");
    11 QSimpleUpdater::getInstance()->checkForUpdates (sounds_url);
    12 
    13 // Update the client (name & versions are already stored in qApp)
    14 QString client_url = "https://MyBadassGame.com/client.json"
    15 QSimpleUpdater::getInstance()->checkForUpdates (client_url);

    License

    -

    QSimpleUpdater is free and open-source software, it is released under the Don't Be A Dick License.

    +

    QSimpleUpdater is free and open-source software, it is released under the Don't Be A Dick License.