Files
superqt/widgets/qcollapsible/index.html
2025-03-28 15:31:28 -04:00

1998 lines
46 KiB
HTML

<!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/qcollapsible/">
<link rel="prev" href="../colormap_catalog/">
<link rel="next" href="../qcolorcombobox/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
<title>QCollapsible - superqt</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.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">
<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="#qcollapsible" 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.54"/></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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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">
QCollapsible
</span>
</div>
</div>
</div>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<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.52 6.52 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 5"/></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.52 6.52 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 5"/></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 11z"/></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 12z"/></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" tabindex="0" 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.7.1 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 2024 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.81"/></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.54"/></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.7.1 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 2024 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.81"/></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" id="__nav_3_label" tabindex="0">
<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/iconify/" class="md-nav__link">
<span class="md-ellipsis">
QIconifyIcon
</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 &amp; 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" id="__nav_4_label" tabindex="0">
<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 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">
QCollapsible
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
QCollapsible
</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">
<span class="md-ellipsis">
Qt Class
</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="#toggled" class="md-nav__link">
<span class="md-ellipsis">
toggled
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#methods" class="md-nav__link">
<span class="md-ellipsis">
Methods
</span>
</a>
<nav class="md-nav" aria-label="Methods">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#superqt.QCollapsible.addWidget" class="md-nav__link">
<span class="md-ellipsis">
addWidget
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.collapse" class="md-nav__link">
<span class="md-ellipsis">
collapse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.collapsedIcon" class="md-nav__link">
<span class="md-ellipsis">
collapsedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.content" class="md-nav__link">
<span class="md-ellipsis">
content
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.expand" class="md-nav__link">
<span class="md-ellipsis">
expand
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.expandedIcon" class="md-nav__link">
<span class="md-ellipsis">
expandedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.isExpanded" class="md-nav__link">
<span class="md-ellipsis">
isExpanded
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.locked" class="md-nav__link">
<span class="md-ellipsis">
locked
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.removeWidget" class="md-nav__link">
<span class="md-ellipsis">
removeWidget
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setCollapsedIcon" class="md-nav__link">
<span class="md-ellipsis">
setCollapsedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setContent" class="md-nav__link">
<span class="md-ellipsis">
setContent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setDuration" class="md-nav__link">
<span class="md-ellipsis">
setDuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setEasingCurve" class="md-nav__link">
<span class="md-ellipsis">
setEasingCurve
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setExpandedIcon" class="md-nav__link">
<span class="md-ellipsis">
setExpandedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setLocked" class="md-nav__link">
<span class="md-ellipsis">
setLocked
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setText" class="md-nav__link">
<span class="md-ellipsis">
setText
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.text" class="md-nav__link">
<span class="md-ellipsis">
text
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.toggleButton" class="md-nav__link">
<span class="md-ellipsis">
toggleButton
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</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="../qflowlayout/" class="md-nav__link">
<span class="md-ellipsis">
QFlowLayout
</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>
<li class="md-nav__item">
<a href="../qtoggleswitch/" class="md-nav__link">
<span class="md-ellipsis">
QToggleSwitch
</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">
<span class="md-ellipsis">
Qt Class
</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="#toggled" class="md-nav__link">
<span class="md-ellipsis">
toggled
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#methods" class="md-nav__link">
<span class="md-ellipsis">
Methods
</span>
</a>
<nav class="md-nav" aria-label="Methods">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#superqt.QCollapsible.addWidget" class="md-nav__link">
<span class="md-ellipsis">
addWidget
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.collapse" class="md-nav__link">
<span class="md-ellipsis">
collapse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.collapsedIcon" class="md-nav__link">
<span class="md-ellipsis">
collapsedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.content" class="md-nav__link">
<span class="md-ellipsis">
content
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.expand" class="md-nav__link">
<span class="md-ellipsis">
expand
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.expandedIcon" class="md-nav__link">
<span class="md-ellipsis">
expandedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.isExpanded" class="md-nav__link">
<span class="md-ellipsis">
isExpanded
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.locked" class="md-nav__link">
<span class="md-ellipsis">
locked
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.removeWidget" class="md-nav__link">
<span class="md-ellipsis">
removeWidget
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setCollapsedIcon" class="md-nav__link">
<span class="md-ellipsis">
setCollapsedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setContent" class="md-nav__link">
<span class="md-ellipsis">
setContent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setDuration" class="md-nav__link">
<span class="md-ellipsis">
setDuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setEasingCurve" class="md-nav__link">
<span class="md-ellipsis">
setEasingCurve
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setExpandedIcon" class="md-nav__link">
<span class="md-ellipsis">
setExpandedIcon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setLocked" class="md-nav__link">
<span class="md-ellipsis">
setLocked
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.setText" class="md-nav__link">
<span class="md-ellipsis">
setText
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.text" class="md-nav__link">
<span class="md-ellipsis">
text
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#superqt.QCollapsible.toggleButton" class="md-nav__link">
<span class="md-ellipsis">
toggleButton
</span>
</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="qcollapsible">QCollapsible<a class="headerlink" href="#qcollapsible" title="Permanent link">#</a></h1>
<p>Collapsible <code>QFrame</code> that can be expanded or collapsed by clicking on the header.</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="p">,</span> <span class="n">QLabel</span><span class="p">,</span> <span class="n">QPushButton</span>
<span class="kn">from</span> <span class="nn">superqt</span> <span class="kn">import</span> <span class="n">QCollapsible</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">QApplication</span><span class="p">([])</span>
<span class="n">collapsible</span> <span class="o">=</span> <span class="n">QCollapsible</span><span class="p">(</span><span class="s2">&quot;Advanced analysis&quot;</span><span class="p">)</span>
<span class="n">collapsible</span><span class="o">.</span><span class="n">addWidget</span><span class="p">(</span><span class="n">QLabel</span><span class="p">(</span><span class="s2">&quot;This is the inside of the collapsible frame&quot;</span><span class="p">))</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">):</span>
<span class="n">collapsible</span><span class="o">.</span><span class="n">addWidget</span><span class="p">(</span><span class="n">QPushButton</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Content button </span><span class="si">{</span><span class="n">i</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
<span class="n">collapsible</span><span class="o">.</span><span class="n">expand</span><span class="p">(</span><span class="n">animate</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">collapsible</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="QCollapsible" loading="lazy;" src="../../_auto_images/QCollapsible.png" width="350" /></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/qframe.html'><code>QFrame</code></a></p>
<h2 id="signals">Signals<a class="headerlink" href="#signals" title="Permanent link">#</a></h2>
<h3 id="toggled"><code>toggled</code><a class="headerlink" href="#toggled" 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 collapsible widget to hide and unhide child widgets.</p>
<p>A signal is emitted when the widget is expanded (True) or collapsed (False).</p>
<p>Based on https://stackoverflow.com/a/68141638</p>
<div class="doc doc-children">
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.addWidget" class="doc doc-heading">
<code class="highlight language-python"><span class="n">addWidget</span><span class="p">(</span><span class="n">widget</span><span class="p">:</span> <span class="n">QWidget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.addWidget" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Add a widget to the central content widget's layout.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.collapse" class="doc doc-heading">
<code class="highlight language-python"><span class="n">collapse</span><span class="p">(</span><span class="n">animate</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.collapse" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Collapse (hide) the collapsible section.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.collapsedIcon" class="doc doc-heading">
<code class="highlight language-python"><span class="n">collapsedIcon</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">QIcon</span></code>
<a href="#superqt.QCollapsible.collapsedIcon" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Returns the icon used when the widget is collapsed.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.content" class="doc doc-heading">
<code class="highlight language-python"><span class="n">content</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">QWidget</span></code>
<a href="#superqt.QCollapsible.content" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the current content widget.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.expand" class="doc doc-heading">
<code class="highlight language-python"><span class="n">expand</span><span class="p">(</span><span class="n">animate</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.expand" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Expand (show) the collapsible section.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.expandedIcon" class="doc doc-heading">
<code class="highlight language-python"><span class="n">expandedIcon</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">QIcon</span></code>
<a href="#superqt.QCollapsible.expandedIcon" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Returns the icon used when the widget is expanded.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.isExpanded" class="doc doc-heading">
<code class="highlight language-python"><span class="n">isExpanded</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span></code>
<a href="#superqt.QCollapsible.isExpanded" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return whether the collapsible section is visible.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.locked" class="doc doc-heading">
<code class="highlight language-python"><span class="n">locked</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span></code>
<a href="#superqt.QCollapsible.locked" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return True if collapse/expand is disabled.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.removeWidget" class="doc doc-heading">
<code class="highlight language-python"><span class="n">removeWidget</span><span class="p">(</span><span class="n">widget</span><span class="p">:</span> <span class="n">QWidget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.removeWidget" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Remove widget from the central content widget's layout.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setCollapsedIcon" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setCollapsedIcon</span><span class="p">(</span><span class="n">icon</span><span class="p">:</span> <span class="n">QIcon</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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.QCollapsible.setCollapsedIcon" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the icon on the toggle button when the widget is collapsed.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setContent" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setContent</span><span class="p">(</span><span class="n">content</span><span class="p">:</span> <span class="n">QWidget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.setContent" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Replace central widget (the widget that gets expanded/collapsed).</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setDuration" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setDuration</span><span class="p">(</span><span class="n">msecs</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.QCollapsible.setDuration" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set duration of the collapse/expand animation.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setEasingCurve" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setEasingCurve</span><span class="p">(</span><span class="n">easing</span><span class="p">:</span> <span class="n">QEasingCurve</span> <span class="o">|</span> <span class="n">QEasingCurve</span><span class="o">.</span><span class="n">Type</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.setEasingCurve" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the easing curve for the collapse/expand animation.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setExpandedIcon" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setExpandedIcon</span><span class="p">(</span><span class="n">icon</span><span class="p">:</span> <span class="n">QIcon</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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.QCollapsible.setExpandedIcon" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the icon on the toggle button when the widget is expanded.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setLocked" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setLocked</span><span class="p">(</span><span class="n">locked</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.setLocked" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set whether collapse/expand is disabled.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.setText" class="doc doc-heading">
<code class="highlight language-python"><span class="n">setText</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
<a href="#superqt.QCollapsible.setText" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Set the text of the toggle button.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.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.QCollapsible.text" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the text of the toggle button.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="superqt.QCollapsible.toggleButton" class="doc doc-heading">
<code class="highlight language-python"><span class="n">toggleButton</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">QPushButton</span></code>
<a href="#superqt.QCollapsible.toggleButton" class="headerlink" title="Permanent link">#</a></h3>
<div class="doc doc-contents ">
<p>Return the toggle button.</p>
</div>
</div>
</div>
</div>
</div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</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.6ce7567c.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.88dd0f4e.min.js"></script>
</body>
</html>