status-im
/
SortFilterProxyModel
mirror of https://github.com/status-im/SortFilterProxyModel.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Regenerate documentation for StringSorter

This commit is contained in:
Pierre-Yves Siret 2017-09-12 01:29:47 +02:00
parent 9e37e58eef
commit 3f52c81299
5 changed files with 137 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.html
View File

@ -28,6 +28,7 @@
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-expressionsorter.html">ExpressionSorter</a></p></td><td class="tblDescr"><p>Sorts row with a custom sorting</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-rolesorter.html">RoleSorter</a></p></td><td class="tblDescr"><p>Sorts rows based on a source model role</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-sorter.html">Sorter</a></p></td><td class="tblDescr"><p>Base type for the SortFilterProxyModel sorters</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-stringsorter.html">StringSorter</a></p></td><td class="tblDescr"><p>Sorts rows based on a source model string role</p></td></tr>
</table></div>
</div>
<!-- @@@index.html -->

1
docs/qml-rolesorter.html
View File

@ -24,6 +24,7 @@
<!-- @@@RoleSorter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import .</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-sorter.html">Sorter</a></p>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-stringsorter.html">StringSorter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-rolesorter-members.html">List of all members, including inherited members</a></li>
</ul>

30
docs/qml-stringsorter-members.html Normal file
View File

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- sorter.cpp -->
<title>List of All Members for StringSorter | SortFilterProxyModel</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for StringSorter</h1>
<p>This is the complete list of members for <a href="qml-stringsorter.html">StringSorter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-stringsorter.html#caseSensitivity-prop">caseSensitivity</a></b></b> : Qt.CaseSensitivity</li>
<li class="fn"><b><b><a href="qml-stringsorter.html#ignorePunctation-prop">ignorePunctation</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-stringsorter.html#locale-prop">locale</a></b></b> : Locale</li>
<li class="fn"><b><b><a href="qml-stringsorter.html#numericMode-prop">numericMode</a></b></b> : bool</li>
</ul>
<p>The following members are inherited from <a href="qml-rolesorter.html">RoleSorter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-rolesorter.html#roleName-prop">roleName</a></b></b> : string</li>
</ul>
<p>The following members are inherited from <a href="qml-sorter.html">Sorter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-sorter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-sorter.html#sortOrder-prop">sortOrder</a></b></b> : Qt::SortOrder</li>
</ul>
</body>
</html>

91
docs/qml-stringsorter.html Normal file
View File

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- sorter.cpp -->
<title>StringSorter QML Type | SortFilterProxyModel</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</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">StringSorter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$StringSorter-brief -->
<p>Sorts rows based on a source model string role <a href="#details">More...</a></p>
<!-- @@@StringSorter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import .</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-rolesorter.html">RoleSorter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-stringsorter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-stringsorter.html#caseSensitivity-prop">caseSensitivity</a></b></b> : Qt.CaseSensitivity</li>
<li class="fn"><b><b><a href="qml-stringsorter.html#ignorePunctation-prop">ignorePunctation</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-stringsorter.html#locale-prop">locale</a></b></b> : Locale</li>
<li class="fn"><b><b><a href="qml-stringsorter.html#numericMode-prop">numericMode</a></b></b> : bool</li>
</ul>
<!-- $$$StringSorter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-stringsorter.html">StringSorter</a> is a specialized <a href="qml-rolesorter.html">RoleSorter</a> that sorts rows based on a source model string role. <a href="qml-stringsorter.html">StringSorter</a> compares strings according to a localized collation algorithm.</p>
<p>In the following example, rows with be sorted by their <code>lastName</code> role :</p>
<pre class="cpp">SortFilterProxyModel {
sourceModel: contactModel
sorters: StringSorter { roleName: <span class="string">&quot;lastName&quot;</span> }
}</pre>
<!-- @@@StringSorter -->
<h2>Property Documentation</h2>
<!-- $$$caseSensitivity -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="caseSensitivity-prop">
<td class="tblQmlPropNode"><p>
<a name="caseSensitivity-prop"></a><span class="name">caseSensitivity</span> : <span class="type">Qt</span>.<span class="type">CaseSensitivity</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the case sensitivity of the sorter.</p>
</div></div><!-- @@@caseSensitivity -->
<br/>
<!-- $$$ignorePunctation -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="ignorePunctation-prop">
<td class="tblQmlPropNode"><p>
<a name="ignorePunctation-prop"></a><span class="name">ignorePunctation</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the sorter ignores punctation. if <code>ignorePunctuation</code> is <code>true</code>, punctuation characters and symbols are ignored when determining sort order.</p>
<p><b>Note: </b>This property is not currently supported on Apple platforms or if Qt is configured to not use ICU on Linux.</p></div></div><!-- @@@ignorePunctation -->
<br/>
<!-- $$$locale -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="locale-prop">
<td class="tblQmlPropNode"><p>
<a name="locale-prop"></a><span class="name">locale</span> : <span class="type">Locale</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the locale of the sorter.</p>
</div></div><!-- @@@locale -->
<br/>
<!-- $$$numericMode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="numericMode-prop">
<td class="tblQmlPropNode"><p>
<a name="numericMode-prop"></a><span class="name">numericMode</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the numeric mode of the sorter is enabled. This will enable proper sorting of numeric digits, so that e.g&#x2e; 100 sorts after 99. By default this mode is off.</p>
</div></div><!-- @@@numericMode -->
<br/>
</body>
</html>

15
docs/sortfilterproxymodel.index
View File

