QSimpleUpdater
A simple auto-updater system for Qt applications
Public Slots | Signals | Public Member Functions | List of all members
Updater Class Reference

Downloads and interprests the update definition file. More...

#include <Updater.h>

Inheritance diagram for Updater:

Public Slots

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

Signals

void checkingFinished (const QString &url)
 
void downloadFinished (const QString &url, const QString &filepath)
 

Public Member Functions

QString url () const
 
QString changelog () const
 
QString moduleName () const
 
QString downloadUrl () const
 
QString platformKey () const
 
QString moduleVersion () const
 
QString latestVersion () const
 
bool notifyOnUpdate () const
 
bool notifyOnFinish () const
 
bool updateAvailable () const
 
bool downloaderEnabled () const
 
bool useCustomInstallProcedures () const
 

Detailed Description

Downloads and interprests the update definition file.

Member Function Documentation

QString Updater::changelog ( ) const

Returns the changelog defined by the update definitions file.

Warning
You should call checkForUpdates() before using this function

Referenced by QSimpleUpdater::getChangelog().

void Updater::checkForUpdates ( )
slot

Downloads and interpets the update definitions file referenced by the url() function.

References url().

Referenced by QSimpleUpdater::checkForUpdates().

bool Updater::downloaderEnabled ( ) const

Returns true if the integrated downloader is enabled.

Note
If set to true, the Updater will open the downloader dialog if the user agrees to download the update.

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

QString Updater::downloadUrl ( ) const

Returns the download URL defined by the update definitions file.

Warning
You should call checkForUpdates() before using this function

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

QString Updater::latestVersion ( ) const

Returns the latest version defined by the update definitions file.

Warning
You should call checkForUpdates() before using this function

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

QString Updater::moduleName ( ) const

Returns the name of the module (if defined)

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

QString Updater::moduleVersion ( ) const

Returns the "local" version of the installed module

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

bool Updater::notifyOnFinish ( ) const

Returns true if the updater should notify the user when it finishes checking for updates.

Note
If set to true, the Updater will notify the user even when there are no updates available (by congratulating him/her about being smart)

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

bool Updater::notifyOnUpdate ( ) const

Returns true if the updater should notify the user when an update is available.

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

QString Updater::platformKey ( ) const

Returns the platform key (be it system-set or user-set). If you do not define a platform key, the system will assign the following platform key:

  • On iOS: ios
  • On Mac OSX: osx
  • On Android: android
  • On GNU/Linux: linux
  • On Microsoft Windows: windows

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

void Updater::setDownloaderEnabled ( const bool &  enabled)
slot

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().

void Updater::setModuleName ( const QString &  name)
slot

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().

void Updater::setModuleVersion ( const QString &  version)
slot

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().

void Updater::setNotifyOnFinish ( const bool &  notify)
slot

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().

void Updater::setNotifyOnUpdate ( const bool &  notify)
slot

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

Referenced by QSimpleUpdater::setNotifyOnUpdate().

void Updater::setPlatformKey ( const QString &  platformKey)
slot

Changes the platform key. If the platform key is empty, then the system will use the following keys:

  • On iOS: ios
  • On Mac OSX: osx
  • On Android: android
  • On GNU/Linux: linux
  • On Microsoft Windows: windows

References platformKey().

Referenced by QSimpleUpdater::setPlatformKey().

void Updater::setUrl ( const QString &  url)
slot

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

References url().

Referenced by QSimpleUpdater::setUseCustomInstallProcedures().

void Updater::setUseCustomInstallProcedures ( const bool &  custom)
slot

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().

Referenced by QSimpleUpdater::setUseCustomInstallProcedures().

bool Updater::updateAvailable ( ) const

Returns true if there is an update available.

Warning
You should call checkForUpdates() before using this function

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

QString Updater::url ( ) const

Returns the URL of the update definitions file

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

bool Updater::useCustomInstallProcedures ( ) const

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().

Referenced by QSimpleUpdater::usesCustomInstallProcedures().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11