Lerking/superqt
1
0
Fork 0
mirror of https://github.com/pyapp-kit/superqt.git synced 2026-01-08 21:30:06 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
ed07b0eac65b77cacbd3971dfd240d876fc6092f
superqt/widgets/index.html
Talley Lambert 8e19cf66b6 Deployed df2034d with MkDocs version: 1.5.2
2023-09-12 13:53:45 -04:00

1185 lines
25 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="missing widgets and components for PyQt/PySide">
<link rel="canonical" href="https://github.com/pyapp-kit/superqt/widgets/">
<link rel="prev" href="../utilities/throttling/">
<link rel="next" href="colormap_catalog/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.3.1">
<title>Widgets - superqt</title>
<link rel="stylesheet" href="../assets/stylesheets/main.046329b4.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#widgets" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="superqt" class="md-header__button md-logo" aria-label="superqt" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
superqt
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Widgets
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/pyapp-kit/superqt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
pyapp-kit/superqt
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="superqt" class="md-nav__button md-logo" aria-label="superqt" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
superqt
</label>
<div class="md-nav__source">
<a href="https://github.com/pyapp-kit/superqt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
pyapp-kit/superqt
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
superqt
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<div class="md-nav__link md-nav__container">
<a href="../utilities/" class="md-nav__link ">
<span class="md-ellipsis">
Utilities
</span>
</a>
<label class="md-nav__link " for="__nav_3">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Utilities
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../utilities/cmap/" class="md-nav__link">
<span class="md-ellipsis">
Colormap utilities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/code_syntax_highlight/" class="md-nav__link">
<span class="md-ellipsis">
CodeSyntaxHighlight
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/error_dialog_contexts/" class="md-nav__link">
<span class="md-ellipsis">
Error message context manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/fonticon/" class="md-nav__link">
<span class="md-ellipsis">
Font icons
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/qmessagehandler/" class="md-nav__link">
<span class="md-ellipsis">
QMessageHandler
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/signal_utils/" class="md-nav__link">
<span class="md-ellipsis">
Signal Utilities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/thread_decorators/" class="md-nav__link">
<span class="md-ellipsis">
Threading decorators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/threading/" class="md-nav__link">
<span class="md-ellipsis">
Thread workers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../utilities/throttling/" class="md-nav__link">
<span class="md-ellipsis">
Throttling & Debouncing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<div class="md-nav__link md-nav__container">
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Widgets
</span>
</a>
<label class="md-nav__link md-nav__link--active" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Widgets
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="colormap_catalog/" class="md-nav__link">
<span class="md-ellipsis">
CmapCatalogComboBox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qcollapsible/" class="md-nav__link">
<span class="md-ellipsis">
QCollapsible
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qcolorcombobox/" class="md-nav__link">
<span class="md-ellipsis">
QColorComboBox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qcolormap/" class="md-nav__link">
<span class="md-ellipsis">
QColormapComboBox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qdoublerangeslider/" class="md-nav__link">
<span class="md-ellipsis">
QDoubleRangeSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qdoubleslider/" class="md-nav__link">
<span class="md-ellipsis">
QDoubleSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qelidinglabel/" class="md-nav__link">
<span class="md-ellipsis">
QElidingLabel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qenumcombobox/" class="md-nav__link">
<span class="md-ellipsis">
QEnumComboBox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qlabeleddoublerangeslider/" class="md-nav__link">
<span class="md-ellipsis">
QLabeledDoubleRangeSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qlabeleddoubleslider/" class="md-nav__link">
<span class="md-ellipsis">
QLabeledDoubleSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qlabeledrangeslider/" class="md-nav__link">
<span class="md-ellipsis">
QLabeledRangeSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qlabeledslider/" class="md-nav__link">
<span class="md-ellipsis">
QLabeledSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qlargeintspinbox/" class="md-nav__link">
<span class="md-ellipsis">
QLargeIntSpinBox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qquantity/" class="md-nav__link">
<span class="md-ellipsis">
QQuantity
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qrangeslider/" class="md-nav__link">
<span class="md-ellipsis">
QRangeSlider
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qsearchablecombobox/" class="md-nav__link">
<span class="md-ellipsis">
QSearchableComboBox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qsearchablelistwidget/" class="md-nav__link">
<span class="md-ellipsis">
QSearchableListWidget
</span>
</a>
</li>
<li class="md-nav__item">
<a href="qsearchabletreewidget/" class="md-nav__link">
<span class="md-ellipsis">
QSearchableTreeWidget
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#sliders-and-numerical-inputs" class="md-nav__link">
Sliders and Numerical Inputs
</a>
</li>
<li class="md-nav__item">
<a href="#labels-and-categorical-inputs" class="md-nav__link">
Labels and categorical inputs
</a>
</li>
<li class="md-nav__item">
<a href="#frames-and-containers" class="md-nav__link">
Frames and containers
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="widgets">Widgets<a class="headerlink" href="#widgets" title="Permanent link">#</a></h1>
<p>The following are QWidget subclasses:</p>
<h2 id="sliders-and-numerical-inputs">Sliders and Numerical Inputs<a class="headerlink" href="#sliders-and-numerical-inputs" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th>Widget</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="qdoublerangeslider/"><code>QDoubleRangeSlider</code></a></td>
<td>Multi-handle slider for float values</td>
</tr>
<tr>
<td><a href="qdoubleslider/"><code>QDoubleSlider</code></a></td>
<td>Slider for float values</td>
</tr>
<tr>
<td><a href="qlabeleddoublerangeslider/"><code>QLabeledDoubleRangeSlider</code></a></td>
<td><code>QDoubleRangeSlider</code> variant with editable labels for each handle</td>
</tr>
<tr>
<td><a href="qlabeleddoubleslider/"><code>QLabeledDoubleSlider</code></a></td>
<td><code>QSlider</code> for float values with editable <code>QSpinBox</code> with the current value</td>
</tr>
<tr>
<td><a href="qlabeledrangeslider/"><code>QLabeledRangeSlider</code></a></td>
<td><code>QRangeSlider</code> variant, with editable labels for each handle</td>
</tr>
<tr>
<td><a href="qlabeledslider/"><code>QLabeledSlider</code></a></td>
<td><code>QSlider</code> with editable <code>QSpinBox</code> that shows the current value</td>
</tr>
<tr>
<td><a href="qlargeintspinbox/"><code>QLargeIntSpinBox</code></a></td>
<td><code>QSpinbox</code> that accepts arbitrarily large integers</td>
</tr>
<tr>
<td><a href="qrangeslider/"><code>QRangeSlider</code></a></td>
<td>Multi-handle slider</td>
</tr>
<tr>
<td><a href="qquantity/"><code>QQuantity</code></a></td>
<td>Pint-backed quantity widget (magnitude combined with unit dropdown)</td>
</tr>
</tbody>
</table>
<h2 id="labels-and-categorical-inputs">Labels and categorical inputs<a class="headerlink" href="#labels-and-categorical-inputs" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th>Widget</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="qelidinglabel/"><code>QElidingLabel</code></a></td>
<td>A <code>QLabel</code> variant that will elide text (add <code>…</code>) to fit width.</td>
</tr>
<tr>
<td><a href="qenumcombobox/"><code>QEnumComboBox</code></a></td>
<td><code>QComboBox</code> that populates the combobox from a python <code>Enum</code></td>
</tr>
<tr>
<td><a href="qsearchablecombobox/"><code>QSearchableComboBox</code></a></td>
<td><code>QComboBox</code> variant that filters available options based on text input</td>
</tr>
<tr>
<td><a href="qsearchablelistwidget/"><code>QSearchableListWidget</code></a></td>
<td><code>QListWidget</code> variant with search field that filters available options</td>
</tr>
<tr>
<td><a href="qsearchabletreewidget/"><code>QSearchableTreeWidget</code></a></td>
<td><code>QTreeWidget</code> variant with search field that filters available options</td>
</tr>
<tr>
<td><a href="qcolorcombobox/"><code>QColorComboBox</code></a></td>
<td><code>QComboBox</code> to select from a specified set of colors</td>
</tr>
<tr>
<td><a href="qcolormap/"><code>QColormapComboBox</code></a></td>
<td><code>QComboBox</code> to select from a specified set of colormaps.</td>
</tr>
</tbody>
</table>
<h2 id="frames-and-containers">Frames and containers<a class="headerlink" href="#frames-and-containers" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th>Widget</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="qcollapsible/"><code>QCollapsible</code></a></td>
<td>A collapsible widget to hide and unhide child widgets.</td>
</tr>
</tbody>
</table>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2021 - 2022
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.indexes", "navigation.expand", "search.highlight", "search.suggest", "content.code.copy"], "search": "../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.dff1b7c8.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink