Deployed 49a8114 with MkDocs version: 1.6.1

This commit is contained in:
Talley Lambert
2025-03-28 15:31:28 -04:00
parent ad45dfa205
commit 4b7994bd51
48 changed files with 3197 additions and 87 deletions

View File

@@ -583,6 +583,8 @@
@@ -1025,6 +1027,27 @@
<li class="md-nav__item">
<a href="/pyapp-kit/superqt/widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 KiB

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.1 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 864 B

View File

@@ -35,7 +35,7 @@ def define_env(env: "MacrosPlugin"):
src = src.replace(
"QApplication([])", "QApplication.instance() or QApplication([])"
)
src = src.replace("app.exec_()", "")
src = src.replace("app.exec_()", "app.processEvents()")
exec(src)
_grab(dest, width)
@@ -127,7 +127,6 @@ def define_env(env: "MacrosPlugin"):
def _grab(dest: str | Path, width) -> list[Path]:
"""Grab the top widgets of the application."""
from qtpy.QtCore import QTimer
from qtpy.QtWidgets import QApplication
w = QApplication.topLevelWidgets()[-1]
@@ -135,12 +134,3 @@ def _grab(dest: str | Path, width) -> list[Path]:
w.activateWindow()
w.setMinimumHeight(40)
w.grab().save(str(dest))
# hack to make sure the object is truly closed and deleted
while True:
QTimer.singleShot(10, w.deleteLater)
QApplication.processEvents()
try:
w.parent()
except RuntimeError:
return

View File

@@ -643,6 +643,8 @@
@@ -1085,6 +1087,27 @@
<li class="md-nav__item">
<a href="../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -659,6 +659,8 @@
@@ -1101,6 +1103,27 @@
<li class="md-nav__item">
<a href="widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

Binary file not shown.

File diff suppressed because one or more lines are too long

View File

@@ -2,134 +2,138 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://github.com/pyapp-kit/superqt/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/faq/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/cmap/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/code_syntax_highlight/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/error_dialog_contexts/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/fonticon/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/iconify/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/qmessagehandler/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/signal_utils/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/thread_decorators/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/threading/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/utilities/throttling/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/colormap_catalog/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qcollapsible/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qcolorcombobox/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qcolormap/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qdoublerangeslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qdoubleslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qelidinglabel/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qenumcombobox/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qflowlayout/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qlabeleddoublerangeslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qlabeleddoubleslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qlabeledrangeslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qlabeledslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qlargeintspinbox/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qquantity/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qrangeslider/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qsearchablecombobox/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qsearchablelistwidget/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qsearchabletreewidget/</loc>
<lastmod>2025-01-05</lastmod>
<lastmod>2025-03-28</lastmod>
</url>
<url>
<loc>https://github.com/pyapp-kit/superqt/widgets/qtoggleswitch/</loc>
<lastmod>2025-03-28</lastmod>
</url>
</urlset>

Binary file not shown.

View File

