lace-dock 0.2.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lace_dock-0.2.5/LICENSE +236 -0
- lace_dock-0.2.5/NOTICE +42 -0
- lace_dock-0.2.5/PKG-INFO +272 -0
- lace_dock-0.2.5/README.md +245 -0
- lace_dock-0.2.5/lace/__init__.py +239 -0
- lace_dock-0.2.5/lace/_trace.py +23 -0
- lace_dock-0.2.5/lace/dock_area_layout.py +129 -0
- lace_dock-0.2.5/lace/dock_area_tab_bar.py +396 -0
- lace_dock-0.2.5/lace/dock_area_title_bar.py +660 -0
- lace_dock-0.2.5/lace/dock_area_widget.py +447 -0
- lace_dock-0.2.5/lace/dock_chrome.py +237 -0
- lace_dock-0.2.5/lace/dock_colors.py +19 -0
- lace_dock-0.2.5/lace/dock_container_state.py +186 -0
- lace_dock-0.2.5/lace/dock_container_widget.py +897 -0
- lace_dock-0.2.5/lace/dock_context_menu.py +30 -0
- lace_dock-0.2.5/lace/dock_custom_theme.py +282 -0
- lace_dock-0.2.5/lace/dock_icon_provider.py +258 -0
- lace_dock-0.2.5/lace/dock_manager.py +635 -0
- lace_dock-0.2.5/lace/dock_menu.py +417 -0
- lace_dock-0.2.5/lace/dock_overlay.py +415 -0
- lace_dock-0.2.5/lace/dock_paint.py +335 -0
- lace_dock-0.2.5/lace/dock_signals.py +29 -0
- lace_dock-0.2.5/lace/dock_splitter.py +134 -0
- lace_dock-0.2.5/lace/dock_style_manager.py +209 -0
- lace_dock-0.2.5/lace/dock_styled.py +60 -0
- lace_dock-0.2.5/lace/dock_theme.py +910 -0
- lace_dock-0.2.5/lace/dock_theme_bridge.py +151 -0
- lace_dock-0.2.5/lace/dock_widget.py +628 -0
- lace_dock-0.2.5/lace/dock_widget_tab.py +640 -0
- lace_dock-0.2.5/lace/eliding_label.py +93 -0
- lace_dock-0.2.5/lace/enums.py +267 -0
- lace_dock-0.2.5/lace/floating_dock_container.py +896 -0
- lace_dock-0.2.5/lace/layout_serializer.py +546 -0
- lace_dock-0.2.5/lace/resources/lace_icons/close.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/close_others.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/close_tab.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/dock.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/float.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/maximize.svg +49 -0
- lace_dock-0.2.5/lace/resources/lace_icons/pin.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/pin_all.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/restore.svg +54 -0
- lace_dock-0.2.5/lace/resources/lace_icons/tab_list.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/tabs_menu.svg +1 -0
- lace_dock-0.2.5/lace/resources/lace_icons/unpin.svg +1 -0
- lace_dock-0.2.5/lace/sidebar_container.py +729 -0
- lace_dock-0.2.5/lace/sidebar_manager.py +926 -0
- lace_dock-0.2.5/lace/sidebar_tab.py +293 -0
- lace_dock-0.2.5/lace/sidebar_tab_bar.py +640 -0
- lace_dock-0.2.5/lace/sidebar_title_bar.py +375 -0
- lace_dock-0.2.5/lace/theme_manager.py +213 -0
- lace_dock-0.2.5/lace/util.py +147 -0
- lace_dock-0.2.5/lace_dock.egg-info/PKG-INFO +272 -0
- lace_dock-0.2.5/lace_dock.egg-info/SOURCES.txt +57 -0
- lace_dock-0.2.5/lace_dock.egg-info/dependency_links.txt +1 -0
- lace_dock-0.2.5/lace_dock.egg-info/requires.txt +1 -0
- lace_dock-0.2.5/lace_dock.egg-info/top_level.txt +1 -0
- lace_dock-0.2.5/pyproject.toml +46 -0
- lace_dock-0.2.5/setup.cfg +4 -0
lace_dock-0.2.5/LICENSE
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
|
203
|
+
--------------------------------------------------------------------------------
|
|
204
|
+
|
|
205
|
+
This project incorporates components from the following projects:
|
|
206
|
+
|
|
207
|
+
Project: qtpydocking
|
|
208
|
+
BSD 3-Clause License
|
|
209
|
+
|
|
210
|
+
Copyright (c) 2019, Ken Lauer
|
|
211
|
+
All rights reserved.
|
|
212
|
+
|
|
213
|
+
Redistribution and use in source and binary forms, with or without
|
|
214
|
+
modification, are permitted provided that the following conditions are met:
|
|
215
|
+
|
|
216
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
217
|
+
list of conditions and the following disclaimer.
|
|
218
|
+
|
|
219
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
220
|
+
this list of conditions and the following disclaimer in the documentation
|
|
221
|
+
and/or other materials provided with the distribution.
|
|
222
|
+
|
|
223
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
224
|
+
contributors may be used to endorse or promote products derived from
|
|
225
|
+
this software without specific prior written permission.
|
|
226
|
+
|
|
227
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
228
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
229
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
230
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
231
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
232
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
233
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
234
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
235
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
236
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
lace_dock-0.2.5/NOTICE
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
Lace: Advanced PySide6 Docking System
|
|
2
|
+
Copyright (c) 2026 opticsWolf
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
SPDX-License-Identifier: Apache-2.0
|
|
7
|
+
|
|
8
|
+
--------------------------------------------------------------------------------
|
|
9
|
+
|
|
10
|
+
This project includes code from qtpydocking.
|
|
11
|
+
qtpydocking (https://github.com/klauer/qtpydocking)
|
|
12
|
+
SPDX-License-Identifier: BSD-3-Clause
|
|
13
|
+
|
|
14
|
+
The original code from qtpydocking is licensed under the following terms:
|
|
15
|
+
|
|
16
|
+
Copyright (c) 2019, K Lauer
|
|
17
|
+
All rights reserved.
|
|
18
|
+
|
|
19
|
+
Redistribution and use in source and binary forms, with or without
|
|
20
|
+
modification, are permitted provided that the following conditions are met:
|
|
21
|
+
|
|
22
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
23
|
+
list of conditions and the following disclaimer.
|
|
24
|
+
|
|
25
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
26
|
+
this list of conditions and the following disclaimer in the documentation
|
|
27
|
+
and/or other materials provided with the distribution.
|
|
28
|
+
|
|
29
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
30
|
+
contributors may be used to endorse or promote products derived from
|
|
31
|
+
this software without specific prior written permission.
|
|
32
|
+
|
|
33
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
34
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
35
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
36
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
37
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
38
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
39
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
40
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
41
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
42
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
lace_dock-0.2.5/PKG-INFO
ADDED
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: lace-dock
|
|
3
|
+
Version: 0.2.5
|
|
4
|
+
Summary: Advanced PySide6 docking system
|
|
5
|
+
Author-email: opticsWolf <opticswolf@protonmail.com>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/opticsWolf/Lace
|
|
8
|
+
Project-URL: Documentation, https://github.com/opticsWolf/Lace#readme
|
|
9
|
+
Project-URL: Repository, https://github.com/opticsWolf/Lace
|
|
10
|
+
Project-URL: Issues, https://github.com/opticsWolf/Lace/issues
|
|
11
|
+
Project-URL: Changelog, https://github.com/opticsWolf/Lace/releases
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Topic :: Software Development :: User Interfaces
|
|
20
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
License-File: NOTICE
|
|
25
|
+
Requires-Dist: pyside6
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
|
|
28
|
+
# Lace
|
|
29
|
+
|
|
30
|
+
**Advanced docking system for PySide6** — a feature-rich, themeable widget layout framework for building professional Qt desktop applications in Python.
|
|
31
|
+
|
|
32
|
+
**Version:** 0.2.5
|
|
33
|
+
|
|
34
|
+
[](https://pypi.org/project/lace-dock/)
|
|
35
|
+
[](https://pypi.org/project/lace-dock/)
|
|
36
|
+
[](https://github.com/opticsWolf/Lace/actions/workflows/publish.yml)
|
|
37
|
+
[](https://www.python.org/downloads/)
|
|
38
|
+
[](https://pypi.org/project/PySide6/)
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Table of Contents
|
|
43
|
+
|
|
44
|
+
- [Features](#features)
|
|
45
|
+
- [Quick Start](#quick-start)
|
|
46
|
+
- [Screenshots](#screenshots)
|
|
47
|
+
- [Architecture Overview](#architecture-overview)
|
|
48
|
+
- [Documentation](#documentation)
|
|
49
|
+
- [Contributing](#contributing)
|
|
50
|
+
- [License](#license)
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Features
|
|
55
|
+
|
|
56
|
+
### 🪑 Docking & Layout
|
|
57
|
+
|
|
58
|
+
- **Multi-area docking** — Dock widgets to left, right, top, bottom, or center regions within a window
|
|
59
|
+
- **Tabbed dock areas** — Multiple widgets share a single dock area as tabs, with full tab management (reorder, close, float)
|
|
60
|
+
- **Floating windows** — Detach any dock widget into its own top-level window; drag it back to dock
|
|
61
|
+
- **Drag-and-drop layout** — Intuitive resize, re-order, and re-dock via visual drop indicators
|
|
62
|
+
- **Nested splitters** — Arbitrary nesting of horizontal and vertical split panes
|
|
63
|
+
- **Maximize/restore** — Expand any dock area to fill its container
|
|
64
|
+
|
|
65
|
+
### 📌 Sidebars
|
|
66
|
+
|
|
67
|
+
- **Auto-hide panels** — VS Code-style slide-out sidebars that appear on hover
|
|
68
|
+
- **Pinned widgets** — Pin dock widgets to sidebars with visual tab buttons
|
|
69
|
+
- **Notification badges** — Numerical or symbolic badges on sidebar tabs
|
|
70
|
+
- **Configurable focus behavior** — Choose whether sidebars steal keyboard focus
|
|
71
|
+
- **Drag to detach** — Tear pinned widgets out of sidebars back into the main layout
|
|
72
|
+
|
|
73
|
+
### 🎨 Theming
|
|
74
|
+
|
|
75
|
+
- **14 built-in themes** — Dark, light, midnight, warm, nordic, monokai, neutral, tokyo_night, catppuccin, dracula, solarized_dark/light, and cyberpunk_neon
|
|
76
|
+
- **Declarative `ThemeSpec`** — Define custom themes with color palettes and geometrical tokens (corner radius, border width, title height, tab radius, content margin, etc.)
|
|
77
|
+
- **Reactive borders** — Active dock area shows a vibrant focus border; inactive areas show a subtle neutral border
|
|
78
|
+
- **OS auto-sync** — Automatically switch between light/dark themes when the OS changes
|
|
79
|
+
- **Custom QSS/stylesheet support** — Point themes to external `.qss` or `.css` files
|
|
80
|
+
|
|
81
|
+
### ⚙️ Configuration
|
|
82
|
+
|
|
83
|
+
- **16 global flags** — Control tab visibility, button visibility, drag behavior, floating window chrome, icon styling, and more
|
|
84
|
+
- **Per-widget feature flags** — Granular control over what each dock widget can do: closable, movable, floatable, pinnable
|
|
85
|
+
- **Insertion order** — Sort "Show View" menu items alphabetically or chronologically
|
|
86
|
+
- **Toggle view actions** — Integrate dock widget show/hide into menu bars or toolbars as checkable toggles or one-way show buttons
|
|
87
|
+
|
|
88
|
+
### 💾 Persistence
|
|
89
|
+
|
|
90
|
+
- **JSON layout serialization** — Save and restore complete window layouts to/from JSON files
|
|
91
|
+
- **Perspectives** — Save named layout presets (e.g., "Coding Mode", "Presentation Mode") and switch between them instantly
|
|
92
|
+
- **Atomic file I/O** — Layouts are written atomically (temp file + rename) to prevent corruption
|
|
93
|
+
|
|
94
|
+
### 🎯 Icons & Chrome
|
|
95
|
+
|
|
96
|
+
- **SVG-based icon system** — Theme-aware SVG icons with automatic color tinting
|
|
97
|
+
- **Custom icon provider** — Register a directory of SVG icons for use across tabs and menus
|
|
98
|
+
- **Painted chrome** — Custom-drawn title bars, tab buttons, splitter handles, and drop indicators with rounded corners and hover states
|
|
99
|
+
- **Chromeless floating windows** — Optional frameless floating windows that rely entirely on Lace's custom title bar
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Quick Start
|
|
104
|
+
|
|
105
|
+
### Installation
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
pip install pyside6
|
|
109
|
+
# Clone Lace
|
|
110
|
+
git clone https://github.com/yourusername/lace.git
|
|
111
|
+
cd lace
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Minimal Example
|
|
115
|
+
|
|
116
|
+
```python
|
|
117
|
+
import sys
|
|
118
|
+
from PySide6.QtWidgets import QApplication, QMainWindow, QTextEdit
|
|
119
|
+
from lace import DockManager, DockWidget, DockWidgetArea, apply_dock_theme
|
|
120
|
+
|
|
121
|
+
app = QApplication(sys.argv)
|
|
122
|
+
app.setStyle("Fusion")
|
|
123
|
+
|
|
124
|
+
window = QMainWindow()
|
|
125
|
+
window.setWindowTitle("My App")
|
|
126
|
+
window.resize(1200, 800)
|
|
127
|
+
|
|
128
|
+
# Create the dock manager
|
|
129
|
+
dock_manager = DockManager(window)
|
|
130
|
+
window.setCentralWidget(dock_manager._root)
|
|
131
|
+
|
|
132
|
+
# Apply a theme
|
|
133
|
+
apply_dock_theme("cyberpunk_neon")
|
|
134
|
+
|
|
135
|
+
# Add a dock widget
|
|
136
|
+
editor = DockWidget("Editor", window)
|
|
137
|
+
editor.set_widget(QTextEdit())
|
|
138
|
+
editor.set_features(DockWidgetFeature.all_features)
|
|
139
|
+
dock_manager.add_dock_widget(DockWidgetArea.center, editor)
|
|
140
|
+
|
|
141
|
+
window.show()
|
|
142
|
+
app.exec()
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Full Example
|
|
146
|
+
|
|
147
|
+
Run the demo application to explore all features:
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
python demo_app.py
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
The demo includes:
|
|
154
|
+
- Multiple dock widgets with different feature flags (closable, movable, floatable, pinnable)
|
|
155
|
+
- Sidebar setup with notification badges
|
|
156
|
+
- Theme switching menu with 14 built-in themes
|
|
157
|
+
- Global flags menu for live configuration toggling
|
|
158
|
+
- Insertion order control
|
|
159
|
+
- Sidebar focus mode and badge position controls
|
|
160
|
+
- Preset configurations (Default, Minimal, Full)
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Screenshots
|
|
165
|
+
|
|
166
|
+
> *Screenshots coming soon — add images of your application running with different themes.*
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## Architecture Overview
|
|
171
|
+
|
|
172
|
+
Lace is built around a clean, modular architecture:
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
DockManager (facade)
|
|
176
|
+
├── DockContainerWidget (root + floating windows)
|
|
177
|
+
│ ├── DockSplitter (nested, orientation-aware)
|
|
178
|
+
│ └── DockAreaWidget (tabbed regions)
|
|
179
|
+
│ ├── DockAreaTitleBar
|
|
180
|
+
│ │ └── DockAreaTabBar → DockWidgetTab (×N)
|
|
181
|
+
│ └── DockWidget → user content (QTextEdit, QWidget, etc.)
|
|
182
|
+
├── SidebarManager (auto-hide panels)
|
|
183
|
+
│ ├── SideTabBar → VerticalTabButton (×N)
|
|
184
|
+
│ └── SideBarContainer (overlay panel)
|
|
185
|
+
├── LayoutSerializer (JSON persistence)
|
|
186
|
+
├── DockStyleManager (theme engine)
|
|
187
|
+
├── DockThemeBridge (QPalette → Qt children)
|
|
188
|
+
└── ThemeManager (OS-aware auto light/dark)
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
See the [Architecture Documentation](docs/ARCHITECTURE.md) for a complete module-by-module reference with class hierarchies, signals, and method tables.
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
## Documentation
|
|
196
|
+
|
|
197
|
+
| Document | Description |
|
|
198
|
+
|---|---|
|
|
199
|
+
| [**Quick Reference**](docs/QUICK_REFERENCE.md) | 5-minute guide — installation, common patterns, API lookup |
|
|
200
|
+
| [**Architecture**](docs/ARCHITECTURE.md) | Complete system architecture — all modules, classes, signals, and data flow |
|
|
201
|
+
| [**Theming & Geometry**](docs/theming_and_geometry.md) | ThemeSpec tokens, titlebar flushness, reactive borders, content margin |
|
|
202
|
+
| [**Enum Mapping**](docs/enum_mapping.md) | Comprehensive mapping of all enumerations and flags with wiring status |
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
## Project Structure
|
|
207
|
+
|
|
208
|
+
```
|
|
209
|
+
lace/
|
|
210
|
+
├── lace/ # Main package
|
|
211
|
+
│ ├── dock_manager.py # Central orchestrator (facade)
|
|
212
|
+
│ ├── dock_widget.py # User-facing dock widget wrapper
|
|
213
|
+
│ ├── dock_widget_tab.py # Painted-chrome tab button
|
|
214
|
+
│ ├── dock_container_widget.py # Root + floating container
|
|
215
|
+
│ ├── dock_area_widget.py # Single tabbed region
|
|
216
|
+
│ ├── dock_splitter.py # Nested splitters + resize handles
|
|
217
|
+
│ ├── floating_dock_container.py # Top-level floating window
|
|
218
|
+
│ ├── dock_overlay.py # Drop-target visual overlays
|
|
219
|
+
│ ├── dock_chrome.py # Drag detector, chrome buttons, frames
|
|
220
|
+
│ ├── dock_paint.py # Painting primitives
|
|
221
|
+
│ ├── dock_theme.py # Theme schemas, ThemeSpec, color math
|
|
222
|
+
│ ├── dock_custom_theme.py # 14 built-in theme presets
|
|
223
|
+
│ ├── dock_style_manager.py # Singleton style manager (subscriber model)
|
|
224
|
+
│ ├── dock_theme_bridge.py # QPalette push to Qt children
|
|
225
|
+
│ ├── theme_manager.py # OS-aware auto dark/light switching
|
|
226
|
+
│ ├── layout_serializer.py # JSON save/restore, perspectives
|
|
227
|
+
│ ├── dock_container_state.py # Low-level tree state save/restore
|
|
228
|
+
│ ├── dock_signals.py # Internal event bus
|
|
229
|
+
│ ├── dock_menu.py # Unified context menu system
|
|
230
|
+
│ ├── dock_styled.py # DockStyled mixin (auto-style registration)
|
|
231
|
+
│ ├── dock_icon_provider.py # SVG icon provider with tinting
|
|
232
|
+
│ ├── sidebar_manager.py # Auto-hide sidebar controller
|
|
233
|
+
│ ├── sidebar_tab.py # Vertical tab button
|
|
234
|
+
│ ├── sidebar_tab_bar.py # Vertical tab strip
|
|
235
|
+
│ ├── sidebar_container.py # Animated overlay panel
|
|
236
|
+
│ ├── sidebar_title_bar.py # Title bar inside overlay panel
|
|
237
|
+
│ ├── sidebar_state.py # Sidebar state compatibility shim
|
|
238
|
+
│ ├── eliding_label.py # QLabel with text elision
|
|
239
|
+
│ ├── enums.py # All enumerations and flags
|
|
240
|
+
│ ├── util.py # Utility functions
|
|
241
|
+
│ └── _trace.py # Optional debug tracing
|
|
242
|
+
├── demo_app.py # Full-featured demo application
|
|
243
|
+
├── dev_smoke/ # Smoke tests for individual features
|
|
244
|
+
├── docs/ # Documentation
|
|
245
|
+
├── lace/resources/lace_icons/ # SVG icons (close, dock, float, pin, etc.)
|
|
246
|
+
├── LICENSE # Apache-2.0
|
|
247
|
+
└── README.md # This file
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
## Contributing
|
|
253
|
+
|
|
254
|
+
Contributions are welcome! Please:
|
|
255
|
+
|
|
256
|
+
1. Open an issue to discuss significant changes before starting work
|
|
257
|
+
2. Follow the existing code style and naming conventions
|
|
258
|
+
3. Add smoke tests in `dev_smoke/` for new features
|
|
259
|
+
4. Update documentation (`docs/`) for user-facing changes
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## License
|
|
264
|
+
|
|
265
|
+
Lace is licensed under the **Apache License 2.0**. See [LICENSE](LICENSE) for details.
|
|
266
|
+
|
|
267
|
+
This project incorporates components from [qtpydocking](https://github.com/PySide6/qtpydocking) under the BSD 3-Clause License. See [LICENSE](LICENSE) for full attribution.
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
**Author:** opticsWolf
|
|
272
|
+
**Contact:** opticswolf@protonmail.com
|