-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstyling.html
737 lines (554 loc) · 41.9 KB
/
styling.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Styling — Edifice 3.2.2 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=84af4edc" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=dcedd534"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'styling';</script>
<link rel="icon" href="_static/EdificePyramid.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Extra Elements" href="extra.html" />
<link rel="prev" title="edifice.use_callback" href="stubs/edifice.use_callback.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/EdificePyramid.svg" class="logo__image only-light" alt="Edifice 3.2.2 documentation - Home"/>
<img src="_static/EdificePyramid.svg" class="logo__image only-dark pst-js-only" alt="Edifice 3.2.2 documentation - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorial.html">
Tutorial
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="examples.html">
Examples
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="api.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="developer_tools.html">
Developer Tools
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="versions.html">
Release Notes
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/pyedifice/pyedifice" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorial.html">
Tutorial
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="examples.html">
Examples
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="api.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="developer_tools.html">
Developer Tools
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="versions.html">
Release Notes
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/pyedifice/pyedifice" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="api.html" class="nav-link">API</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Styling</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="styling">
<h1>Styling<a class="headerlink" href="#styling" title="Link to this heading">#</a></h1>
<p>Edfice supports
<a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtwidgets-stylesheet-syntax.html">Qt Widget Style Sheet Syntax</a>.</p>
<p>The <code class="code docutils literal notranslate"><span class="pre">style</span></code> <strong>prop</strong> of every <a class="reference internal" href="base_components.html#module-edifice.base_components"><span class="std std-ref">Base Element</span></a>
is a dictionary of style properties.</p>
<p>The keys of the <code class="code docutils literal notranslate"><span class="pre">style</span></code> dictionary are the style name, and the values
are usually either strings or numbers.</p>
<p>For example, if you want to make a label with <em>10px</em> margins, with <em>red</em> text
in a <em>16pt</em> font on a <em>beige</em> <em>semi-transparent</em> background:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Label</span><span class="p">(</span>
<span class="s2">"Red text"</span><span class="p">,</span>
<span class="n">style</span><span class="o">=</span><span class="p">{</span>
<span class="s2">"margin"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
<span class="s2">"color"</span><span class="p">:</span> <span class="s2">"red"</span><span class="p">,</span>
<span class="s2">"font-size"</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span>
<span class="s2">"background-color"</span><span class="p">:</span> <span class="s2">"rgba(245, 245, 220, 100)"</span>
<span class="p">})</span>
</pre></div>
</div>
<p>All style properties supported by Qt will also work with Edifice.
See <a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtwidgets-stylesheet-reference.html#list-of-properties">Qt Stylesheet Reference List of Properties</a>.</p>
<p>Note that sometimes Qt styling behaves differently from CSS styling
(despite similar syntax and naming) and is not supported by all Widgets.</p>
<section id="content-base-element-styling">
<h2>Content Base Element Styling<a class="headerlink" href="#content-base-element-styling" title="Link to this heading">#</a></h2>
<p><a class="reference internal" href="base_components.html#content-base-elements"><span class="std std-ref">Content Base Elements</span></a> follow the
<a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtwidgets-stylesheet-customizing.html#the-box-model">Qt Style Sheet Box Model</a>.</p>
<p>The following style
<a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtwidgets-stylesheet-reference.html#list-of-properties">properties</a>
are tested to be supported.</p>
<ul class="simple">
<li><p><strong>color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> (See <a class="reference internal" href="#color"><span class="std std-ref">Color</span></a>) Text color.</p></li>
<li><p><strong>font-size</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Font size.</p></li>
<li><p><strong>font-weight</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Font weight.</p></li>
<li><p><strong>font-family</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> Font family name.</p></li>
<li><p><strong>font-style</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> Font style, i.e. <code class="code docutils literal notranslate"><span class="pre">"italic"</span></code>.</p></li>
<li><p><strong>background-color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> (See <a class="reference internal" href="#color"><span class="std std-ref">Color</span></a>) Background color.</p></li>
<li><p><strong>margin</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Exterior margin in pixels.</p>
<ul>
<li><p><strong>margin-left</strong>, <strong>margin-right</strong>, <strong>margin-top</strong>, <strong>margin-bottom</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Exterior margin in pixels.</p></li>
</ul>
</li>
<li><p><strong>padding</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Interior padding in pixels.</p>
<ul>
<li><p><strong>padding-left</strong>, <strong>padding-right</strong>, <strong>padding-top</strong>, <strong>padding-bottom</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Interior padding in pixels.</p></li>
</ul>
</li>
<li><p><strong>border</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> For example <code class="code docutils literal notranslate"><span class="pre">"1px</span> <span class="pre">solid</span> <span class="pre">red"</span></code></p>
<ul>
<li><p><strong>border-left</strong>, <strong>border-right</strong>, <strong>border-top</strong>, <strong>border-bottom</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> For example <code class="code docutils literal notranslate"><span class="pre">"1px</span> <span class="pre">solid</span> <span class="pre">red"</span></code></p></li>
<li><p><strong>border-width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border width in pixels.</p>
<ul>
<li><p><strong>border-left-width</strong>, <strong>border-right-width</strong>, <strong>border-top-width</strong>, <strong>border-bottom-width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border width in pixels.</p></li>
</ul>
</li>
<li><p><strong>border-style</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> Border style.</p>
<ul>
<li><p><strong>border-left-style</strong>, <strong>border-right-style</strong>, <strong>border-top-style</strong>, <strong>border-bottom-style</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> Border style.</p></li>
</ul>
</li>
<li><p><strong>border-color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> (See <a class="reference internal" href="#color"><span class="std std-ref">Color</span></a>) Border color.</p>
<ul>
<li><p><strong>border-left-color</strong>, <strong>border-right-color</strong>, <strong>border-top-color</strong>, <strong>border-bottom-color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> (See <a class="reference internal" href="#color"><span class="std std-ref">Color</span></a>) Border color.</p></li>
</ul>
</li>
<li><p><strong>border-radius</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border corner radius in pixels.</p>
<ul>
<li><p><strong>border-top-left-radius</strong>, <strong>border-top-right-radius</strong>, <strong>border-bottom-right-radius</strong>, <strong>border-bottom-left-radius</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border corner radius in pixels.</p></li>
</ul>
</li>
</ul>
</li>
<li><p><strong>height</strong>, <strong>width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Height/width in pixels.</p></li>
<li><p><strong>min-height</strong>, <strong>max-height</strong>, <strong>min-width</strong>, <strong>max-width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Min/max height/width in pixels.</p></li>
<li><p><strong>align</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">AlignmentFlag</span></code> One of <code class="code docutils literal notranslate"><span class="pre">"left</span></code>, <code class="code docutils literal notranslate"><span class="pre">"right"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"top"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"bottom"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"center"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"justify"</span></code>.
Or an <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtCore/Qt.html#PySide6.QtCore.Qt.AlignmentFlag">AlignmentFlag</a>.</p></li>
<li><p><strong>top</strong>, <strong>left</strong> (but not bottom, right): <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Position offset in pixels from a
<a class="reference internal" href="stubs/edifice.FixView.html#edifice.FixView" title="edifice.FixView"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixView</span></code></a>.</p></li>
</ul>
</section>
<section id="layout-base-element-styling">
<h2>Layout Base Element Styling<a class="headerlink" href="#layout-base-element-styling" title="Link to this heading">#</a></h2>
<p>Every <a class="reference internal" href="base_components.html#layout-base-elements"><span class="std std-ref">Layout Base Element</span></a> has an underlying
<a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QLayout.html">QLayout</a>
and follows slightly different rules than the
<a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtwidgets-stylesheet-customizing.html#the-box-model">Qt Style Sheet Box Model</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>There is no <code class="code docutils literal notranslate"><span class="pre">margin</span></code> style for Layout <code class="code docutils literal notranslate"><span class="pre">View</span></code> Elements.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The padding of a <code class="code docutils literal notranslate"><span class="pre">View</span></code> includes the border, so
if you want a <em>2px</em> border around the <code class="code docutils literal notranslate"><span class="pre">View</span></code> then you should also
set at least <em>2px</em> of padding so that the content does not obscure the border.</p>
</div>
<p>The following style
<a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtwidgets-stylesheet-reference.html#list-of-properties">properties</a>
are tested to be supported.</p>
<ul class="simple">
<li><p><strong>background-color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> (See <a class="reference internal" href="#color"><span class="std std-ref">Color</span></a>) Background color.</p></li>
<li><p><strong>padding</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Interior padding in pixels.</p>
<ul>
<li><p><strong>padding-left</strong>, <strong>padding-right</strong>, <strong>padding-top</strong>, <strong>padding-bottom</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Interior padding in pixels.</p></li>
</ul>
</li>
<li><p><strong>border</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> For example <code class="code docutils literal notranslate"><span class="pre">"1px</span> <span class="pre">solid</span> <span class="pre">red"</span></code></p>
<ul>
<li><p><strong>border-left</strong>, <strong>border-right</strong>, <strong>border-top</strong>, <strong>border-bottom</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> For example <code class="code docutils literal notranslate"><span class="pre">"1px</span> <span class="pre">solid</span> <span class="pre">red"</span></code></p></li>
<li><p><strong>border-width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border width in pixels.</p>
<ul>
<li><p><strong>border-left-width</strong>, <strong>border-right-width</strong>, <strong>border-top-width</strong>, <strong>border-bottom-width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border width in pixels.</p></li>
</ul>
</li>
<li><p><strong>border-style</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> Border style.</p>
<ul>
<li><p><strong>border-left-style</strong>, <strong>border-right-style</strong>, <strong>border-top-style</strong>, <strong>border-bottom-style</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span></code> Border style.</p></li>
</ul>
</li>
<li><p><strong>border-color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> (See <a class="reference internal" href="#color"><span class="std std-ref">Color</span></a>) Border color.</p>
<ul>
<li><p><strong>border-left-color</strong>, <strong>border-right-color</strong>, <strong>border-top-color</strong>, <strong>border-bottom-color</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">QColor</span></code> Border color.</p></li>
</ul>
</li>
<li><p><strong>border-radius</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border corner radius in pixels.</p>
<ul>
<li><p><strong>border-top-left-radius</strong>, <strong>border-top-right-radius</strong>, <strong>border-bottom-right-radius</strong>, <strong>border-bottom-left-radius</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Border corner radius in pixels.</p></li>
</ul>
</li>
</ul>
</li>
<li><p><strong>height</strong>, <strong>width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Height/width in pixels.</p></li>
<li><p><strong>min-height</strong>, <strong>max-height</strong>, <strong>min-width</strong>, <strong>max-width</strong>: <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Min/max height/width in pixels.</p></li>
<li><p><strong>align</strong>: <code class="code docutils literal notranslate"><span class="pre">str</span> <span class="pre">|</span> <span class="pre">AlignmentFlag</span></code> One of <code class="code docutils literal notranslate"><span class="pre">"left</span></code>, <code class="code docutils literal notranslate"><span class="pre">"right"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"top"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"bottom"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"center"</span></code>, <code class="code docutils literal notranslate"><span class="pre">"justify"</span></code>.
Or an <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtCore/Qt.html#PySide6.QtCore.Qt.AlignmentFlag">AlignmentFlag</a>.</p></li>
<li><p><strong>top</strong>, <strong>left</strong> (but not bottom, right): <code class="code docutils literal notranslate"><span class="pre">int</span> <span class="pre">|</span> <span class="pre">float</span></code> Position offset in pixels from a
<a class="reference internal" href="stubs/edifice.FixView.html#edifice.FixView" title="edifice.FixView"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixView</span></code></a>.</p></li>
</ul>
</section>
<section id="color">
<h2>Color<a class="headerlink" href="#color" title="Link to this heading">#</a></h2>
<p>There are two ways to specify a style value which takes a single color:</p>
<ul class="simple">
<li><p>A <code class="code docutils literal notranslate"><span class="pre">str</span></code> with any of the formats allowed by
<a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtGui/QColor.html#PySide6.QtGui.QColor.fromString">QColor.fromString</a>,
for example:</p>
<ul>
<li><p><code class="code docutils literal notranslate"><span class="pre">"rgba(red,</span> <span class="pre">green,</span> <span class="pre">blue,</span> <span class="pre">alpha)"</span></code> decimal range <em>0–255</em></p></li>
<li><p>Named colors like <code class="code docutils literal notranslate"><span class="pre">"red"</span></code></p></li>
<li><p>Hexadecimal <code class="code docutils literal notranslate"><span class="pre">"#rrggbb"</span></code></p></li>
<li><p>Hexadecimal <code class="code docutils literal notranslate"><span class="pre">"#aarrggbb"</span></code></p></li>
</ul>
</li>
<li><p>A <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtGui/QColor.html">QColor</a>.</p></li>
</ul>
</section>
<section id="graphics-effects">
<h2>Graphics Effects<a class="headerlink" href="#graphics-effects" title="Link to this heading">#</a></h2>
<p>Edifice styles support the four stock <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QGraphicsEffect.html">QGraphicsEffect</a>
effects for any <a class="reference internal" href="base_components.html#module-edifice.base_components"><span class="std std-ref">Base Element</span></a>.</p>
<figure class="align-center">
<img alt="Graphics Effects" src="_images/graphics_effects.png" />
</figure>
<p>Each effect style has a different set of parameters.</p>
<ul>
<li><p><strong>blur</strong>: <code class="code docutils literal notranslate"><span class="pre">float</span></code> The blur radius in pixels.</p>
<p>See <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QGraphicsBlurEffect.html">QGraphicsBlurEffect</a>.</p>
</li>
<li><p><strong>drop-shadow</strong>: <code class="code docutils literal notranslate"><span class="pre">tuple[float,</span> <span class="pre">QColor,</span> <span class="pre">QPointF]</span></code></p>
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">float</span></code> The blur radius in pixels.</p></li>
<li><p><a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtGui/QColor.html">QColor</a> Shadow color.</p></li>
<li><p><a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtCore/QPointF.html">QPointF</a> Shadow offset.</p></li>
</ul>
<div class="literal-block-wrapper docutils container" id="id6">
<div class="code-block-caption"><span class="caption-text">Example drop-shadow</span><a class="headerlink" href="#id6" title="Link to this code">#</a></div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span> <span class="n">style</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"drop-shadow"</span><span class="p">:</span> <span class="p">(</span><span class="mf">10.0</span><span class="p">,</span> <span class="n">QColor</span><span class="p">(</span><span class="s2">"black"</span><span class="p">),</span> <span class="n">QPointF</span><span class="p">(</span><span class="o">-</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">5.0</span><span class="p">)),</span>
<span class="p">},</span>
</pre></div>
</div>
</div>
<p>See <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QGraphicsDropShadowEffect.html">QGraphicsDropShadowEffect</a>.</p>
</li>
<li><p><strong>colorize</strong>: <code class="code docutils literal notranslate"><span class="pre">tuple[QColor,</span> <span class="pre">float]</span></code></p>
<ul class="simple">
<li><p><a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtGui/QColor.html">QColor</a> Tint color.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">float</span></code> The strength of the colorization.</p></li>
</ul>
<p>See <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QGraphicsColorizeEffect.html">QGraphicsColorizeEffect</a>.</p>
</li>
<li><p><strong>opacity</strong>: <code class="code docutils literal notranslate"><span class="pre">float</span></code> The opacity of the widget.</p>
<p>See <a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QGraphicsOpacityEffect.html">QGraphicsOpacityEffect</a>.</p>
</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to limitations in the Qt API, only one graphic effect can be applied to
a <a class="reference internal" href="base_components.html#module-edifice.base_components"><span class="std std-ref">Base Element</span></a> at a time.</p>
</div>
</section>
<section id="size-policy">
<h2>Size Policy<a class="headerlink" href="#size-policy" title="Link to this heading">#</a></h2>
<p>The <code class="code docutils literal notranslate"><span class="pre">size_policy</span></code> <strong>prop</strong> of <a class="reference internal" href="stubs/edifice.QtWidgetElement.html#edifice.QtWidgetElement" title="edifice.QtWidgetElement"><code class="xref py py-class docutils literal notranslate"><span class="pre">QtWidgetElement</span></code></a> is also
sometimes useful for controlling the Qt layout behavior.</p>
</section>
<section id="style-merging">
<h2>Style Merging<a class="headerlink" href="#style-merging" title="Link to this heading">#</a></h2>
<p>If you want to make all <a class="reference internal" href="stubs/edifice.Label.html#edifice.Label" title="edifice.Label"><code class="xref py py-class docutils literal notranslate"><span class="pre">Labels</span></code></a> be <em>red</em> but have labels of different
font sizes, you can create a common style dict for shared styles…</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">LABEL_STYLE</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"color"</span><span class="p">:</span> <span class="s2">"red"</span>
<span class="s2">"font-size"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span> <span class="c1"># Default font size</span>
<span class="s2">"background-color"</span><span class="p">:</span> <span class="s2">"rgba(245, 245, 220, 100)"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
<p>…and adjust the common style dict with <code class="code docutils literal notranslate"><span class="pre">|</span></code>, the
<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#mapping-types-dict">Python dictionary merge operator</a>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">VBoxView</span><span class="p">():</span>
<span class="n">Label</span><span class="p">(</span><span class="s2">"foo"</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="n">LABEL_STYLE</span> <span class="o">|</span> <span class="p">{</span><span class="s2">"font-size"</span><span class="p">:</span> <span class="mi">16</span><span class="p">})</span>
<span class="n">Label</span><span class="p">(</span><span class="s2">"foo"</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="n">LABEL_STYLE</span><span class="p">)</span>
<span class="n">Label</span><span class="p">(</span><span class="s2">"foo"</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="n">LABEL_STYLE</span> <span class="o">|</span> <span class="p">{</span><span class="s2">"font-size"</span><span class="p">:</span> <span class="mi">8</span><span class="p">})</span>
</pre></div>
</div>
</section>
<section id="global-style">
<h2>Global Style<a class="headerlink" href="#global-style" title="Link to this heading">#</a></h2>
<p>Set global application styles in a root Element
<a class="reference internal" href="stubs/edifice.use_memo.html#edifice.use_memo" title="edifice.use_memo"><code class="xref py py-func docutils literal notranslate"><span class="pre">use_memo</span></code></a> <strong>initializer function</strong>.
For more information see <a class="reference internal" href="stubs/edifice.App.html#edifice.App" title="edifice.App"><code class="xref py py-class docutils literal notranslate"><span class="pre">App</span></code></a>.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QApplication.html#PySide6.QtWidgets.QApplication.setStyleSheet">QApplication.setStyleSheet</a></p></li>
<li><p><a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QApplication.html#PySide6.QtWidgets.QApplication.setStyle">QApplication.setStyle</a></p></li>
</ul>
<p>If you think that Qt’s default color palette has weird choices, you can try
the Edifice color palettes
<a class="reference internal" href="utilities.html#edifice.palette_edifice_light" title="edifice.palette_edifice_light"><code class="xref py py-func docutils literal notranslate"><span class="pre">palette_edifice_light</span></code></a> and
<a class="reference internal" href="utilities.html#edifice.palette_edifice_dark" title="edifice.palette_edifice_dark"><code class="xref py py-func docutils literal notranslate"><span class="pre">palette_edifice_dark</span></code></a>.
See <a class="reference internal" href="utilities.html#edifice.theme_is_light" title="edifice.theme_is_light"><code class="xref py py-func docutils literal notranslate"><span class="pre">theme_is_light</span></code></a> for instructions
on how to use them.</p>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="stubs/edifice.use_callback.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">edifice.use_callback</p>
</div>
</a>
<a class="right-next"
href="extra.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Extra Elements</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#content-base-element-styling">Content Base Element Styling</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#layout-base-element-styling">Layout Base Element Styling</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#color">Color</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#graphics-effects">Graphics Effects</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#size-policy">Size Policy</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#style-merging">Style Merging</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#global-style">Global Style</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>