progress_bar
Determinate and indeterminate progress bar drawn in the AYON style.
AYProgressBar
Bases: StyleMixin, QWidget
Determinate and indeterminate progress bar in the AYON style.
The bar is empty while maximum is 0, and indeterminate (a sweeping chunk) while value or maximum is negative.
By default the percentage is drawn right of the track. Its space is reserved also while indeterminate, so the track does not change width when the text appears or disappears. Pass show_value=False for a bar without text.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent | QWidget | None | Parent widget. | None |
maximum | int | Value that represents a full bar. | 0 |
variant | AYProgressBarVariants | Visual style variant. | Default |
show_value | bool | Whether the percentage is drawn next to the track. | True |
Signals
value_changed (int): Current value. maximum_changed (int): Current maximum.
Source code in client/ayon_core/ui/components/progress_bar.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | |
is_animating()
True while the indeterminate sweep timer is running.
Source code in client/ayon_core/ui/components/progress_bar.py
146 147 148 | |
is_indeterminate()
True while the progress cannot be shown as a fraction.
Source code in client/ayon_core/ui/components/progress_bar.py
142 143 144 | |
maximum()
Return the value that represents a full bar.
Source code in client/ayon_core/ui/components/progress_bar.py
109 110 111 | |
minimumSizeHint()
Return the minimum size derived from the style height.
Source code in client/ayon_core/ui/components/progress_bar.py
336 337 338 339 340 341 | |
paintEvent(event)
Paint the track, the chunk, and the optional percentage.
Descriptive text, such as a caption, belongs to the owner.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event | QPaintEvent | The paint event; the whole widget is repainted. | required |
Source code in client/ayon_core/ui/components/progress_bar.py
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | |
percentage()
Return the completion percentage in the 0.0-100.0 range.
Source code in client/ayon_core/ui/components/progress_bar.py
150 151 152 153 154 155 | |
set_maximum(value)
Set the full-bar value, negative makes the bar indeterminate.
Source code in client/ayon_core/ui/components/progress_bar.py
122 123 124 125 126 127 128 129 | |
set_show_value(show_value)
Set whether the percentage is drawn next to the track.
Source code in client/ayon_core/ui/components/progress_bar.py
167 168 169 170 171 172 173 | |
set_state(state)
Set the semantic state used to colour the chunk.
Source code in client/ayon_core/ui/components/progress_bar.py
135 136 137 138 139 140 | |
set_value(value)
Set the current value, negative makes the bar indeterminate.
Source code in client/ayon_core/ui/components/progress_bar.py
113 114 115 116 117 118 119 120 | |
show_value()
Return whether the percentage is drawn next to the track.
Source code in client/ayon_core/ui/components/progress_bar.py
163 164 165 | |
sizeHint()
Return the preferred size derived from the style height.
Source code in client/ayon_core/ui/components/progress_bar.py
328 329 330 331 332 333 334 | |
state()
Return the semantic state used to colour the chunk.
Source code in client/ayon_core/ui/components/progress_bar.py
131 132 133 | |
text()
Return the percentage text, empty while indeterminate.
Source code in client/ayon_core/ui/components/progress_bar.py
157 158 159 160 161 | |
value()
Return the current value.
Source code in client/ayon_core/ui/components/progress_bar.py
105 106 107 | |
ProgressBarState
Bases: Enum
Semantic state controlling the colour of the filled chunk.
Source code in client/ayon_core/ui/components/progress_bar.py
23 24 25 26 27 28 29 | |