page_button
AYPageButton component module.
Provides a full-width navigation/settings row button with the layout::
[icon] Label text ........................ Value text >
The left cluster (icon + label) is pinned left; the right cluster (value + chevron) is pinned right. A flexible gap fills the space between them. Default size policy is Expanding × Fixed.
AYPageButton
Bases: AYButton
Full-width navigation/settings page button.
Renders a single-row entry with a left cluster (optional icon + label text) pinned to the left and a right cluster (value text + chevron) pinned to the right. A flexible gap fills the remaining horizontal space.
The visual style is driven by the "AYPageButton" block in ayon_style.json. All painting is done in a custom paintEvent; the Qt button bevel is not used.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
label | str | Text displayed in the left cluster. | '' |
value | str | Secondary text displayed in the right cluster (before the chevron). Pass an empty string to hide it. | '' |
variant | AYPageButtonVariants | Visual variant. Only | Default |
icon | str | None | Material Symbol icon name for the left icon (optional). | None |
icon_size | int | Pixel size of the left icon. | 16 |
chevron_icon | str | Material Symbol name for the right-hand chevron. | 'chevron_right' |
chevron_size | int | Pixel size of the chevron icon. | 16 |
tooltip | str | Tooltip text. | '' |
name_id | str |
| '' |
**kwargs | Forwarded to | {} |
Signals
clicked (bool): Inherited from QPushButton.
Example::
btn = AYPageButton(
label="Featured version",
value="Done",
icon="star",
)
btn.clicked.connect(lambda: print("navigating …"))
Source code in client/ayon_ui_qt/components/page_button.py
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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 | |
__init__(label='', value='', *, variant=AYPageButtonVariants.Default, icon=None, icon_size=16, chevron_icon='chevron_right', chevron_size=16, tooltip='', name_id='', **kwargs)
Initialize an AYPageButton.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
label | str | Left-cluster label text. | '' |
value | str | Right-cluster value text (optional). | '' |
variant | AYPageButtonVariants | Visual variant (only | Default |
icon | str | None | Material Symbol name for the left icon. | None |
icon_size | int | Pixel size for the left icon. | 16 |
chevron_icon | str | Material Symbol name for the chevron. | 'chevron_right' |
chevron_size | int | Pixel size for the chevron icon. | 16 |
tooltip | str | Tooltip string shown on hover. | '' |
name_id | str | Widget | '' |
**kwargs | Extra keyword arguments forwarded to | {} |
Source code in client/ayon_ui_qt/components/page_button.py
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 | |
paintEvent(arg__1)
Render the full-width page button.
Draws background, left cluster (icon + label), and right cluster (value + chevron) using QPainter directly. No Qt bevel or QStyle.drawControl is used.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event | The paint event (unused — the full widget is redrawn). | required |
Source code in client/ayon_ui_qt/components/page_button.py
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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 | |
set_force_hover(value)
Force (or release) the hover appearance for snapshot tests.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value | bool |
| required |
Source code in client/ayon_ui_qt/components/page_button.py
211 212 213 214 215 216 217 218 219 | |
set_label(text)
Update the left-cluster label text and repaint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text | str | New label string. | required |
Source code in client/ayon_ui_qt/components/page_button.py
202 203 204 205 206 207 208 209 | |
set_value(text)
Update the right-cluster value text and repaint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text | str | New value string (empty string hides the value field). | required |
Source code in client/ayon_ui_qt/components/page_button.py
193 194 195 196 197 198 199 200 | |
sizeHint()
Return the preferred size of the widget.
Returns:
| Type | Description |
|---|---|
QSize | A |
Source code in client/ayon_ui_qt/components/page_button.py
225 226 227 228 229 230 231 232 233 | |
value()
Return the current right-cluster value text.
Returns:
| Type | Description |
|---|---|
str | The value string set at construction or via |
Source code in client/ayon_ui_qt/components/page_button.py
185 186 187 188 189 190 191 | |