692 lines
34 KiB
HTML
692 lines
34 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>QSimpleUpdater: Updater Class Reference</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../jquery.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../search/searchdata.js"></script>
|
|
<script type="text/javascript" src="../../search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="../../icon.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">QSimpleUpdater
|
|
</div>
|
|
<div id="projectbrief">A simple auto-updater system for Qt applications</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="../../index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="../../files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="../../search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="../../annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="../../classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="../../hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="../../functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-slots">Public Slots</a> |
|
|
<a href="#signals">Signals</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="../../d4/d44/class_updater-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Updater Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="../../dd/d30/_updater_8h_source.html">Updater.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Updater:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="../../d3/d1d/class_updater.png" usemap="#Updater_map" alt=""/>
|
|
<map id="Updater_map" name="Updater_map">
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
|
|
Public Slots</h2></td></tr>
|
|
<tr class="memitem:a4af41658f974f72c71a9463be7bba1b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a4af41658f974f72c71a9463be7bba1b5">checkForUpdates</a> ()</td></tr>
|
|
<tr class="separator:a4af41658f974f72c71a9463be7bba1b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1219e9bb1c1fb0a68d757fbc0d9b76aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a1219e9bb1c1fb0a68d757fbc0d9b76aa">setUrl</a> (const QString &<a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url</a>)</td></tr>
|
|
<tr class="separator:a1219e9bb1c1fb0a68d757fbc0d9b76aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad88b597bf4ae11a65a9c87171239ed00"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#ad88b597bf4ae11a65a9c87171239ed00">setNotifyOnUpdate</a> (const bool &notify)</td></tr>
|
|
<tr class="separator:ad88b597bf4ae11a65a9c87171239ed00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a949e507fd72ec4b2565bb49ebe98a2dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a949e507fd72ec4b2565bb49ebe98a2dc">setNotifyOnFinish</a> (const bool &notify)</td></tr>
|
|
<tr class="separator:a949e507fd72ec4b2565bb49ebe98a2dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ac7e1a2bd65353a5fdec22689f1adf3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a5ac7e1a2bd65353a5fdec22689f1adf3">setModuleName</a> (const QString &name)</td></tr>
|
|
<tr class="separator:a5ac7e1a2bd65353a5fdec22689f1adf3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8da70f39cc193b94c64769fc6f40dc2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion</a> (const QString &version)</td></tr>
|
|
<tr class="separator:a8da70f39cc193b94c64769fc6f40dc2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46d6db0d853ed8400a1725df436812ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a46d6db0d853ed8400a1725df436812ee">setDownloaderEnabled</a> (const bool &enabled)</td></tr>
|
|
<tr class="separator:a46d6db0d853ed8400a1725df436812ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a840a6b061590901eae3255ba74ff7ad8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a840a6b061590901eae3255ba74ff7ad8">setPlatformKey</a> (const QString &<a class="el" href="../../d3/d1d/class_updater.html#ad6d8a5d7b8fd9bdfde738d72c50f8bee">platformKey</a>)</td></tr>
|
|
<tr class="separator:a840a6b061590901eae3255ba74ff7ad8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3f35326fb62b9cf8a2421d91651ad60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#ac3f35326fb62b9cf8a2421d91651ad60">setUseCustomInstallProcedures</a> (const bool &custom)</td></tr>
|
|
<tr class="separator:ac3f35326fb62b9cf8a2421d91651ad60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
|
|
Signals</h2></td></tr>
|
|
<tr class="memitem:a82debd6b1ad627d6d40c0f2a9996e0c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a82debd6b1ad627d6d40c0f2a9996e0c1">checkingFinished</a> (const QString &<a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url</a>)</td></tr>
|
|
<tr class="separator:a82debd6b1ad627d6d40c0f2a9996e0c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a274a08240ad2bbea8cda6c52787510d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a274a08240ad2bbea8cda6c52787510d3">downloadFinished</a> (const QString &<a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url</a>, const QString &filepath)</td></tr>
|
|
<tr class="separator:a274a08240ad2bbea8cda6c52787510d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7ebf698a86619ebaadd2eb6e772f2a3d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url</a> () const </td></tr>
|
|
<tr class="separator:a7ebf698a86619ebaadd2eb6e772f2a3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6d8a5d7b8fd9bdfde738d72c50f8bee"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#ad6d8a5d7b8fd9bdfde738d72c50f8bee">platformKey</a> () const </td></tr>
|
|
<tr class="separator:ad6d8a5d7b8fd9bdfde738d72c50f8bee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abefc7aae1333458ab03d50aec9b58581"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#abefc7aae1333458ab03d50aec9b58581">notifyOnUpdate</a> () const </td></tr>
|
|
<tr class="separator:abefc7aae1333458ab03d50aec9b58581"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9fd2c8c3782c04289a76b1bf0b23ca0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#ad9fd2c8c3782c04289a76b1bf0b23ca0">notifyOnFinish</a> () const </td></tr>
|
|
<tr class="separator:ad9fd2c8c3782c04289a76b1bf0b23ca0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec889d582692cb41875ea803db3feb35"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#aec889d582692cb41875ea803db3feb35">updateAvailable</a> () const </td></tr>
|
|
<tr class="separator:aec889d582692cb41875ea803db3feb35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f526325b92c344244303b877d990cd3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a4f526325b92c344244303b877d990cd3">downloaderEnabled</a> () const </td></tr>
|
|
<tr class="separator:a4f526325b92c344244303b877d990cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6a266ddbf0b855bcee1e9f77dfe9efb"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#af6a266ddbf0b855bcee1e9f77dfe9efb">changelog</a> () const </td></tr>
|
|
<tr class="separator:af6a266ddbf0b855bcee1e9f77dfe9efb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5690e5ab3dde19098caf77c22f8bf075"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a5690e5ab3dde19098caf77c22f8bf075">downloadUrl</a> () const </td></tr>
|
|
<tr class="separator:a5690e5ab3dde19098caf77c22f8bf075"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25e7f289753c6d7b4439ee3728866a48"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a25e7f289753c6d7b4439ee3728866a48">latestVersion</a> () const </td></tr>
|
|
<tr class="separator:a25e7f289753c6d7b4439ee3728866a48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d8369115126e41cdefd30004cefc46d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a7d8369115126e41cdefd30004cefc46d">moduleName</a> () const </td></tr>
|
|
<tr class="separator:a7d8369115126e41cdefd30004cefc46d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af32daac9bff9cb3e79798fc9a825648e"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#af32daac9bff9cb3e79798fc9a825648e">moduleVersion</a> () const </td></tr>
|
|
<tr class="separator:af32daac9bff9cb3e79798fc9a825648e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7860e1643f426dc4d62cec2cdf207cd5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d1d/class_updater.html#a7860e1643f426dc4d62cec2cdf207cd5">useCustomInstallProcedures</a> () const </td></tr>
|
|
<tr class="separator:a7860e1643f426dc4d62cec2cdf207cd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="../../d3/d1d/class_updater.html">Updater</a> class is in charge of downloading and analyzing the appcast and "reacting" based on the options given by the user/developer/application. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="af6a266ddbf0b855bcee1e9f77dfe9efb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::changelog </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the latest changelog </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4af41658f974f72c71a9463be7bba1b5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::checkForUpdates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Downloads the update definitions file and analyzes it to determine the latest version and the download links </p>
|
|
|
|
<p>References <a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a82debd6b1ad627d6d40c0f2a9996e0c1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::checkingFinished </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>url</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Emitted when the download definitions have been downloaded and analyzed. </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4f526325b92c344244303b877d990cd3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Updater::downloaderEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns <code>if</code> the updater allows the integrated downloader to download and install the update (if aplicable). </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a274a08240ad2bbea8cda6c52787510d3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::downloadFinished </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>url</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>filepath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Emitted when the download has finished. You can use this to implement your own procedures to install the downloaded updates. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5690e5ab3dde19098caf77c22f8bf075"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::downloadUrl </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the URL from where we can download the update </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a25e7f289753c6d7b4439ee3728866a48"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::latestVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the latest version online </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7d8369115126e41cdefd30004cefc46d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::moduleName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the application name, which can be set manually or automatically using the <code>qApp->applicationName()</code> function. </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af32daac9bff9cb3e79798fc9a825648e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::moduleVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the application version, which can be set manually or automatically using the <code>qApp->applicationVersion()</code> function. </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad9fd2c8c3782c04289a76b1bf0b23ca0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Updater::notifyOnFinish </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns <code>true</code> if the class is set to notify the user when it finishes checking for updates (even if there are no updates available). By default this value is set to <code>false</code>. </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abefc7aae1333458ab03d50aec9b58581"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Updater::notifyOnUpdate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns <code>true</code> if the class is set to notify the user when an update is found online. By default this value is set to <code>true</code>. </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6d8a5d7b8fd9bdfde738d72c50f8bee"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::platformKey </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the current platform key, which is used to differentiate the different download links (and download versions) based on the current operating system.</p>
|
|
<p>You can modify this value with the <code><a class="el" href="../../d3/d1d/class_updater.html#a840a6b061590901eae3255ba74ff7ad8">setPlatformKey()</a></code> function </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>, and <a class="el" href="../../d3/d1d/class_updater.html#a840a6b061590901eae3255ba74ff7ad8">setPlatformKey()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a46d6db0d853ed8400a1725df436812ee"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setDownloaderEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool & </td>
|
|
<td class="paramname"><em>enabled</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If <em>enabled</em> is set to true, then the user will be able to download and install updates directly from the application, without the need of opening the download URL from a browser and manually installing the update. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5ac7e1a2bd65353a5fdec22689f1adf3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setModuleName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Changes the name of the module, this can be useful in large applications that only need to update certain components of them (e.g. plugins). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8da70f39cc193b94c64769fc6f40dc2c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setModuleVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>version</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Changes the version of the module, this can be useful in large applications that only need to update certain components of them (e.g. plugins). </p>
|
|
|
|
<p>References <a class="el" href="../../d3/d1d/class_updater.html#a82debd6b1ad627d6d40c0f2a9996e0c1">checkingFinished()</a>, <a class="el" href="../../d3/d1d/class_updater.html#a4f526325b92c344244303b877d990cd3">downloaderEnabled()</a>, <a class="el" href="../../d3/d1d/class_updater.html#a5690e5ab3dde19098caf77c22f8bf075">downloadUrl()</a>, <a class="el" href="../../d3/d1d/class_updater.html#a25e7f289753c6d7b4439ee3728866a48">latestVersion()</a>, <a class="el" href="../../d3/d1d/class_updater.html#a7d8369115126e41cdefd30004cefc46d">moduleName()</a>, <a class="el" href="../../d3/d1d/class_updater.html#af32daac9bff9cb3e79798fc9a825648e">moduleVersion()</a>, <a class="el" href="../../d3/d1d/class_updater.html#ad9fd2c8c3782c04289a76b1bf0b23ca0">notifyOnFinish()</a>, <a class="el" href="../../d3/d1d/class_updater.html#abefc7aae1333458ab03d50aec9b58581">notifyOnUpdate()</a>, <a class="el" href="../../d3/d1d/class_updater.html#ad6d8a5d7b8fd9bdfde738d72c50f8bee">platformKey()</a>, <a class="el" href="../../de/dc0/class_downloader.html#a7f81027436d44ca52168b30a6eb0d379">Downloader::startDownload()</a>, <a class="el" href="../../d3/d1d/class_updater.html#aec889d582692cb41875ea803db3feb35">updateAvailable()</a>, and <a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a949e507fd72ec4b2565bb49ebe98a2dc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setNotifyOnFinish </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool & </td>
|
|
<td class="paramname"><em>notify</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If set to <code>true</code>, the updater will notify the user when it finishes checking for updates (even where there are no updates available).</p>
|
|
<p>If set to <code>false</code> (default), the updater will only notify the user when there is an update available (if <a class="el" href="../../d3/d1d/class_updater.html#ad88b597bf4ae11a65a9c87171239ed00">setNotifyOnUpdate()</a> is <code>true</code>). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad88b597bf4ae11a65a9c87171239ed00"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setNotifyOnUpdate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool & </td>
|
|
<td class="paramname"><em>notify</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If <code>notify</code> is set to true, the <code>QSimpleUpdater</code> will notify the user when an update is available.</p>
|
|
<p>If <code>notify</code> is set to false, the <code>QSimpleUpdater</code> will not notify the user when an update is available. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a840a6b061590901eae3255ba74ff7ad8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setPlatformKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>platformKey</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Changes the platform key/id. This can be useful if the update depends on more than the underlying operating system on which the application runs. </p>
|
|
|
|
<p>References <a class="el" href="../../d3/d1d/class_updater.html#ad6d8a5d7b8fd9bdfde738d72c50f8bee">platformKey()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1219e9bb1c1fb0a68d757fbc0d9b76aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setUrl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>url</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Changes the <em>url</em> from where we download the update definitions </p>
|
|
|
|
<p>References <a class="el" href="../../d3/d1d/class_updater.html#a7ebf698a86619ebaadd2eb6e772f2a3d">url()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac3f35326fb62b9cf8a2421d91651ad60"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Updater::setUseCustomInstallProcedures </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool & </td>
|
|
<td class="paramname"><em>custom</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If <code>custom</code> is set to true, then the <a class="el" href="../../de/dc0/class_downloader.html">Downloader</a> will not attempt to open or install the downloaded updates. This can be useful if you want to implement your own install procedures using the <code><a class="el" href="../../d3/d1d/class_updater.html#a274a08240ad2bbea8cda6c52787510d3">downloadFinished()</a></code> signal. </p>
|
|
|
|
<p>References <a class="el" href="../../de/dc0/class_downloader.html#a26a4f889029c63c11f679284397a3285">Downloader::setUseCustomInstallProcedures()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aec889d582692cb41875ea803db3feb35"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Updater::updateAvailable </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns <code>true</code> if the updater found an updated version of the application/module online. </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7ebf698a86619ebaadd2eb6e772f2a3d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString Updater::url </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the AppCast URL (from which we extract the update definitions) </p>
|
|
|
|
<p>Referenced by <a class="el" href="../../d3/d1d/class_updater.html#a4af41658f974f72c71a9463be7bba1b5">checkForUpdates()</a>, <a class="el" href="../../d3/d1d/class_updater.html#a8da70f39cc193b94c64769fc6f40dc2c">setModuleVersion()</a>, and <a class="el" href="../../d3/d1d/class_updater.html#a1219e9bb1c1fb0a68d757fbc0d9b76aa">setUrl()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7860e1643f426dc4d62cec2cdf207cd5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Updater::useCustomInstallProcedures </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns <code>true</code> if the downloader will not attempt to install the downloaded file.</p>
|
|
<p>This can be useful if you want to use the <code><a class="el" href="../../d3/d1d/class_updater.html#a274a08240ad2bbea8cda6c52787510d3">downloadFinished()</a></code> signal to implement your own install procedures. </p>
|
|
|
|
<p>References <a class="el" href="../../de/dc0/class_downloader.html#a3e7a91a3cdfa68e3bc59db0af1377f9c">Downloader::useCustomInstallProcedures()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="../../dd/d30/_updater_8h_source.html">Updater.h</a></li>
|
|
<li>Updater.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|