@@ -661,6 +661,8 @@
@@ -1103,6 +1105,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1236,7 +1259,7 @@ which to paint the colormap.</p>
<code>cmap</code>
</td>
<td>
<code><a class="autorefs autorefs-external" title="cmap.Colormap" href="https://cmap-docs.readthedocs.io/en/latest/api/colormap/#cmap.Colormap">Colormap</a> | <a class="autorefs autorefs-external" title="typing.Any" href="https://docs.python.org/3/library/typing.html#typing.Any">Any</a></code>
<code><a class="autorefs autorefs-external" title="cmap.Colormap" href="https://cmap-docs.readthedocs.io/en/latest/reference/cmap/#cmap.Colormap">Colormap</a> | <a class="autorefs autorefs-external" title="typing.Any" href="https://docs.python.org/3/library/typing.html#typing.Any">Any</a></code>
</td>
<td>
<div class="doc-md-description">
@@ -1436,7 +1459,7 @@ Default is 0.33.</p>
<code>fallback_cmap</code>
</td>
<td>
<code><a class="autorefs autorefs-external" title="cmap.Colormap" href="https://cmap-docs.readthedocs.io/en/latest/api/colormap/#cmap.Colormap">Colormap</a> | <a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a> | None</code>
<code><a class="autorefs autorefs-external" title="cmap.Colormap" href="https://cmap-docs.readthedocs.io/en/latest/reference/cmap/#cmap.Colormap">Colormap</a> | <a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1482,6 +1505,27 @@ transparency, by default 4. If 0, no checkerboard is drawn.</p>
<code>4</code>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>allow_invalid</code>
</td>
<td>
<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#bool">bool</a></code>
</td>
<td>
<div class="doc-md-description">
<p>If True, the user can enter any text, even if it does not represent a valid
colormap (and <code>fallback_cmap</code> will be shown if it's invalid). If False, the text
will be validated when editing is finished or focus is lost, and if the text is
not a valid colormap, it will be reverted to the first available valid option
from the completer, or, if that's not available, the last valid colormap.
Default is True. This is only settable at initialization.</p>
</div>
</td>
<td>
<code>True</code>
</td>
</tr>
</tbody>
</table>

View File

@@ -694,6 +694,8 @@
@@ -1136,6 +1138,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -643,6 +643,8 @@
@@ -1085,6 +1087,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -808,6 +808,8 @@
@@ -1250,6 +1252,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -673,6 +673,8 @@
@@ -1115,6 +1117,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -594,6 +594,8 @@
@@ -1036,6 +1038,27 @@
<li class="md-nav__item">
<a href="../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -676,6 +676,8 @@
@@ -1118,6 +1120,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -643,6 +643,8 @@
@@ -1085,6 +1087,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -670,6 +670,8 @@
@@ -1112,6 +1114,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1206,7 +1229,7 @@ running in the desired thread:</p>
<p><code>ensure_main_thread</code> ensures that the decorated function/method runs in the main thread</p>
<h2 id="ensure_object_thread"><code>ensure_object_thread</code><a class="headerlink" href="#ensure_object_thread" title="Permanent link">#</a></h2>
<p><code>ensure_object_thread</code> ensures that a decorated bound method of a <code>QObject</code> runs
in the thread in which the instance lives (<a href="https://doc.qt.io/qt-5/threads-qobject.html#accessing-qobject-subclasses-from-other-threads">see qt documentation for
in the thread in which the instance lives (<a href="https://doc.qt.io/qt-6/threads-qobject.html#accessing-qobject-subclasses-from-other-threads">see qt documentation for
details</a>).</p>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">#</a></h2>
<p>By default, functions are executed asynchronously (they return immediately with

View File

@@ -841,6 +841,8 @@
@@ -1283,6 +1285,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -2805,7 +2828,7 @@ the work. They can be moved to a QThread as is done here.</p>
<p>While the signals/slots syntax of the worker looks very similar to
standard "single-threaded" signals &amp; slots, note that inter-thread
signals and slots (automatically) use an event-based QueuedConnection, while
intra-thread signals use a DirectConnection. See <a href="https://doc.qt.io/qt-5/threads-qobject.html#signals-and-slots-across-threads&gt;">Signals and Slots Across
intra-thread signals use a DirectConnection. See <a href="https://doc.qt.io/qt-6/threads-qobject.html#signals-and-slots-across-threads&gt;">Signals and Slots Across
Threads</a></p>
</details>

View File

@@ -766,6 +766,8 @@
@@ -1208,6 +1210,27 @@
<li class="md-nav__item">
<a href="../../widgets/qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -1133,6 +1135,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -1036,6 +1038,27 @@
<li class="md-nav__item">
<a href="qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1200,6 +1223,10 @@
<td><a href="qcolormap/"><code>QColormapComboBox</code></a></td>
<td><code>QComboBox</code> to select from a specified set of colormaps.</td>
</tr>
<tr>
<td><a href="qtoggleswitch/"><code>QToggleSwitch</code></a></td>
<td><code>QAbstractButton</code> that represents a boolean value with a toggle switch.</td>
</tr>
</tbody>
</table>
<h2 id="frames-and-containers">Frames and containers<a class="headerlink" href="#frames-and-containers" title="Permanent link">#</a></h2>

View File

@@ -596,6 +596,8 @@
@@ -1286,6 +1288,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -1238,6 +1240,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -847,6 +849,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QColormapComboBox.isFilterable" class="md-nav__link">
<span class="md-ellipsis">
isFilterable
</span>
</a>
</li>
<li class="md-nav__item">
@@ -865,6 +876,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QColormapComboBox.setFilterable" class="md-nav__link">
<span class="md-ellipsis">
setFilterable
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1214,6 +1234,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1342,6 +1383,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QColormapComboBox.isFilterable" class="md-nav__link">
<span class="md-ellipsis">
isFilterable
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1360,6 +1410,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QColormapComboBox.setFilterable" class="md-nav__link">
<span class="md-ellipsis">
setFilterable
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1415,7 +1474,7 @@ pip<span class="w"> </span>install<span class="w"> </span>superqt<span class="o"
</div>
<h3 id="colormaplike-objects">ColorMapLike objects<a class="headerlink" href="#colormaplike-objects" title="Permanent link">#</a></h3>
<p>Colormaps may be specified in a variety of ways, such as by name (string), an iterable of a color/color-like objects, or as
a <a class="autorefs autorefs-external" href="https://cmap-docs.readthedocs.io/en/latest/api/colormap/#cmap.Colormap"><code>cmap.Colormap</code></a> instance. See <a href="https://cmap-docs.readthedocs.io/en/latest/colormaps/#colormaplike-objects">cmap documentation for details on
a <a class="autorefs autorefs-external" href="https://cmap-docs.readthedocs.io/en/latest/reference/cmap/#cmap.Colormap"><code>cmap.Colormap</code></a> instance. See <a href="https://cmap-docs.readthedocs.io/en/latest/colormaps/#colormaplike-objects">cmap documentation for details on
all ColormapLike types</a></p>
<h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">cmap</span> <span class="kn">import</span> <span class="n">Colormap</span>
@@ -1531,6 +1590,23 @@ Default is "Add Colormap...".</p>
<code>&#39;Add Colormap...&#39;</code>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>filterable</code>
</td>
<td>
<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#bool">bool</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Whether the user can filter colormaps by typing in the line edit.
Default is True. Can also be set with <code>setFilterable</code>.</p>
</div>
</td>
<td>
<code>True</code>
</td>
</tr>
</tbody>
</table>
@@ -1606,6 +1682,23 @@ Default is "Add Colormap...".</p>
<div class="doc doc-object doc-function">
<h3 id="superqt.QColormapComboBox.isFilterable" class="doc doc-heading">
<code class="highlight language-python"><span class="n">isFilterable</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span></code>
<a href="#superqt.QColormapComboBox.isFilterable" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Returns whether the user can filter the list of colormaps.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QColormapComboBox.itemColormap" class="doc doc-heading">
<code class="highlight language-python"><span class="n">itemColormap</span><span class="p">(</span><span class="n">index</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Colormap</span> <span class="o">|</span> <span class="kc">None</span></code>
@@ -1640,6 +1733,27 @@ Default is "Add Colormap...".</p>
<div class="doc doc-object doc-function">
<h3 id="superqt.QColormapComboBox.setFilterable" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setFilterable</span><span class="p">(</span><span class="n">filterable</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QColormapComboBox.setFilterable" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set whether the user can enter/filter colormaps by typing in the line edit.</p>
<p>If enabled, the user can select the text in the line edit and type to
filter the list of colormaps. The completer will show a list of matching
colormaps as the user types. If disabled, the user can only select from
the combo box dropdown.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QColormapComboBox.setUserAdditionsAllowed" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setUserAdditionsAllowed</span><span class="p">(</span><span class="n">allow</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>

View File

@@ -596,6 +596,8 @@
@@ -1094,6 +1096,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -1094,6 +1096,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -1118,6 +1120,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -1178,6 +1180,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1333,7 +1356,7 @@
<h1 id="qenumcombobox">QEnumComboBox<a class="headerlink" href="#qenumcombobox" title="Permanent link">#</a></h1>
<p><code>QEnumComboBox</code> is a variant of
<a href="https://doc.qt.io/qt-5/qcombobox.html"><code>QComboBox</code></a> that populates the items in
<a href="https://doc.qt.io/qt-6/qcombobox.html"><code>QComboBox</code></a> that populates the items in
the combobox based on a python <code>Enum</code> class. In addition to all the methods
provided by <code>QComboBox</code>, this subclass adds the methods
<code>enumClass</code>/<code>setEnumClass</code> to get/set the current <code>Enum</code> class represented by

View File

@@ -596,6 +596,8 @@
@@ -1136,6 +1138,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -885,6 +887,30 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#frangechanged" class="md-nav__link">
<span class="md-ellipsis">
frangeChanged
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1160,6 +1186,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1200,6 +1247,30 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#frangechanged" class="md-nav__link">
<span class="md-ellipsis">
frangeChanged
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1314,6 +1385,8 @@
<p><img alt="QLabeledDoubleRangeSlider" loading="lazy;" src="../../_auto_images/QLabeledDoubleRangeSlider.png" width="500" /></p>
<h2 id="qt-class">Qt Class<a class="headerlink" href="#qt-class" title="Permanent link">#</a></h2>
<p><a href='https://doc.qt.io/qt-6/qabstractslider.html'><code>QAbstractSlider</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="frangechanged"><code>frangeChanged</code><a class="headerlink" href="#frangechanged" title="Permanent link">#</a></h3>
<h2 id="enums">Enums<a class="headerlink" href="#enums" title="Permanent link">#</a></h2>
<h3 id="qlabeleddoublerangesliderlabelposition"><code>QLabeledDoubleRangeSlider.LabelPosition</code><a class="headerlink" href="#qlabeleddoublerangesliderlabelposition" title="Permanent link">#</a></h3>
<ul>

View File

@@ -596,6 +596,8 @@
@@ -906,6 +908,48 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#fslidermoved" class="md-nav__link">
<span class="md-ellipsis">
fsliderMoved
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#frangechanged" class="md-nav__link">
<span class="md-ellipsis">
frangeChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fvaluechanged" class="md-nav__link">
<span class="md-ellipsis">
fvalueChanged
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1142,6 +1186,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1182,6 +1247,48 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#fslidermoved" class="md-nav__link">
<span class="md-ellipsis">
fsliderMoved
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#frangechanged" class="md-nav__link">
<span class="md-ellipsis">
frangeChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fvaluechanged" class="md-nav__link">
<span class="md-ellipsis">
fvalueChanged
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1278,6 +1385,10 @@
<p><img alt="QLabeledDoubleSlider" loading="lazy;" src="../../_auto_images/QLabeledDoubleSlider.png" width="500" /></p>
<h2 id="qt-class">Qt Class<a class="headerlink" href="#qt-class" title="Permanent link">#</a></h2>
<p><a href='https://doc.qt.io/qt-6/qabstractslider.html'><code>QAbstractSlider</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="fslidermoved"><code>fsliderMoved</code><a class="headerlink" href="#fslidermoved" title="Permanent link">#</a></h3>
<h3 id="frangechanged"><code>frangeChanged</code><a class="headerlink" href="#frangechanged" title="Permanent link">#</a></h3>
<h3 id="fvaluechanged"><code>fvalueChanged</code><a class="headerlink" href="#fvaluechanged" title="Permanent link">#</a></h3>
<h2 id="enums">Enums<a class="headerlink" href="#enums" title="Permanent link">#</a></h2>
<h3 id="qlabeleddoubleslideredgelabelmode"><code>QLabeledDoubleSlider.EdgeLabelMode</code><a class="headerlink" href="#qlabeleddoubleslideredgelabelmode" title="Permanent link">#</a></h3>
<ul>

View File

@@ -596,6 +596,8 @@
@@ -939,6 +941,15 @@
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#valueschanged" class="md-nav__link">
<span class="md-ellipsis">
valuesChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#editingfinished" class="md-nav__link">
<span class="md-ellipsis">
@@ -1202,6 +1213,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1254,6 +1286,15 @@
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#valueschanged" class="md-nav__link">
<span class="md-ellipsis">
valuesChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#editingfinished" class="md-nav__link">
<span class="md-ellipsis">
@@ -1398,6 +1439,7 @@
<h2 id="qt-class">Qt Class<a class="headerlink" href="#qt-class" title="Permanent link">#</a></h2>
<p><a href='https://doc.qt.io/qt-6/qabstractslider.html'><code>QAbstractSlider</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="valueschanged"><code>valuesChanged</code><a class="headerlink" href="#valueschanged" title="Permanent link">#</a></h3>
<h3 id="editingfinished"><code>editingFinished</code><a class="headerlink" href="#editingfinished" title="Permanent link">#</a></h3>
<h2 id="enums">Enums<a class="headerlink" href="#enums" title="Permanent link">#</a></h2>
<h3 id="qlabeledrangesliderlabelposition"><code>QLabeledRangeSlider.LabelPosition</code><a class="headerlink" href="#qlabeledrangesliderlabelposition" title="Permanent link">#</a></h3>

View File

@@ -596,6 +596,8 @@
@@ -1166,6 +1168,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>

View File

@@ -596,6 +596,8 @@
@@ -982,18 +984,18 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#valuechanged" class="md-nav__link">
<a href="#textchanged" class="md-nav__link">
<span class="md-ellipsis">
valueChanged
textChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#textchanged" class="md-nav__link">
<a href="#valuechanged" class="md-nav__link">
<span class="md-ellipsis">
textChanged
valueChanged
</span>
</a>
@@ -1232,6 +1234,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1285,18 +1308,18 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#valuechanged" class="md-nav__link">
<a href="#textchanged" class="md-nav__link">
<span class="md-ellipsis">
valueChanged
textChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#textchanged" class="md-nav__link">
<a href="#valuechanged" class="md-nav__link">
<span class="md-ellipsis">
textChanged
valueChanged
</span>
</a>
@@ -1459,8 +1482,8 @@
<h2 id="qt-class">Qt Class<a class="headerlink" href="#qt-class" title="Permanent link">#</a></h2>
<p><a href='https://doc.qt.io/qt-6/qabstractspinbox.html'><code>QAbstractSpinBox</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="valuechanged"><code>valueChanged</code><a class="headerlink" href="#valuechanged" title="Permanent link">#</a></h3>
<h3 id="textchanged"><code>textChanged</code><a class="headerlink" href="#textchanged" title="Permanent link">#</a></h3>
<h3 id="valuechanged"><code>valueChanged</code><a class="headerlink" href="#valuechanged" title="Permanent link">#</a></h3>
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h2>

View File

@@ -596,6 +596,8 @@
@@ -1002,6 +1004,15 @@
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dimensionalitychanged" class="md-nav__link">
<span class="md-ellipsis">
dimensionalityChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unitschanged" class="md-nav__link">
<span class="md-ellipsis">
@@ -1018,15 +1029,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dimensionalitychanged" class="md-nav__link">
<span class="md-ellipsis">
dimensionalityChanged
</span>
</a>
</li>
</ul>
@@ -1259,6 +1261,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1311,6 +1334,15 @@
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dimensionalitychanged" class="md-nav__link">
<span class="md-ellipsis">
dimensionalityChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unitschanged" class="md-nav__link">
<span class="md-ellipsis">
@@ -1327,15 +1359,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dimensionalitychanged" class="md-nav__link">
<span class="md-ellipsis">
dimensionalityChanged
</span>
</a>
</li>
</ul>
@@ -1518,9 +1541,9 @@
<h2 id="qt-class">Qt Class<a class="headerlink" href="#qt-class" title="Permanent link">#</a></h2>
<p><a href='https://doc.qt.io/qt-6/qwidget.html'><code>QWidget</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="dimensionalitychanged"><code>dimensionalityChanged</code><a class="headerlink" href="#dimensionalitychanged" title="Permanent link">#</a></h3>
<h3 id="unitschanged"><code>unitsChanged</code><a class="headerlink" href="#unitschanged" title="Permanent link">#</a></h3>
<h3 id="valuechanged"><code>valueChanged</code><a class="headerlink" href="#valuechanged" title="Permanent link">#</a></h3>
<h3 id="dimensionalitychanged"><code>dimensionalityChanged</code><a class="headerlink" href="#dimensionalitychanged" title="Permanent link">#</a></h3>
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h2>

View File

@@ -596,6 +596,8 @@
@@ -1077,6 +1079,39 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#valueschanged" class="md-nav__link">
<span class="md-ellipsis">
valuesChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#slidersmoved" class="md-nav__link">
<span class="md-ellipsis">
slidersMoved
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1265,6 +1300,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1371,6 +1427,39 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#valueschanged" class="md-nav__link">
<span class="md-ellipsis">
valuesChanged
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#slidersmoved" class="md-nav__link">
<span class="md-ellipsis">
slidersMoved
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1523,7 +1612,7 @@ select a range of values.</p>
</code></pre></div>
<p><img alt="QRangeSlider" loading="lazy;" src="../../_auto_images/QRangeSlider.png" width="500" /></p>
<ul>
<li><code>QRangeSlider</code> inherits from <a href="https://doc.qt.io/qt-5/qslider.html"><code>QSlider</code></a>
<li><code>QRangeSlider</code> inherits from <a href="https://doc.qt.io/qt-6/qslider.html"><code>QSlider</code></a>
and attempts to match the Qt API as closely as possible</li>
<li>It uses platform-specific styles (for handle, groove, &amp; ticks) but also supports
QSS style sheets.</li>
@@ -1531,8 +1620,8 @@ select a range of values.</p>
<li>Supports more than 2 handles (e.g. <code>slider.setValue([0, 10, 60, 80])</code>)</li>
</ul>
<p>As <code>QRangeSlider</code> inherits from
<a href="https://doc.qt.io/qt-5/qslider.html"><code>QtWidgets.QSlider</code></a>, you can use all of
the same methods available in the <a href="https://doc.qt.io/qt-5/qslider.html">QSlider
<a href="https://doc.qt.io/qt-6/qslider.html"><code>QtWidgets.QSlider</code></a>, you can use all of
the same methods available in the <a href="https://doc.qt.io/qt-6/qslider.html">QSlider
API</a>. The major difference is that <code>value()</code>
and <code>sliderPosition()</code> are reimplemented as <code>tuples</code> of <code>int</code> (where the length of
the tuple is equal to the number of handles in the slider.)</p>
@@ -1716,6 +1805,9 @@ the tuple is equal to the number of handles in the slider.)</p>
<p><img alt="linux" src="../../images/demo_linux.png" /></p>
<h2 id="qt-class">Qt Class<a class="headerlink" href="#qt-class" title="Permanent link">#</a></h2>
<p><a href='https://doc.qt.io/qt-6/qslider.html'><code>QSlider</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="valueschanged"><code>valuesChanged</code><a class="headerlink" href="#valueschanged" title="Permanent link">#</a></h3>
<h3 id="slidersmoved"><code>slidersMoved</code><a class="headerlink" href="#slidersmoved" title="Permanent link">#</a></h3>
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h2>

View File

@@ -596,6 +596,8 @@
@@ -1085,6 +1087,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1147,7 +1170,7 @@
<h1 id="qsearchablecombobox">QSearchableComboBox<a class="headerlink" href="#qsearchablecombobox" title="Permanent link">#</a></h1>
<p><code>QSearchableComboBox</code> is a variant of
<a href="https://doc.qt.io/qt-5/qcombobox.html"><code>QComboBox</code></a> that allow to filter list
<a href="https://doc.qt.io/qt-6/qcombobox.html"><code>QComboBox</code></a> that allow to filter list
of options by enter part of text. It could be drop in replacement for
<code>QComboBox</code>.</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">qtpy.QtWidgets</span> <span class="kn">import</span> <span class="n">QApplication</span>

View File

@@ -596,6 +596,8 @@
@@ -1145,6 +1147,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1267,12 +1290,12 @@
<h1 id="qsearchablelistwidget">QSearchableListWidget<a class="headerlink" href="#qsearchablelistwidget" title="Permanent link">#</a></h1>
<p><code>QSearchableListWidget</code> is a variant of
<a href="https://doc.qt.io/qt-5/qlistwidget.html"><code>QListWidget</code></a> that add text entry
<a href="https://doc.qt.io/qt-6/qlistwidget.html"><code>QListWidget</code></a> that add text entry
above list widget that allow to filter list of available options.</p>
<p>Due to implementation details, this widget it does not inherit directly from
<a href="https://doc.qt.io/qt-5/qlistwidget.html"><code>QListWidget</code></a> but it does fully
<a href="https://doc.qt.io/qt-6/qlistwidget.html"><code>QListWidget</code></a> but it does fully
satisfy its api. The only limitation is that it cannot be used as argument of
<a href="https://doc.qt.io/qt-5/qlistwidgetitem.html"><code>QListWidgetItem</code></a> constructor.</p>
<a href="https://doc.qt.io/qt-6/qlistwidgetitem.html"><code>QListWidgetItem</code></a> constructor.</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">qtpy.QtWidgets</span> <span class="kn">import</span> <span class="n">QApplication</span>
<span class="kn">from</span> <span class="nn">superqt</span> <span class="kn">import</span> <span class="n">QSearchableListWidget</span>

View File

@@ -16,6 +16,8 @@
<link rel="prev" href="../qsearchablelistwidget/">
<link rel="next" href="../qtoggleswitch/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
@@ -594,6 +596,8 @@
@@ -1116,6 +1120,27 @@
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</span>
</a>
</li>
</ul>
</nav>
@@ -1259,7 +1284,7 @@ If the mapping changes, the easiest way to update this is by calling <code>setDa
into the <code>filter</code> line edit. An item is only shown if its, any of its ancestors',
or any of its descendants' keys or values match this pattern.
The regular expression follows the conventions described by the Qt docs:
https://doc.qt.io/qt-5/qregularexpression.html#details</p>
https://doc.qt.io/qt-6/qregularexpression.html#details</p>
<p><span class="doc-section-title">Attributes:</span></p>

File diff suppressed because it is too large Load Diff