1
0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-09-19 17:01:45 +02:00
ScreenPlay/Docs/html/screenplay-installedlistfilter.html
Elias Steurer f9d2c9ca1b Fix documentation style by using \brief everywhere
Change Qt version to 5.15 for better qdoc analysis
Remove no longer used fixWindowsPath function
2020-03-31 15:35:51 +02:00

78 lines
5.3 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- installedlistfilter.cpp -->
<title>InstalledListFilter Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<div class="container-fullwidth nav"><div class="container navWrapper"><a href="../index.html"><span class="logo">ScreenPlay Generated Docs </span></a><span class="navHome"><a href="../index.html">Home</a></span></div></div> <div id= mainWrapper class="wrapper container ">
<li>InstalledListFilter</li>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">InstalledListFilter Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::InstalledListFilter</span>
<!-- $$$InstalledListFilter-brief -->
<p>Proxy between Installed List Model and QML view to filter items. <a href="#details">More...</a></p>
<!-- @@@InstalledListFilter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;InstalledListFilter&gt;</span>
</td></tr></table></div><ul>
<li><a href="screenplay-installedlistfilter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#InstalledListFilter">InstalledListFilter</a></b>(const shared_ptr&lt;ScreenPlay::InstalledListModel&gt; &amp;<i>ilm</i>)</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#resetFilter">resetFilter</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#sortByName">sortByName</a></b>(QString <i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#sortByRoleType">sortByRoleType</a></b>(QString <i>type</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$InstalledListFilter-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>This class could be merged with the <a href="screenplay-installedlistmodel.html">InstalledListModel</a> in the future.</p>
</div>
<!-- @@@InstalledListFilter -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$InstalledListFilter[overload1]$$$InstalledListFilterconstshared_ptr<ScreenPlay::InstalledListModel>& -->
<h3 class="fn" id="InstalledListFilter"><a name="InstalledListFilter"></a>InstalledListFilter::<span class="name">InstalledListFilter</span>(const <span class="type">shared_ptr</span>&lt;<span class="type"><a href="screenplay-installedlistmodel.html">ScreenPlay::InstalledListModel</a></span>&gt; &amp;<i>ilm</i>)</h3>
<p>Sets the default role type to &quot;All&quot; to display all available content. Needs a given <i>ilm</i> (<a href="screenplay-installedlistmodel.html">InstalledListModel</a>).</p>
<!-- @@@InstalledListFilter -->
<!-- $$$resetFilter[overload1]$$$resetFilter -->
<h3 class="fn" id="resetFilter"><a name="resetFilter"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">resetFilter</span>()</h3>
<p>Resets the filter and sorts by title.</p>
<!-- @@@resetFilter -->
<!-- $$$sortByName[overload1]$$$sortByNameQString -->
<h3 class="fn" id="sortByName"><a name="sortByName"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">sortByName</span>(<span class="type">QString</span> <i>name</i>)</h3>
<p>Invoked when the user uses the quicksearch at the top right of the installed page. Uses the <i>name</i> to sort by name. This name is saved in the project.json title.</p>
<!-- @@@sortByName -->
<!-- $$$sortByRoleType[overload1]$$$sortByRoleTypeQString -->
<h3 class="fn" id="sortByRoleType"><a name="sortByRoleType"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">sortByRoleType</span>(<span class="type">QString</span> <i>type</i>)</h3>
<p>Set the filter proxy to sort by the given <i>type</i>. This can be:</p>
<ul>
<li>All</li>
<li>Videos</li>
<li>Widgets</li>
<li>Scenes</li>
</ul>
<!-- @@@sortByRoleType -->
</div>
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
</html>