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
ed07b0eac65b77cacbd3971dfd240d876fc6092f
superqt/widgets/qquantity/index.html
Talley Lambert ed07b0eac6 Deployed df2034d with MkDocs version: 1.5.2
2023-09-12 13:54:07 -04:00

1789 lines
41 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/qquantity/">
<link rel="prev" href="../qlargeintspinbox/">
<link rel="next" href="../qrangeslider/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.3.1">
<title>QQuantity - 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="#qquantity" 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">
QQuantity
</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 ">
<span class="md-ellipsis">
Widgets
</span>
</a>
<label class="md-nav__link " 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 md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
QQuantity
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
QQuantity
</span>
</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="#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="#dimensionalitychanged" class="md-nav__link">
dimensionalityChanged
</a>
</li>
<li class="md-nav__item">
<a href="#valuechanged" class="md-nav__link">
valueChanged
</a>
</li>
<li class="md-nav__item">
<a href="#unitschanged" class="md-nav__link">
unitsChanged
</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.QQuantity.dimensionality" class="md-nav__link">
dimensionality()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.isDimensionless" class="md-nav__link">
isDimensionless()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.magnitude" class="md-nav__link">
magnitude()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.magnitudeSpinBox" class="md-nav__link">
magnitudeSpinBox()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setDecimals" class="md-nav__link">
setDecimals()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setMagnitude" class="md-nav__link">
setMagnitude()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setUnits" class="md-nav__link">
setUnits()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setValue" class="md-nav__link">
setValue()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.text" class="md-nav__link">
text()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.unitRegistry" class="md-nav__link">
unitRegistry()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.units" class="md-nav__link">
units()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.unitsComboBox" class="md-nav__link">
unitsComboBox()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.value" class="md-nav__link">
value()
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</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="#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="#dimensionalitychanged" class="md-nav__link">
dimensionalityChanged
</a>
</li>
<li class="md-nav__item">
<a href="#valuechanged" class="md-nav__link">
valueChanged
</a>
</li>
<li class="md-nav__item">
<a href="#unitschanged" class="md-nav__link">
unitsChanged
</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.QQuantity.dimensionality" class="md-nav__link">
dimensionality()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.isDimensionless" class="md-nav__link">
isDimensionless()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.magnitude" class="md-nav__link">
magnitude()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.magnitudeSpinBox" class="md-nav__link">
magnitudeSpinBox()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setDecimals" class="md-nav__link">
setDecimals()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setMagnitude" class="md-nav__link">
setMagnitude()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setUnits" class="md-nav__link">
setUnits()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.setValue" class="md-nav__link">
setValue()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.text" class="md-nav__link">
text()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.unitRegistry" class="md-nav__link">
unitRegistry()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.units" class="md-nav__link">
units()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.unitsComboBox" class="md-nav__link">
unitsComboBox()
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QQuantity.value" class="md-nav__link">
value()
</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">
<h1 id="qquantity">QQuantity<a class="headerlink" href="#qquantity" title="Permanent link">#</a></h1>
<p>A widget that allows the user to edit a quantity (a magnitude associated with a unit).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This widget requires <a href="https://pint.readthedocs.io"><code>pint</code></a>:</p>
<div class="highlight"><pre><span></span><code>pip install pint
</code></pre></div>
<p>or</p>
<div class="highlight"><pre><span></span><code>pip install superqt[quantity]
</code></pre></div>
</div>
<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">QQuantity</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">QApplication</span><span class="p">([])</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">QQuantity</span><span class="p">(</span><span class="s2">&quot;1m&quot;</span><span class="p">)</span>
<span class="n">w</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="QQuantity" loading="lazy;" src="../../_auto_images/QQuantity.png" width="150" /></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/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="valuechanged"><code>valueChanged</code><a class="headerlink" href="#valuechanged" title="Permanent link">#</a></h3>
<h3 id="unitschanged"><code>unitsChanged</code><a class="headerlink" href="#unitschanged" title="Permanent link">#</a></h3>
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h2>
<div class="doc doc-object doc-class">
<div class="doc doc-contents first">
<p>A combination QDoubleSpinBox and QComboBox for entering quantities.</p>
<p>For this widget, <code>value()</code> returns a <code>pint.Quantity</code> object, while <code>setValue()</code>
accepts either a number, <code>pint.Quantity</code>, a string that can be parsed by <code>pint</code>.</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>value</code></td>
<td>
<code><a class="autorefs autorefs-external" title="typing.Union" href="https://docs.python.org/3/library/typing.html#typing.Union">Union</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>, <span title="pint.Quantity">Quantity</span>, <span title="superqt.spinbox._quantity.Number">Number</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>The initial value to display. If a string, it will be parsed by <code>pint</code>.</p>
</div>
</td>
<td>
<code>0</code>
</td>
</tr>
<tr>
<td><code>units</code></td>
<td>
<code><a class="autorefs autorefs-external" title="typing.Union" href="https://docs.python.org/3/library/typing.html#typing.Union">Union</a>[<span title="pint.util.UnitsContainer">UnitsContainer</span>, <a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>, <span title="pint.Quantity">Quantity</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>The units to use if <code>value</code> is a number. If a string, it will be parsed by
<code>pint</code>. If a <code>pint.Quantity</code>, the units will be extracted from it.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>ureg</code></td>
<td>
<code><span title="pint.UnitRegistry">UnitRegistry</span></code>
</td>
<td>
<div class="doc-md-description">
<p>The unit registry to use. If not provided, the registry will be extracted
from <code>value</code> if it is a <code>pint.Quantity</code>, otherwise the default registry will
be used.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>parent</code></td>
<td>
<code><span title="qtpy.QtWidgets.QWidget">QWidget</span></code>
</td>
<td>
<div class="doc-md-description">
<p>The parent widget, by default None</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.dimensionality" class="doc doc-heading">
<code class="highlight language-python"><span class="n">dimensionality</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">UnitsContainer</span></code>
<a href="#superqt.QQuantity.dimensionality" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the current dimensionality (cast to <code>str</code> for nice repr).</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.isDimensionless" class="doc doc-heading">
<code class="highlight language-python"><span class="n">isDimensionless</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span></code>
<a href="#superqt.QQuantity.isDimensionless" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return <code>True</code> if the current value is dimensionless.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.magnitude" class="doc doc-heading">
<code class="highlight language-python"><span class="n">magnitude</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">int</span><span class="p">]</span></code>
<a href="#superqt.QQuantity.magnitude" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the magnitude of the current value.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.magnitudeSpinBox" class="doc doc-heading">
<code class="highlight language-python"><span class="n">magnitudeSpinBox</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">QDoubleSpinBox</span></code>
<a href="#superqt.QQuantity.magnitudeSpinBox" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the <code>QSpinBox</code> widget used to edit the magnitude.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.setDecimals" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setDecimals</span><span class="p">(</span><span class="n">decimals</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QQuantity.setDecimals" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the number of decimals to display in the spinbox.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.setMagnitude" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setMagnitude</span><span class="p">(</span><span class="n">magnitude</span><span class="p">:</span> <span class="n">Number</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QQuantity.setMagnitude" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the magnitude of the current value.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.setUnits" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setUnits</span><span class="p">(</span><span class="n">units</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Unit</span><span class="p">,</span> <span class="n">Quantity</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QQuantity.setUnits" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the units of the current value.</p>
<p>If <code>units</code> is <code>None</code>, will convert to a dimensionless quantity.
Otherwise, units must be compatible with the current dimensionality.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.setValue" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setValue</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Quantity</span><span class="p">,</span> <span class="n">Number</span><span class="p">],</span> <span class="n">units</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">UnitsContainer</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">Quantity</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QQuantity.setValue" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the current value (will cast to a pint Quantity).</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.text" class="doc doc-heading">
<code class="highlight language-python"><span class="n">text</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span></code>
<a href="#superqt.QQuantity.text" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.unitRegistry" class="doc doc-heading">
<code class="highlight language-python"><span class="n">unitRegistry</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">UnitRegistry</span></code>
<a href="#superqt.QQuantity.unitRegistry" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the pint UnitRegistry used by this widget.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.units" class="doc doc-heading">
<code class="highlight language-python"><span class="n">units</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Unit</span></code>
<a href="#superqt.QQuantity.units" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the current units.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.unitsComboBox" class="doc doc-heading">
<code class="highlight language-python"><span class="n">unitsComboBox</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">QComboBox</span></code>
<a href="#superqt.QQuantity.unitsComboBox" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the <code>QCombBox</code> widget used to edit the units.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QQuantity.value" class="doc doc-heading">
<code class="highlight language-python"><span class="n">value</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Quantity</span></code>
<a href="#superqt.QQuantity.value" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the current value as a <code>pint.Quantity</code>.</p>
</div>
</div>
</div>
</div>
</div>
</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