@ -57,6 +57,12 @@
<qmlproperty threadsafety="unspecified" name="enabled" fullname="Sorter::enabled" href="qml-sorter.html#enabled-prop" status="active" access="public" type="bool" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="sortOrder" fullname="Sorter::sortOrder" href="qml-sorter.html#sortOrder-prop" status="active" access="public" type="Qt::SortOrder" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="StringSorter" qml-module-name="StringSorter" qml-base-type="::RoleSorter" href="qml-stringsorter.html" status="active" access="public" title="StringSorter" fulltitle="StringSorter" subtitle="" brief="Sorts rows based on a source model string role">
<qmlproperty threadsafety="unspecified" name="caseSensitivity" fullname="StringSorter::caseSensitivity" href="qml-stringsorter.html#caseSensitivity-prop" status="active" access="public" type="Qt.CaseSensitivity" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="ignorePunctation" fullname="StringSorter::ignorePunctation" href="qml-stringsorter.html#ignorePunctation-prop" status="active" access="public" type="bool" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="locale" fullname="StringSorter::locale" href="qml-stringsorter.html#locale-prop" status="active" access="public" type="Locale" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="numericMode" fullname="StringSorter::numericMode" href="qml-stringsorter.html#numericMode-prop" status="active" access="public" type="bool" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="tst_builtins" qml-module-name="tst_builtins" href="qml-tst-builtins.html" status="internal" access="private" location="tst_builtins.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_builtins.qml" lineno="6" title="tst_builtins" fulltitle="tst_builtins" subtitle=""/>
<qmlclass threadsafety="unspecified" name="tst_helpers" qml-module-name="tst_helpers" href="qml-tst-helpers.html" status="internal" access="private" location="tst_helpers.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_helpers.qml" lineno="7" title="tst_helpers" fulltitle="tst_helpers" subtitle=""/>
<qmlclass threadsafety="unspecified" name="tst_indexfilter" qml-module-name="tst_indexfilter" href="qml-tst-indexfilter.html" status="internal" access="private" location="tst_indexfilter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_indexfilter.qml" lineno="6" title="tst_indexfilter" fulltitle="tst_indexfilter" subtitle="">
@ -65,10 +71,17 @@
<qmlclass threadsafety="unspecified" name="tst_rangefilter" qml-module-name="tst_rangefilter" href="qml-tst-rangefilter.html" status="internal" access="private" location="tst_rangefilter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_rangefilter.qml" lineno="6" title="tst_rangefilter" fulltitle="tst_rangefilter" subtitle="">
<qmlproperty threadsafety="unspecified" name="filters" fullname="tst_rangefilter::filters" href="qml-tst-rangefilter.html#filters-prop" status="active" access="public" location="tst_rangefilter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_rangefilter.qml" lineno="7" type="RangeFilter" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="tst_rolesorter" qml-module-name="tst_rolesorter" href="qml-tst-rolesorter.html" status="internal" access="private" location="tst_rolesorter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_rolesorter.qml" lineno="6" title="tst_rolesorter" fulltitle="tst_rolesorter" subtitle="">
<qmlproperty threadsafety="unspecified" name="sorters" fullname="tst_rolesorter::sorters" href="qml-tst-rolesorter.html#sorters-prop" status="active" access="public" location="tst_rolesorter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_rolesorter.qml" lineno="7" type="RoleSorter" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="tst_sorters" qml-module-name="tst_sorters" href="qml-tst-sorters.html" status="internal" access="private" location="tst_sorters.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_sorters.qml" lineno="7" title="tst_sorters" fulltitle="tst_sorters" subtitle="">
<qmlproperty threadsafety="unspecified" name="sorters" fullname="tst_sorters::sorters" href="qml-tst-sorters.html#sorters-prop" status="active" access="public" location="tst_sorters.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_sorters.qml" lineno="16" type="QtObject" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="tieSorters" fullname="tst_sorters::tieSorters" href="qml-tst-sorters.html#tieSorters-prop" status="active" access="public" location="tst_sorters.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_sorters.qml" lineno="68" type="RoleSorter" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="tst_sourceroles" qml-module-name="tst_sourceroles" href="qml-tst-sourceroles.html" status="internal" access="private" location="tst_sourceroles.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_sourceroles.qml" lineno="6" title="tst_sourceroles" fulltitle="tst_sourceroles" subtitle=""/>
<qmlmodule name="SortFilterProxyModel" qml-module-name="SortFilterProxyModel" qml-module-version="." href="sortfilterproxymodel-qmlmodule.html" status="internal" seen="false" title="" members="Filter,RoleFilter,ValueFilter,IndexFilter,RegExpFilter,RangeFilter,ExpressionFilter,AnyOf,AllOf,SortFilterProxyModel,Sorter,RoleSorter,ExpressionSorter"/>
<qmlclass threadsafety="unspecified" name="tst_stringsorter" qml-module-name="tst_stringsorter" href="qml-tst-stringsorter.html" status="internal" access="private" location="tst_stringsorter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_stringsorter.qml" lineno="6" title="tst_stringsorter" fulltitle="tst_stringsorter" subtitle="">
<qmlproperty threadsafety="unspecified" name="sorters" fullname="tst_stringsorter::sorters" href="qml-tst-stringsorter.html#sorters-prop" status="active" access="public" location="tst_stringsorter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_stringsorter.qml" lineno="7" type="StringSorter" attached="false" writable="true"/>
</qmlclass>
<qmlmodule name="SortFilterProxyModel" qml-module-name="SortFilterProxyModel" qml-module-version="." href="sortfilterproxymodel-qmlmodule.html" status="internal" seen="false" title="" members="Filter,RoleFilter,ValueFilter,IndexFilter,RegExpFilter,RangeFilter,ExpressionFilter,AnyOf,AllOf,SortFilterProxyModel,Sorter,RoleSorter,StringSorter,ExpressionSorter"/>
</namespace>
</INDEX>