|
3 | 3 |
|
4 | 4 | @brief Shows sample images for the updater for all the supported platforms |
5 | 5 |
|
| 6 | +Back to UpdaterController. |
| 7 | + |
6 | 8 | ## Windows - Windows 10 |
7 | 9 | #### The Updater Elements |
8 | 10 | @image html ./doc/images/win/dialog_ask.png "Ask Dialog"<br> |
@@ -74,11 +76,11 @@ to do is starting this controller. This can be done in 4 ways: |
74 | 76 | For a full collection of all immages, please go to the @ref image_page "Image Page" |
75 | 77 |
|
76 | 78 | ## Example |
77 | | -This example will show you the full capability of the controller. Since there is no |
| 79 | +This example will show you the basic capabilities of the controller. Since there is no |
78 | 80 | mainwindow in this example, you will only see the controller dialogs. Please not that |
79 | 81 | you can control how much of that dialogset will be shown to the user. This example is |
80 | 82 | reduced! for a full example with all parts of the controller, check the |
81 | | -Tests/WidegtsTest application. |
| 83 | +Tests/WidegtsTest application! |
82 | 84 |
|
83 | 85 | @attention Since this library requires the maintenancetool that is deployed with every |
84 | 86 | Qt Installer Framework installation, the examples cannot be tested without a |
@@ -115,3 +117,59 @@ int main(int argc, char *argv[]) |
115 | 117 | } |
116 | 118 | @endcode |
117 | 119 | */ |
| 120 | + |
| 121 | +/*! |
| 122 | +@property QtAutoUpdater::UpdateController::maintenanceToolPath |
| 123 | + |
| 124 | +@default{Updater::maintenanceToolPath} |
| 125 | + |
| 126 | +This property is simply the forewarded Updater::maintenanceToolPath. Check the |
| 127 | +documentation of that property for more details. |
| 128 | + |
| 129 | +@accessors{ |
| 130 | + @readAc{maintenanceToolPath()} |
| 131 | + @constantAc |
| 132 | + @finalAc |
| 133 | +} |
| 134 | + |
| 135 | +@sa Updater::maintenanceToolPath |
| 136 | +*/ |
| 137 | + |
| 138 | +/*! |
| 139 | +@property QtAutoUpdater::Updater::running |
| 140 | + |
| 141 | +@default{`false`} |
| 142 | + |
| 143 | +The controller can only run once at a time. If this property returns `true`, you will |
| 144 | +have to wait for it to finish to start it again. Please note that "running" includes |
| 145 | +not just that actual update check, but all the dialogs too. This means the Updater::running |
| 146 | +property of the attached updater can return `false` while this one returns `true`. |
| 147 | + |
| 148 | +@accessors{ |
| 149 | + @readAc{isRunning()} |
| 150 | + @notifyAc{runningChanged()} |
| 151 | +} |
| 152 | + |
| 153 | +@sa UpdateController::getUpdater, UpdateController::start, UpdateController::cancelUpdate |
| 154 | +*/ |
| 155 | + |
| 156 | +/*! |
| 157 | +@property QtAutoUpdater::Updater::runAsAdmin |
| 158 | + |
| 159 | +@default{`true`} |
| 160 | + |
| 161 | +Specifies whether the controller should run the updater (**not** the update check) as |
| 162 | +admin/root. If set `true`, the user will be prompted to allow this elevation (and enter |
| 163 | +his password). |
| 164 | + |
| 165 | +@note This property only specifies a "suggestion" to the user. If you want to disallow |
| 166 | +the user to change this, you will have to explicitly set it to be unchangable using |
| 167 | +the write accessor function of this property. |
| 168 | + |
| 169 | +@accessors{ |
| 170 | + @readAc{runAsAdmin()} |
| 171 | + @writeAc{setRunAsAdmin()} |
| 172 | +} |
| 173 | + |
| 174 | +@sa UpdateController::getUpdater, UpdateController::start, UpdateController::cancelUpdate |
| 175 | +*/ |
0 commit comments