Lerking/superqt
1
0
Fork 0
mirror of https://github.com/pyapp-kit/superqt.git synced 2026-01-07 21:02:13 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
39e94825e99ec7ca9e5ad238284175d4a9f3c92c
superqt/widgets/qenumcombobox/index.html
Talley Lambert 39e94825e9 Deployed 0f31c74 with MkDocs version: 1.4.0
2022-10-05 07:58:21 -04:00

1142 lines
31 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/napari/superqt/widgets/qenumcombobox/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-8.5.6">
<title>QEnumComboBox - superqt</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.20d9efc8.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.cbb835fc.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">
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="../../stylesheets/extra.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" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
<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="#qenumcombobox" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" 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">
QEnumComboBox
</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"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/napari/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.2.0 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 2022 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">
napari/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/napari/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.2.0 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 2022 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">
napari/superqt
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
superqt
</a>
</li>
<li class="md-nav__item">
<a href="../../faq/" class="md-nav__link">
FAQ
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
<div class="md-nav__link md-nav__link--index ">
<a href="../../utilities/">Utilities</a>
<label for="__nav_3">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" aria-label="Utilities" data-md-level="1">
<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/code_syntax_highlight/" class="md-nav__link">
CodeSyntaxHighlight
</a>
</li>
<li class="md-nav__item">
<a href="../../utilities/qmessagehandler/" class="md-nav__link">
QMessageHandler
</a>
</li>
<li class="md-nav__item">
<a href="../../utilities/thread_decorators/" class="md-nav__link">
Threading decorators
</a>
</li>
<li class="md-nav__item">
<a href="../../utilities/threading/" class="md-nav__link">
Thread workers
</a>
</li>
<li class="md-nav__item">
<a href="../../utilities/throttling/" class="md-nav__link">
Throttling & Debouncing
</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" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
<div class="md-nav__link md-nav__link--index ">
<a href="../">Widgets</a>
<label for="__nav_4">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" aria-label="Widgets" data-md-level="1">
<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="../qcollapsible/" class="md-nav__link">
QCollapsible
</a>
</li>
<li class="md-nav__item">
<a href="../qdoublerangeslider/" class="md-nav__link">
QDoubleRangeSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qdoubleslider/" class="md-nav__link">
QDoubleSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qelidinglabel/" class="md-nav__link">
QElidingLabel
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
QEnumComboBox
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
QEnumComboBox
</a>
<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="#allow-none" class="md-nav__link">
Allow None
</a>
</li>
<li class="md-nav__item">
<a href="#qt-class" class="md-nav__link">
Qt Class
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
Signals
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#currentenumchanged" class="md-nav__link">
currentEnumChanged
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#methods" class="md-nav__link">
Methods
</a>
<nav class="md-nav" aria-label="Methods">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.currentEnum" class="md-nav__link">
currentEnum()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.enumClass" class="md-nav__link">
enumClass()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.isOptional" class="md-nav__link">
isOptional()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.setCurrentEnum" class="md-nav__link">
setCurrentEnum()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.setEnumClass" class="md-nav__link">
setEnumClass()
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../qlabeleddoublerangeslider/" class="md-nav__link">
QLabeledDoubleRangeSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qlabeleddoubleslider/" class="md-nav__link">
QLabeledDoubleSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qlabeledrangeslider/" class="md-nav__link">
QLabeledRangeSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qlabeledslider/" class="md-nav__link">
QLabeledSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qlargeintspinbox/" class="md-nav__link">
QLargeIntSpinBox
</a>
</li>
<li class="md-nav__item">
<a href="../qrangeslider/" class="md-nav__link">
QRangeSlider
</a>
</li>
<li class="md-nav__item">
<a href="../qsearchablecombobox/" class="md-nav__link">
QSearchableComboBox
</a>
</li>
<li class="md-nav__item">
<a href="../qsearchablelistwidget/" class="md-nav__link">
QSearchableListWidget
</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="#allow-none" class="md-nav__link">
Allow None
</a>
</li>
<li class="md-nav__item">
<a href="#qt-class" class="md-nav__link">
Qt Class
</a>
</li>
<li class="md-nav__item">
<a href="#signals" class="md-nav__link">
Signals
</a>
<nav class="md-nav" aria-label="Signals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#currentenumchanged" class="md-nav__link">
currentEnumChanged
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#methods" class="md-nav__link">
Methods
</a>
<nav class="md-nav" aria-label="Methods">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.currentEnum" class="md-nav__link">
currentEnum()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.enumClass" class="md-nav__link">
enumClass()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.isOptional" class="md-nav__link">
isOptional()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.setCurrentEnum" class="md-nav__link">
setCurrentEnum()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.combobox._enum_combobox.QEnumComboBox.setEnumClass" class="md-nav__link">
setEnumClass()
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/napari/superqt/edit/master/docs/widgets/qenumcombobox.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
</a>
<h1 id="qenumcombobox">QEnumComboBox</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
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
the combobox, and <code>currentEnum</code>/<code>setCurrentEnum</code> to get/set the current <code>Enum</code>
member in the combobox. There is also a new signal <code>currentEnumChanged(enum)</code>
analogous to <code>currentIndexChanged</code> and <code>currentTextChanged</code>.</p>
<p>Method like <code>insertItem</code> and <code>addItem</code> are blocked and try of its usage will end
with <code>RuntimeError</code></p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
<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">QEnumComboBox</span>
<span class="k">class</span> <span class="nc">SampleEnum</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="n">first</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">second</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">third</span> <span class="o">=</span> <span class="mi">3</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">QApplication</span><span class="p">([])</span>
<span class="n">combo</span> <span class="o">=</span> <span class="n">QEnumComboBox</span><span class="p">()</span>
<span class="n">combo</span><span class="o">.</span><span class="n">setEnumClass</span><span class="p">(</span><span class="n">SampleEnum</span><span class="p">)</span>
<span class="n">combo</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="n">app</span><span class="o">.</span><span class="n">exec_</span><span class="p">()</span>
</code></pre></div>
<p><img alt="QEnumComboBox" loading="lazy;" src="../../images/QEnumComboBox.png" width="500" /></p>
<p>Another option is to use optional <code>enum_class</code> argument of constructor and change</p>
<div class="highlight"><pre><span></span><code><span class="c1"># option A:</span>
<span class="n">combo</span> <span class="o">=</span> <span class="n">QEnumComboBox</span><span class="p">()</span>
<span class="n">combo</span><span class="o">.</span><span class="n">setEnumClass</span><span class="p">(</span><span class="n">SampleEnum</span><span class="p">)</span>
<span class="c1"># option B:</span>
<span class="n">combo</span> <span class="o">=</span> <span class="n">QEnumComboBox</span><span class="p">(</span><span class="n">enum_class</span><span class="o">=</span><span class="n">SampleEnum</span><span class="p">)</span>
</code></pre></div>
<h2 id="allow-none">Allow <code>None</code></h2>
<p><code>QEnumComboBox</code> also allows using <code>Optional</code> type annotation:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
<span class="kn">from</span> <span class="nn">superqt</span> <span class="kn">import</span> <span class="n">QEnumComboBox</span>
<span class="k">class</span> <span class="nc">SampleEnum</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="n">first</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">second</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">third</span> <span class="o">=</span> <span class="mi">3</span>
<span class="c1"># as usual:</span>
<span class="c1"># you must create a QApplication before create a widget.</span>
<span class="n">combo</span> <span class="o">=</span> <span class="n">QEnumComboBox</span><span class="p">()</span>
<span class="n">combo</span><span class="o">.</span><span class="n">setEnumClass</span><span class="p">(</span><span class="n">SampleEnum</span><span class="p">,</span> <span class="n">allow_none</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</code></pre></div>
<p>In this case there is added option <code>----</code> and the <code>currentEnum()</code> method will
return <code>None</code> when it is selected.</p>
<h2 id="qt-class">Qt Class</h2>
<p><a href='https://doc.qt.io/qt-6/qcombobox.html'><code>QComboBox</code></a></p>
<h2 id="signals">Signals</h2>
<h3 id="currentenumchanged"><code>currentEnumChanged</code></h3>
<h2 id="methods">Methods</h2>
<div class="doc doc-object doc-class">
<div class="doc doc-contents first">
<p>ComboBox presenting options from a python Enum.</p>
<p>If the Enum class does not implement <code>__str__</code> then a human readable name
is created from the name of the enum member, replacing underscores with spaces.</p>
<div class="doc doc-children">
<div class="doc doc-object doc-function">
<h3 id="superqt.combobox._enum_combobox.QEnumComboBox.currentEnum" class="doc doc-heading">
<code class="highlight language-python"><span class="n">currentEnum</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EnumType</span><span class="p">]</span></code>
</h3>
<div class="doc doc-contents ">
<p>current value as Enum member</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.combobox._enum_combobox.QEnumComboBox.enumClass" class="doc doc-heading">
<code class="highlight language-python"><span class="n">enumClass</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EnumMeta</span><span class="p">]</span></code>
</h3>
<div class="doc doc-contents ">
<p>return current Enum class</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.combobox._enum_combobox.QEnumComboBox.isOptional" class="doc doc-heading">
<code class="highlight language-python"><span class="n">isOptional</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span></code>
</h3>
<div class="doc doc-contents ">
<p>return if current enum is with optional annotation</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.combobox._enum_combobox.QEnumComboBox.setCurrentEnum" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setCurrentEnum</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EnumType</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
</h3>
<div class="doc doc-contents ">
<p>Set value with Enum.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.combobox._enum_combobox.QEnumComboBox.setEnumClass" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setEnumClass</span><span class="p">(</span><span class="n">enum</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EnumMeta</span><span class="p">],</span> <span class="n">allow_none</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span></code>
</h3>
<div class="doc doc-contents ">
<p>Set enum class from which members value should be selected</p>
</div>
</div>
</div>
</div>
</div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../qelidinglabel/" class="md-footer__link md-footer__link--prev" aria-label="Previous: QElidingLabel" rel="prev">
<div class="md-footer__button md-icon">
<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>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
QElidingLabel
</div>
</div>
</a>
<a href="../qlabeleddoublerangeslider/" class="md-footer__link md-footer__link--next" aria-label="Next: QLabeledDoubleRangeSlider" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
QLabeledDoubleRangeSlider
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
</div>
</a>
</nav>
<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 Talley Lambert
</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"], "search": "../../assets/javascripts/workers/search.5bf1dace.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "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.title": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.078830c0.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink