[doc] Generate documentation

This commit is contained in:
Pierre-Yves Siret 2017-09-02 18:32:31 +02:00
parent 9009d18554
commit 84519a2a8e
29 changed files with 2209 additions and 0 deletions

35
docs/index.html Normal file
View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlsortfilterproxymodel.cpp -->
<title>SortFilterProxyModel QML Module | SortFilterProxyModel</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<li>SortFilterProxyModel QML Module</li>
<h1 class="title">SortFilterProxyModel QML Module</h1>
<span class="subtitle"></span>
<!-- $$$index.html-description -->
<div class="descr"> <a name="details"></a>
<p><a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a> is an implementation of QSortFilterProxyModel conveniently exposed for QML.</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-allof.html">AllOf</a></p></td><td class="tblDescr"><p>Filter container accepting rows accepted by all its child filters</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-anyof.html">AnyOf</a></p></td><td class="tblDescr"><p>Filter container accepting rows accepted by at least one of its child filters</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-expressionfilter.html">ExpressionFilter</a></p></td><td class="tblDescr"><p>Filters row with a custom filtering</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-filter.html">Filter</a></p></td><td class="tblDescr"><p>Base type for the SortFilterProxyModel filters</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-indexfilter.html">IndexFilter</a></p></td><td class="tblDescr"><p>Filters rows based on their source index</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-rangefilter.html">RangeFilter</a></p></td><td class="tblDescr"><p>Filters rows between boundary values</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-regexpfilter.html">RegExpFilter</a></p></td><td class="tblDescr"><p>Filters rows matching a regular expression</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-rolefilter.html">RoleFilter</a></p></td><td class="tblDescr"><p>Base type for filters based on a source model role</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-valuefilter.html">ValueFilter</a></p></td><td class="tblDescr"><p>Filters rows matching exactly a value</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a></p></td><td class="tblDescr"><p>Filters and sorts data coming from a source QAbstractItemModel</p></td></tr>
<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>
</table></div>
</div>
<!-- @@@index.html -->
</body>
</html>

View File

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for AllOf | 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 AllOf</h1>
<p>This is the complete list of members for <a href="qml-allof.html">AllOf</a>, including inherited members.</p>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

37
docs/qml-allof.html Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>AllOf 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">AllOf QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AllOf-brief -->
<p>Filter container accepting rows accepted by all its child filters <a href="#details">More...</a></p>
<!-- @@@AllOf -->
<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-filter.html">Filter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-allof-members.html">List of all members, including inherited members</a></li>
</ul>
<!-- $$$AllOf-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-allof.html">AllOf</a> type is a <a href="qml-filter.html">Filter</a> container that accepts rows if all of its contained (and enabled) filters accept them, or if it has no filter.</p>
<p>Using it as a top level filter has the same effect as putting all its child filters as top level filters. It can however be usefull to use an <a href="qml-allof.html">AllOf</a> filter when nested in an <a href="qml-anyof.html">AnyOf</a> filter.</p>
<!-- @@@AllOf -->
</body>
</html>

View File

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for AnyOf | 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 AnyOf</h1>
<p>This is the complete list of members for <a href="qml-anyof.html">AnyOf</a>, including inherited members.</p>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

56
docs/qml-anyof.html Normal file
View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>AnyOf 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">AnyOf QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AnyOf-brief -->
<p>Filter container accepting rows accepted by at least one of its child filters <a href="#details">More...</a></p>
<!-- @@@AnyOf -->
<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-filter.html">Filter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-anyof-members.html">List of all members, including inherited members</a></li>
</ul>
<!-- $$$AnyOf-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-anyof.html">AnyOf</a> type is a <a href="qml-filter.html">Filter</a> container that accepts rows if any of its contained (and enabled) filters accept them.</p>
<p>In the following example, only the rows where the <code>firstName</code> role or the <code>lastName</code> role match the text entered in the <code>nameTextField</code> will be accepted :</p>
<pre class="cpp">TextField {
id: nameTextField
}
SortFilterProxyModel {
sourceModel: contactModel
filters: AnyOf {
RegExpFilter {
roleName: <span class="string">&quot;lastName&quot;</span>
pattern: nameTextField<span class="operator">.</span>text
caseSensitivity: <span class="type">Qt</span><span class="operator">.</span>CaseInsensitive
}
RegExpFilter {
roleName: <span class="string">&quot;firstName&quot;</span>
pattern: nameTextField<span class="operator">.</span>text
caseSensitivity: <span class="type">Qt</span><span class="operator">.</span>CaseInsensitive
}
}
}</pre>
<!-- @@@AnyOf -->
</body>
</html>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for ExpressionFilter | 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 ExpressionFilter</h1>
<p>This is the complete list of members for <a href="qml-expressionfilter.html">ExpressionFilter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-expressionfilter.html#expression-prop">expression</a></b></b> : expression</li>
</ul>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

View File

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>ExpressionFilter 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">ExpressionFilter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ExpressionFilter-brief -->
<p>Filters row with a custom filtering <a href="#details">More...</a></p>
<!-- @@@ExpressionFilter -->
<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-filter.html">Filter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-expressionfilter-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-expressionfilter.html#expression-prop">expression</a></b></b> : expression</li>
</ul>
<!-- $$$ExpressionFilter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>An <a href="qml-expressionfilter.html">ExpressionFilter</a> is a <a href="qml-filter.html">Filter</a> allowing to implement custom filtering based on a javascript expression.</p>
<!-- @@@ExpressionFilter -->
<h2>Property Documentation</h2>
<!-- $$$expression -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="expression-prop">
<td class="tblQmlPropNode"><p>
<a name="expression-prop"></a><span class="name">expression</span> : <span class="type"><a href="qml-expressionfilter.html#expression-prop">expression</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>An expression to implement custom filtering, it must evaluate to a boolean. It has the same syntax has a <a href="http://doc.qt.io/qt-5/qtqml-syntax-propertybinding.html">Property Binding</a> except it will be evaluated for each of the source model's rows. Rows that have their expression evaluating to <code>true</code> will be accepted by the model. Data for each row is exposed like for a delegate of a QML View.</p>
<p>This expression is reevaluated for a row every time its model data changes. When an external property (not <code>index</code> or in <code>model</code>) the expression depends on changes, the expression is reevaluated for every row of the source model. To capture the properties the expression depends on, the expression is first executed with invalid data and each property access is detected by the QML engine. This means that if a property is not accessed because of a conditional, it won't be captured and the expression won't be reevaluted when this property changes.</p>
<p>A workaround to this problem is to access all the properties the expressions depends unconditionally at the beggining of the expression.</p>
</div></div><!-- @@@expression -->
<br/>
</body>
</html>

View File

@ -0,0 +1,23 @@
<?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 ExpressionSorter | 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 ExpressionSorter</h1>
<p>This is the complete list of members for <a href="qml-expressionsorter.html">ExpressionSorter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-expressionsorter.html#expression-prop">expression</a></b></b> : expression</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>

View File

@ -0,0 +1,55 @@
<?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>ExpressionSorter 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">ExpressionSorter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ExpressionSorter-brief -->
<p>Sorts row with a custom sorting <a href="#details">More...</a></p>
<!-- @@@ExpressionSorter -->
<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></table></div><ul>
<li><a href="qml-expressionsorter-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-expressionsorter.html#expression-prop">expression</a></b></b> : expression</li>
</ul>
<!-- $$$ExpressionSorter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>An <a href="qml-expressionsorter.html">ExpressionSorter</a> is a <a href="qml-sorter.html">Sorter</a> allowing to implement custom sorting based on a javascript expression.</p>
<!-- @@@ExpressionSorter -->
<h2>Property Documentation</h2>
<!-- $$$expression -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="expression-prop">
<td class="tblQmlPropNode"><p>
<a name="expression-prop"></a><span class="name">expression</span> : <span class="type"><a href="qml-expressionsorter.html#expression-prop">expression</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>An expression to implement custom sorting, it must evaluate to a bool. It has the same syntax has a <a href="http://doc.qt.io/qt-5/qtqml-syntax-propertybinding.html">Property Binding</a> except it will be evaluated for each of the source model's rows. Model data is accessible for both row with the <code>indexLeft</code>, <code>modelLeft</code>, <code>indexRight</code> and <code>modelRight</code> properties. The expression should return <code>true</code> if the value of the left item is less than the value of the right item, otherwise returns false.</p>
<p>This expression is reevaluated for a row every time its model data changes. When an external property (not <code>index*</code> or in <code>model*</code>) the expression depends on changes, the expression is reevaluated for every row of the source model. To capture the properties the expression depends on, the expression is first executed with invalid data and each property access is detected by the QML engine. This means that if a property is not accessed because of a conditional, it won't be captured and the expression won't be reevaluted when this property changes.</p>
<p>A workaround to this problem is to access all the properties the expressions depends unconditionally at the beggining of the expression.</p>
</div></div><!-- @@@expression -->
<br/>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for Filter | 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 Filter</h1>
<p>This is the complete list of members for <a href="qml-filter.html">Filter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

66
docs/qml-filter.html Normal file
View File

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>Filter 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">Filter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Filter-brief -->
<p>Base type for the <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a> filters <a href="#details">More...</a></p>
<!-- @@@Filter -->
<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"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-allof.html">AllOf</a>, <a href="qml-anyof.html">AnyOf</a>, <a href="qml-expressionfilter.html">ExpressionFilter</a>, <a href="qml-indexfilter.html">IndexFilter</a>, and <a href="qml-rolefilter.html">RoleFilter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-filter-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-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
<!-- $$$Filter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The Filter type cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the other filter types that inherit from it. Attempting to use the Filter type directly will result in an error.</p>
<!-- @@@Filter -->
<h2>Property Documentation</h2>
<!-- $$$enabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="enabled-prop">
<td class="tblQmlPropNode"><p>
<a name="enabled-prop"></a><span class="name">enabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the filter is enabled. A disabled filter will accept every rows unconditionally (even if it's inverted).</p>
<p>By default, filters are enabled.</p>
</div></div><!-- @@@enabled -->
<br/>
<!-- $$$inverted -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="inverted-prop">
<td class="tblQmlPropNode"><p>
<a name="inverted-prop"></a><span class="name">inverted</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the filter is inverted. When a filter is inverted, a row normally accepted would be rejected, and vice-versa.</p>
<p>By default, filters are not inverted.</p>
</div></div><!-- @@@inverted -->
<br/>
</body>
</html>

View File

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for IndexFilter | 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 IndexFilter</h1>
<p>This is the complete list of members for <a href="qml-indexfilter.html">IndexFilter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-indexfilter.html#maximumIndex-prop">maximumIndex</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-indexfilter.html#minimumIndex-prop">minimumIndex</a></b></b> : int</li>
</ul>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

81
docs/qml-indexfilter.html Normal file
View File

@ -0,0 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>IndexFilter 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">IndexFilter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$IndexFilter-brief -->
<p>Filters rows based on their source index <a href="#details">More...</a></p>
<!-- @@@IndexFilter -->
<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-filter.html">Filter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-indexfilter-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-indexfilter.html#maximumIndex-prop">maximumIndex</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-indexfilter.html#minimumIndex-prop">minimumIndex</a></b></b> : int</li>
</ul>
<!-- $$$IndexFilter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>An <a href="qml-indexfilter.html">IndexFilter</a> is a filter allowing contents to be filtered based on their source model index.</p>
<p>In the following example, only the first row of the source model will be accepted:</p>
<pre class="cpp">SortFilterProxyModel {
sourceModel: contactModel
filters: IndexFilter {
maximumIndex: <span class="number">0</span>
}
}</pre>
<!-- @@@IndexFilter -->
<h2>Property Documentation</h2>
<!-- $$$maximumIndex -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="maximumIndex-prop">
<td class="tblQmlPropNode"><p>
<a name="maximumIndex-prop"></a><span class="name">maximumIndex</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the maximumIndex of the filter. Rows with a source index higher than <code>maximumIndex</code> will be rejected.</p>
<p>If <code>maximumIndex</code> is negative, it is counted from the end of the source model, meaning that:</p>
<pre class="cpp">maximumIndex: <span class="operator">-</span><span class="number">1</span></pre>
<p>is equivalent to :</p>
<pre class="cpp">maximumIndex: sourceModel<span class="operator">.</span>count <span class="operator">-</span> <span class="number">1</span></pre>
<p>By default, no value is set.</p>
</div></div><!-- @@@maximumIndex -->
<br/>
<!-- $$$minimumIndex -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minimumIndex-prop">
<td class="tblQmlPropNode"><p>
<a name="minimumIndex-prop"></a><span class="name">minimumIndex</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the minimumIndex of the filter. Rows with a source index lower than <code>minimumIndex</code> will be rejected.</p>
<p>If <code>minimumIndex</code> is negative, it is counted from the end of the source model, meaning that :</p>
<pre class="cpp">minimumIndex: <span class="operator">-</span><span class="number">1</span></pre>
<p>is equivalent to :</p>
<pre class="cpp">minimumIndex: sourceModel<span class="operator">.</span>count <span class="operator">-</span> <span class="number">1</span></pre>
<p>By default, no value is set.</p>
</div></div><!-- @@@minimumIndex -->
<br/>
</body>
</html>

View File

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for RangeFilter | 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 RangeFilter</h1>
<p>This is the complete list of members for <a href="qml-rangefilter.html">RangeFilter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-rangefilter.html#maximumInclusive-prop">maximumInclusive</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#maximumValue-prop">maximumValue</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#minimumInclusive-prop">minimumInclusive</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#roleName-prop">roleName</a></b></b> : string</li>
</ul>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

118
docs/qml-rangefilter.html Normal file
View File

@ -0,0 +1,118 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>RangeFilter 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">RangeFilter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RangeFilter-brief -->
<p>Filters rows between boundary values <a href="#details">More...</a></p>
<!-- @@@RangeFilter -->
<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-rolefilter.html">RoleFilter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-rangefilter-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-rangefilter.html#maximumInclusive-prop">maximumInclusive</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#maximumValue-prop">maximumValue</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#minimumInclusive-prop">minimumInclusive</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-rangefilter.html#roleName-prop">roleName</a></b></b> : string</li>
</ul>
<!-- $$$RangeFilter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>A <a href="qml-rangefilter.html">RangeFilter</a> is a <a href="qml-rolefilter.html">RoleFilter</a> that accepts rows if their data is between the filter's minimum and maximum value.</p>
<p>In the following example, only rows with their <code>price</code> role set to a value between the tow boundary of the slider will be accepted :</p>
<pre class="cpp">RangeSlider {
id: priceRangeSlider
}
SortFilterProxyModel {
sourceModel: priceModel
filters: RangeFilter {
roleName: <span class="string">&quot;price&quot;</span>
minimumValue: priceRangeSlider<span class="operator">.</span>first<span class="operator">.</span>value
maximumValue: priceRangeSlider<span class="operator">.</span>second<span class="operator">.</span>value
}
}</pre>
<!-- @@@RangeFilter -->
<h2>Property Documentation</h2>
<!-- $$$maximumInclusive -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="maximumInclusive-prop">
<td class="tblQmlPropNode"><p>
<a name="maximumInclusive-prop"></a><span class="name">maximumInclusive</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the <a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a> is inclusive.</p>
<p>By default, the <a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a> is inclusive.</p>
<p><b>See also </b><a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a>.</p>
</div></div><!-- @@@maximumInclusive -->
<br/>
<!-- $$$maximumValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="maximumValue-prop">
<td class="tblQmlPropNode"><p>
<a name="maximumValue-prop"></a><span class="name">maximumValue</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the maximumValue of the filter. Rows with a value higher than <code>maximumValue</code> will be rejected.</p>
<p>By default, no value is set.</p>
<p><b>See also </b><a href="qml-rangefilter.html#maximumInclusive-prop">maximumInclusive</a>.</p>
</div></div><!-- @@@maximumValue -->
<br/>
<!-- $$$minimumInclusive -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minimumInclusive-prop">
<td class="tblQmlPropNode"><p>
<a name="minimumInclusive-prop"></a><span class="name">minimumInclusive</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the <a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a> is inclusive.</p>
<p>By default, the <a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a> is inclusive.</p>
<p><b>See also </b><a href="qml-rangefilter.html#minimumValue-prop">minimumValue</a>.</p>
</div></div><!-- @@@minimumInclusive -->
<br/>
<!-- $$$minimumValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minimumValue-prop">
<td class="tblQmlPropNode"><p>
<a name="minimumValue-prop"></a><span class="name">minimumValue</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the minimumValue of the filter. Rows with a value lower than <code>minimumValue</code> will be rejected.</p>
<p>By default, no value is set.</p>
<p><b>See also </b><a href="qml-rangefilter.html#minimumInclusive-prop">minimumInclusive</a>.</p>
</div></div><!-- @@@minimumValue -->
<br/>
<!-- $$$roleName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="roleName-prop">
<td class="tblQmlPropNode"><p>
<a name="roleName-prop"></a><span class="name">roleName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the role name that the filter is using to query the source model's data when filtering items.</p>
</div></div><!-- @@@roleName -->
<br/>
</body>
</html>

View File

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for RegExpFilter | 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 RegExpFilter</h1>
<p>This is the complete list of members for <a href="qml-regexpfilter.html">RegExpFilter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-regexpfilter.html#caseSensitivity-prop">caseSensitivity</a></b></b> : Qt::CaseSensitivity</li>
<li class="fn"><b><b><a href="qml-regexpfilter.html#pattern-prop">pattern</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-regexpfilter.html#roleName-prop">roleName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-regexpfilter.html#syntax-prop">syntax</a></b></b> : enum</li>
</ul>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

109
docs/qml-regexpfilter.html Normal file
View File

@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>RegExpFilter 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">RegExpFilter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RegExpFilter-brief -->
<p>Filters rows matching a regular expression <a href="#details">More...</a></p>
<!-- @@@RegExpFilter -->
<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-rolefilter.html">RoleFilter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-regexpfilter-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-regexpfilter.html#caseSensitivity-prop">caseSensitivity</a></b></b> : Qt::CaseSensitivity</li>
<li class="fn"><b><b><a href="qml-regexpfilter.html#pattern-prop">pattern</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-regexpfilter.html#roleName-prop">roleName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-regexpfilter.html#syntax-prop">syntax</a></b></b> : enum</li>
</ul>
<!-- $$$RegExpFilter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>A <a href="qml-regexpfilter.html">RegExpFilter</a> is a <a href="qml-rolefilter.html">RoleFilter</a> that accepts rows matching a regular rexpression.</p>
<p>In the following example, only rows with their <code>lastName</code> role beggining with the content of textfield the will be accepted:</p>
<pre class="cpp">TextField {
id: nameTextField
}
SortFilterProxyModel {
sourceModel: contactModel
filters: RegExpFilter {
roleName: <span class="string">&quot;lastName&quot;</span>
pattern: <span class="string">&quot;^&quot;</span> <span class="operator">+</span> nameTextField<span class="operator">.</span>displayText
}
}</pre>
<!-- @@@RegExpFilter -->
<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::CaseSensitivity</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the caseSensitivity of the filter.</p>
</div></div><!-- @@@caseSensitivity -->
<br/>
<!-- $$$pattern -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pattern-prop">
<td class="tblQmlPropNode"><p>
<a name="pattern-prop"></a><span class="name">pattern</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The pattern used to filter the contents of the source model.</p>
<p><b>See also </b><a href="qml-regexpfilter.html#syntax-prop">syntax</a>.</p>
</div></div><!-- @@@pattern -->
<br/>
<!-- $$$roleName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="roleName-prop">
<td class="tblQmlPropNode"><p>
<a name="roleName-prop"></a><span class="name">roleName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the role name that the filter is using to query the source model's data when filtering items.</p>
</div></div><!-- @@@roleName -->
<br/>
<!-- $$$syntax -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="syntax-prop">
<td class="tblQmlPropNode"><p>
<a name="syntax-prop"></a><span class="name">syntax</span> : <span class="type">enum</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The pattern used to filter the contents of the source model.</p>
<p>Only the source model's value having their roleName data matching this <a href="qml-regexpfilter.html#pattern-prop">pattern</a> with the specified syntax will be kept.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>RegExpFilter.RegExp</code></td><td class="topAlign">A rich Perl-like pattern matching syntax. This is the default.</td></tr>
<tr><td class="topAlign"><code>RegExpFilter.Wildcard</code></td><td class="topAlign">This provides a simple pattern matching syntax similar to that used by shells (command interpreters) for &quot;file globbing&quot;.</td></tr>
<tr><td class="topAlign"><code>RegExpFilter.FixedString</code></td><td class="topAlign">The pattern is a fixed string. This is equivalent to using the RegExp pattern on a string in which all metacharacters are escaped.</td></tr>
<tr><td class="topAlign"><code>RegExpFilter.RegExp2</code></td><td class="topAlign">Like RegExp, but with greedy quantifiers.</td></tr>
<tr><td class="topAlign"><code>RegExpFilter.WildcardUnix</code></td><td class="topAlign">This is similar to Wildcard but with the behavior of a Unix shell. The wildcard characters can be escaped with the character &quot;&quot;.</td></tr>
<tr><td class="topAlign"><code>RegExpFilter.W3CXmlSchema11</code></td><td class="topAlign">The pattern is a regular expression as defined by the W3C XML Schema 1.1 specification.</td></tr>
</table></div>
<p><b>See also </b><a href="qml-regexpfilter.html#pattern-prop">pattern</a>.</p>
</div></div><!-- @@@syntax -->
<br/>
</body>
</html>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for RoleFilter | 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 RoleFilter</h1>
<p>This is the complete list of members for <a href="qml-rolefilter.html">RoleFilter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-rolefilter.html#roleName-prop">roleName</a></b></b> : string</li>
</ul>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

54
docs/qml-rolefilter.html Normal file
View File

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>RoleFilter 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">RoleFilter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RoleFilter-brief -->
<p>Base type for filters based on a source model role <a href="#details">More...</a></p>
<!-- @@@RoleFilter -->
<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-filter.html">Filter</a></p>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-rangefilter.html">RangeFilter</a>, <a href="qml-regexpfilter.html">RegExpFilter</a>, and <a href="qml-valuefilter.html">ValueFilter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-rolefilter-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-rolefilter.html#roleName-prop">roleName</a></b></b> : string</li>
</ul>
<!-- $$$RoleFilter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-rolefilter.html">RoleFilter</a> type cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the other filter types that inherit from it. Attempting to use the <a href="qml-rolefilter.html">RoleFilter</a> type directly will result in an error.</p>
<!-- @@@RoleFilter -->
<h2>Property Documentation</h2>
<!-- $$$roleName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="roleName-prop">
<td class="tblQmlPropNode"><p>
<a name="roleName-prop"></a><span class="name">roleName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the role name that the filter is using to query the source model's data when filtering items.</p>
</div></div><!-- @@@roleName -->
<br/>
</body>
</html>

View File

@ -0,0 +1,23 @@
<?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 RoleSorter | 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 RoleSorter</h1>
<p>This is the complete list of members for <a href="qml-rolesorter.html">RoleSorter</a>, including inherited members.</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>

58
docs/qml-rolesorter.html Normal file
View File

@ -0,0 +1,58 @@
<?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>RoleSorter 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">RoleSorter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RoleSorter-brief -->
<p>Sorts rows based on a source model role <a href="#details">More...</a></p>
<!-- @@@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></table></div><ul>
<li><a href="qml-rolesorter-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-rolesorter.html#roleName-prop">roleName</a></b></b> : string</li>
</ul>
<!-- $$$RoleSorter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>A <a href="qml-rolesorter.html">RoleSorter</a> is a simple <a href="qml-sorter.html">Sorter</a> that sorts rows based on a source model role.</p>
<p>In the following example, rows with be sorted by their <code>lastName</code> role :</p>
<pre class="cpp">SortFilterProxyModel {
sourceModel: contactModel
sorters: RoleSorter { roleName: <span class="string">&quot;lastName&quot;</span> }
}</pre>
<!-- @@@RoleSorter -->
<h2>Property Documentation</h2>
<!-- $$$roleName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="roleName-prop">
<td class="tblQmlPropNode"><p>
<a name="roleName-prop"></a><span class="name">roleName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the role name that the sorter is using to query the source model's data when sorting items.</p>
</div></div><!-- @@@roleName -->
<br/>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?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 Sorter | 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 Sorter</h1>
<p>This is the complete list of members for <a href="qml-sorter.html">Sorter</a>, including inherited members.</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>

70
docs/qml-sorter.html Normal file
View File

@ -0,0 +1,70 @@
<?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>Sorter 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">Sorter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Sorter-brief -->
<p>Base type for the <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a> sorters <a href="#details">More...</a></p>
<!-- @@@Sorter -->
<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"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-expressionsorter.html">ExpressionSorter</a> and <a href="qml-rolesorter.html">RoleSorter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-sorter-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-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>
<!-- $$$Sorter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The Sorter type cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the other sorters types that inherit from it. Attempting to use the Sorter type directly will result in an error.</p>
<!-- @@@Sorter -->
<h2>Property Documentation</h2>
<!-- $$$enabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="enabled-prop">
<td class="tblQmlPropNode"><p>
<a name="enabled-prop"></a><span class="name">enabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the sorter is enabled. A disabled sorter will not change the order of the rows.</p>
<p>By default, sorters are enabled.</p>
</div></div><!-- @@@enabled -->
<br/>
<!-- $$$sortOrder -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sortOrder-prop">
<td class="tblQmlPropNode"><p>
<a name="sortOrder-prop"></a><span class="name">sortOrder</span> : <span class="type">Qt::SortOrder</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the sort order of this sorter.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Qt.AscendingOrder</code></td><td class="topAlign">The items are sorted ascending e.g&#x2e; starts with 'AAA' ends with 'ZZZ' in Latin-1 locales</td></tr>
<tr><td class="topAlign"><code>Qt.DescendingOrder</code></td><td class="topAlign">The items are sorted descending e.g&#x2e; starts with 'ZZZ' ends with 'AAA' in Latin-1 locales</td></tr>
</table></div>
<p>By default, sorting is in ascending order.</p>
</div></div><!-- @@@sortOrder -->
<br/>
</body>
</html>

View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlsortfilterproxymodel.cpp -->
<title>List of All Members for SortFilterProxyModel | 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 SortFilterProxyModel</h1>
<p>This is the complete list of members for <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#count-prop">count</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#filters-prop">filters</a></b></b> : list&lt;Filter&gt;</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#sortRoleName-prop">sortRoleName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#sorters-prop">sorters</a></b></b> : list&lt;Sorter&gt;</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#sourceModel-prop">sourceModel</a></b></b> : QAbstractItemModel*</li>
<li class="fn">variant <b><b><a href="qml-sortfilterproxymodel.html#get-method-1">get</a></b></b>(int <i>row</i>, string <i>roleName</i>)</li>
<li class="fn">object <b><b><a href="qml-sortfilterproxymodel.html#get-method">get</a></b></b>(int <i>row</i>)</li>
<li class="fn">int <b><b><a href="qml-sortfilterproxymodel.html#mapFromSource-method-1">mapFromSource</a></b></b>(int <i>sourceRow</i>)</li>
<li class="fn">QModelIndex <b><b><a href="qml-sortfilterproxymodel.html#mapFromSource-method">mapFromSource</a></b></b>(QModelIndex <i>sourceIndex</i>)</li>
<li class="fn">int <b><b><a href="qml-sortfilterproxymodel.html#mapToSource-method-1">mapToSource</a></b></b>(int <i>proxyRow</i>)</li>
<li class="fn">index <b><b><a href="qml-sortfilterproxymodel.html#mapToSource-method">mapToSource</a></b></b>(index <i>proxyIndex</i>)</li>
<li class="fn">int <b><b><a href="qml-sortfilterproxymodel.html#roleForName-method">roleForName</a></b></b>(string <i>roleName</i>)</li>
</ul>
</body>
</html>

View File

@ -0,0 +1,182 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlsortfilterproxymodel.cpp -->
<title>SortFilterProxyModel 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="#methods">Methods</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">SortFilterProxyModel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$SortFilterProxyModel-brief -->
<p>Filters and sorts data coming from a source <a href="http://doc.qt.io/qt-5/qabstractitemmodel.html">QAbstractItemModel</a> <a href="#details">More...</a></p>
<!-- @@@SortFilterProxyModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import .</td></tr></table></div><ul>
<li><a href="qml-sortfilterproxymodel-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-sortfilterproxymodel.html#count-prop">count</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#filters-prop">filters</a></b></b> : list&lt;Filter&gt;</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#sortRoleName-prop">sortRoleName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#sorters-prop">sorters</a></b></b> : list&lt;Sorter&gt;</li>
<li class="fn"><b><b><a href="qml-sortfilterproxymodel.html#sourceModel-prop">sourceModel</a></b></b> : QAbstractItemModel*</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">variant <b><b><a href="qml-sortfilterproxymodel.html#get-method-1">get</a></b></b>(int <i>row</i>, string <i>roleName</i>)</li>
<li class="fn">object <b><b><a href="qml-sortfilterproxymodel.html#get-method">get</a></b></b>(int <i>row</i>)</li>
<li class="fn">int <b><b><a href="qml-sortfilterproxymodel.html#mapFromSource-method-1">mapFromSource</a></b></b>(int <i>sourceRow</i>)</li>
<li class="fn">QModelIndex <b><b><a href="qml-sortfilterproxymodel.html#mapFromSource-method">mapFromSource</a></b></b>(QModelIndex <i>sourceIndex</i>)</li>
<li class="fn">int <b><b><a href="qml-sortfilterproxymodel.html#mapToSource-method-1">mapToSource</a></b></b>(int <i>proxyRow</i>)</li>
<li class="fn">index <b><b><a href="qml-sortfilterproxymodel.html#mapToSource-method">mapToSource</a></b></b>(index <i>proxyIndex</i>)</li>
<li class="fn">int <b><b><a href="qml-sortfilterproxymodel.html#roleForName-method">roleForName</a></b></b>(string <i>roleName</i>)</li>
</ul>
<!-- $$$SortFilterProxyModel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a> type provides support for filtering and sorting data coming from a source model.</p>
<!-- @@@SortFilterProxyModel -->
<h2>Property Documentation</h2>
<!-- $$$count -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="count-prop">
<td class="tblQmlPropNode"><p>
<a name="count-prop"></a><span class="name">count</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The number of rows in the proxy model (not filtered out the source model)</p>
</div></div><!-- @@@count -->
<br/>
<!-- $$$filters -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="filters-prop">
<td class="tblQmlPropNode"><p>
<a name="filters-prop"></a><span class="name">filters</span> : <span class="type">list</span>&lt;<span class="type"><a href="qml-filter.html">Filter</a></span>&gt;</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the list of filters for this proxy model. To be included in the model, a row of the source model has to be accepted by all the top level filters of this list.</p>
<p><b>See also </b><a href="qml-filter.html">Filter</a>.</p>
</div></div><!-- @@@filters -->
<br/>
<!-- $$$sortRoleName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sortRoleName-prop">
<td class="tblQmlPropNode"><p>
<a name="sortRoleName-prop"></a><span class="name">sortRoleName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The role name of the source model's data used for the sorting.</p>
<p><b>See also </b><a href="http://doc.qt.io/qt-5/qsortfilterproxymodel.html#sortRole-prop">sortRole</a> and <a href="qml-sortfilterproxymodel.html#roleForName-method">roleForName</a>.</p>
</div></div><!-- @@@sortRoleName -->
<br/>
<!-- $$$sorters -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sorters-prop">
<td class="tblQmlPropNode"><p>
<a name="sorters-prop"></a><span class="name">sorters</span> : <span class="type">list</span>&lt;<span class="type"><a href="qml-sorter.html">Sorter</a></span>&gt;</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the list of sorters for this proxy model. The rows of the source model are sorted by the sorters of this list, in their order of insertion.</p>
<p><b>See also </b><a href="qml-sorter.html">Sorter</a>.</p>
</div></div><!-- @@@sorters -->
<br/>
<!-- $$$sourceModel -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sourceModel-prop">
<td class="tblQmlPropNode"><p>
<a name="sourceModel-prop"></a><span class="name">sourceModel</span> : <span class="type">QAbstractItemModel</span>*</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The source model of this proxy model</p>
</div></div><!-- @@@sourceModel -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$get -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="get-method-1">
<td class="tblQmlFuncNode"><p>
<a name="get-method-1"></a><span class="type">variant</span> <span class="name">get</span>(<span class="type">int</span> <i>row</i>, <span class="type">string</span> <i>roleName</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Return the data for the given <i>roleNamte</i> of the item at <i>row</i> in the proxy model. This allows the role data to be read (not modified) from JavaScript. This equivalent to calling <code>data(index(row, 0), roleForName(roleName))</code>.</p>
</div></div><!-- @@@get -->
<br/>
<!-- $$$get -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="get-method">
<td class="tblQmlFuncNode"><p>
<a name="get-method"></a><span class="type">object</span> <span class="name">get</span>(<span class="type">int</span> <i>row</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Return the item at <i>row</i> in the proxy model as a map of all its roles. This allows the item data to be read (not modified) from JavaScript.</p>
</div></div><!-- @@@get -->
<br/>
<!-- $$$mapFromSource -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mapFromSource-method-1">
<td class="tblQmlFuncNode"><p>
<a name="mapFromSource-method-1"></a><span class="type">int</span> <span class="name">mapFromSource</span>(<span class="type">int</span> <i>sourceRow</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the row in the <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a> given the <i>sourceRow</i> from the source model. Returns -1 if there is no corresponding row.</p>
</div></div><!-- @@@mapFromSource -->
<br/>
<!-- $$$mapFromSource -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mapFromSource-method">
<td class="tblQmlFuncNode"><p>
<a name="mapFromSource-method"></a><span class="type">QModelIndex</span> <span class="name">mapFromSource</span>(<span class="type">QModelIndex</span> <i>sourceIndex</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the model index in the <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a> given the sourceIndex from the source model.</p>
</div></div><!-- @@@mapFromSource -->
<br/>
<!-- $$$mapToSource -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mapToSource-method-1">
<td class="tblQmlFuncNode"><p>
<a name="mapToSource-method-1"></a><span class="type">int</span> <span class="name">mapToSource</span>(<span class="type">int</span> <i>proxyRow</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the source model row corresponding to the given <i>proxyRow</i> from the <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a>. Returns -1 if there is no corresponding row.</p>
</div></div><!-- @@@mapToSource -->
<br/>
<!-- $$$mapToSource -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mapToSource-method">
<td class="tblQmlFuncNode"><p>
<a name="mapToSource-method"></a><span class="type">index</span> <span class="name">mapToSource</span>(<span class="type">index</span> <i>proxyIndex</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the source model index corresponding to the given <i>proxyIndex</i> from the <a href="qml-sortfilterproxymodel.html">SortFilterProxyModel</a>.</p>
</div></div><!-- @@@mapToSource -->
<br/>
<!-- $$$roleForName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="roleForName-method">
<td class="tblQmlFuncNode"><p>
<a name="roleForName-method"></a><span class="type">int</span> <span class="name">roleForName</span>(<span class="type">string</span> <i>roleName</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the role number for the given <i>roleName</i>. If no role is found for this <i>roleName</i>, <code>-1</code> is returned.</p>
</div></div><!-- @@@roleForName -->
<br/>
</body>
</html>

View File

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>List of All Members for ValueFilter | 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 ValueFilter</h1>
<p>This is the complete list of members for <a href="qml-valuefilter.html">ValueFilter</a>, including inherited members.</p>
<ul>
<li class="fn"><b><b><a href="qml-valuefilter.html#roleName-prop">roleName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-valuefilter.html#value-prop">value</a></b></b> : variant</li>
</ul>
<p>The following members are inherited from <a href="qml-filter.html">Filter</a>.</p>
<ul>
<li class="fn"><b><b><a href="qml-filter.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-filter.html#inverted-prop">inverted</a></b></b> : bool</li>
</ul>
</body>
</html>

77
docs/qml-valuefilter.html Normal file
View File

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filter.cpp -->
<title>ValueFilter 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">ValueFilter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ValueFilter-brief -->
<p>Filters rows matching exactly a value <a href="#details">More...</a></p>
<!-- @@@ValueFilter -->
<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-rolefilter.html">RoleFilter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-valuefilter-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-valuefilter.html#roleName-prop">roleName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-valuefilter.html#value-prop">value</a></b></b> : variant</li>
</ul>
<!-- $$$ValueFilter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>A <a href="qml-valuefilter.html">ValueFilter</a> is a simple <a href="qml-rolefilter.html">RoleFilter</a> that accepts rows matching exactly the filter's value</p>
<p>In the following example, only rows with their <code>favorite</code> role set to <code>true</code> will be accepted when the checkbox is checked :</p>
<pre class="cpp">CheckBox {
id: showOnlyFavoriteCheckBox
}
SortFilterProxyModel {
sourceModel: contactModel
filters: ValueFilter {
roleName: <span class="string">&quot;favorite&quot;</span>
value: <span class="keyword">true</span>
enabled: showOnlyFavoriteCheckBox<span class="operator">.</span>checked
}
}</pre>
<!-- @@@ValueFilter -->
<h2>Property Documentation</h2>
<!-- $$$roleName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="roleName-prop">
<td class="tblQmlPropNode"><p>
<a name="roleName-prop"></a><span class="name">roleName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the role name that the filter is using to query the source model's data when filtering items.</p>
</div></div><!-- @@@roleName -->
<br/>
<!-- $$$value -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="value-prop">
<td class="tblQmlPropNode"><p>
<a name="value-prop"></a><span class="name">value</span> : <span class="type">variant</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the value used to filter the contents of the source model.</p>
</div></div><!-- @@@value -->
<br/>
</body>
</html>

View File

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE QDOCINDEX>
<INDEX url="" title="lol" version="" project="SortFilterProxyModel">
<namespace threadsafety="unspecified" name="" status="active" access="public" module="sortfilterproxymodel">
<qmlclass threadsafety="unspecified" name="AllOf" qml-module-name="AllOf" qml-base-type="::Filter" href="qml-allof.html" status="active" access="public" title="AllOf" fulltitle="AllOf" subtitle="" brief="Filter container accepting rows accepted by all its child filters"/>
<qmlclass threadsafety="unspecified" name="AnyOf" qml-module-name="AnyOf" qml-base-type="::Filter" href="qml-anyof.html" status="active" access="public" title="AnyOf" fulltitle="AnyOf" subtitle="" brief="Filter container accepting rows accepted by at least one of its child filters"/>
<qmlclass threadsafety="unspecified" name="ExpressionFilter" qml-module-name="ExpressionFilter" qml-base-type="::Filter" href="qml-expressionfilter.html" status="active" access="public" title="ExpressionFilter" fulltitle="ExpressionFilter" subtitle="" brief="Filters row with a custom filtering">
<qmlproperty threadsafety="unspecified" name="expression" fullname="ExpressionFilter::expression" href="qml-expressionfilter.html#expression-prop" status="active" access="public" type="expression" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="Filter" qml-module-name="Filter" href="qml-filter.html" status="active" access="public" title="Filter" fulltitle="Filter" subtitle="" brief="Base type for the SortFilterProxyModel filters">
<qmlproperty threadsafety="unspecified" name="enabled" fullname="Filter::enabled" href="qml-filter.html#enabled-prop" status="active" access="public" type="bool" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="inverted" fullname="Filter::inverted" href="qml-filter.html#inverted-prop" status="active" access="public" type="bool" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="IndexFilter" qml-module-name="IndexFilter" qml-base-type="::Filter" href="qml-indexfilter.html" status="active" access="public" title="IndexFilter" fulltitle="IndexFilter" subtitle="" brief="Filters rows based on their source index">
<qmlproperty threadsafety="unspecified" name="maximumIndex" fullname="IndexFilter::maximumIndex" href="qml-indexfilter.html#maximumIndex-prop" status="active" access="public" type="int" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="minimumIndex" fullname="IndexFilter::minimumIndex" href="qml-indexfilter.html#minimumIndex-prop" status="active" access="public" type="int" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="RangeFilter" qml-module-name="RangeFilter" qml-base-type="::RoleFilter" href="qml-rangefilter.html" status="active" access="public" title="RangeFilter" fulltitle="RangeFilter" subtitle="" brief="Filters rows between boundary values">
<qmlproperty threadsafety="unspecified" name="maximumInclusive" fullname="RangeFilter::maximumInclusive" href="qml-rangefilter.html#maximumInclusive-prop" status="active" access="public" type="int" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="maximumValue" fullname="RangeFilter::maximumValue" href="qml-rangefilter.html#maximumValue-prop" status="active" access="public" type="int" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="minimumInclusive" fullname="RangeFilter::minimumInclusive" href="qml-rangefilter.html#minimumInclusive-prop" status="active" access="public" type="int" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="minimumValue" fullname="RangeFilter::minimumValue" href="qml-rangefilter.html#minimumValue-prop" status="active" access="public" type="int" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="RegExpFilter" qml-module-name="RegExpFilter" qml-base-type="::RoleFilter" href="qml-regexpfilter.html" status="active" access="public" title="RegExpFilter" fulltitle="RegExpFilter" subtitle="" brief="Filters rows matching a regular expression">
<qmlproperty threadsafety="unspecified" name="caseSensitivity" fullname="RegExpFilter::caseSensitivity" href="qml-regexpfilter.html#caseSensitivity-prop" status="active" access="public" type="Qt::CaseSensitivity" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="pattern" fullname="RegExpFilter::pattern" href="qml-regexpfilter.html#pattern-prop" status="active" access="public" type="bool" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="syntax" fullname="RegExpFilter::syntax" href="qml-regexpfilter.html#syntax-prop" status="active" access="public" type="enum" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="RoleFilter" qml-module-name="RoleFilter" qml-base-type="::Filter" href="qml-rolefilter.html" status="active" access="public" abstract="true" title="RoleFilter" fulltitle="RoleFilter" subtitle="" brief="Base type for filters based on a source model role">
<qmlproperty threadsafety="unspecified" name="roleName" fullname="RoleFilter::roleName" status="active" access="public" type="string" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="ValueFilter" qml-module-name="ValueFilter" qml-base-type="::RoleFilter" href="qml-valuefilter.html" status="active" access="public" title="ValueFilter" fulltitle="ValueFilter" subtitle="" brief="Filters rows matching exactly a value">
<qmlproperty threadsafety="unspecified" name="value" fullname="ValueFilter::value" href="qml-valuefilter.html#value-prop" status="active" access="public" type="variant" attached="false" writable="true"/>
</qmlclass>
<page name="index.html" href="index.html" status="active" subtype="page" title="SortFilterProxyModel QML Module" fulltitle="SortFilterProxyModel QML Module" subtitle="" module="SortFilterProxyModel"/>
<qmlclass threadsafety="unspecified" name="SortFilterProxyModel" qml-module-name="SortFilterProxyModel" href="qml-sortfilterproxymodel.html" status="active" access="public" title="SortFilterProxyModel" fulltitle="SortFilterProxyModel" subtitle="" brief="Filters and sorts data coming from a source QAbstractItemModel">
<qmlproperty threadsafety="unspecified" name="count" fullname="SortFilterProxyModel::count" href="qml-sortfilterproxymodel.html#count-prop" status="active" access="public" type="int" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="filters" fullname="SortFilterProxyModel::filters" href="qml-sortfilterproxymodel.html#filters-prop" status="active" access="public" type="list&lt;Filter&gt;" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="sortRoleName" fullname="SortFilterProxyModel::sortRoleName" href="qml-sortfilterproxymodel.html#sortRoleName-prop" status="active" access="public" type="string" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="sorters" fullname="SortFilterProxyModel::sorters" href="qml-sortfilterproxymodel.html#sorters-prop" status="active" access="public" type="list&lt;Sorter&gt;" attached="false" writable="true"/>
<qmlproperty threadsafety="unspecified" name="sourceModel" fullname="SortFilterProxyModel::sourceModel" href="qml-sortfilterproxymodel.html#sourceModel-prop" status="active" access="public" type="QAbstractItemModel*" attached="false" writable="true"/>
<qmlmethod threadsafety="unspecified" name="get" fullname="SortFilterProxyModel::get" href="qml-sortfilterproxymodel.html#get-method" status="active" access="public"/>
<qmlmethod threadsafety="unspecified" name="get" fullname="SortFilterProxyModel::get" href="qml-sortfilterproxymodel.html#get-method" status="active" access="public"/>
<qmlmethod threadsafety="unspecified" name="mapFromSource" fullname="SortFilterProxyModel::mapFromSource" href="qml-sortfilterproxymodel.html#mapFromSource-method" status="active" access="public"/>
<qmlmethod threadsafety="unspecified" name="mapFromSource" fullname="SortFilterProxyModel::mapFromSource" href="qml-sortfilterproxymodel.html#mapFromSource-method" status="active" access="public"/>
<qmlmethod threadsafety="unspecified" name="mapToSource" fullname="SortFilterProxyModel::mapToSource" href="qml-sortfilterproxymodel.html#mapToSource-method" status="active" access="public"/>
<qmlmethod threadsafety="unspecified" name="mapToSource" fullname="SortFilterProxyModel::mapToSource" href="qml-sortfilterproxymodel.html#mapToSource-method" status="active" access="public"/>
<qmlmethod threadsafety="unspecified" name="roleForName" fullname="SortFilterProxyModel::roleForName" href="qml-sortfilterproxymodel.html#roleForName-method" status="active" access="public"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="ExpressionSorter" qml-module-name="ExpressionSorter" qml-base-type="::Sorter" href="qml-expressionsorter.html" status="active" access="public" title="ExpressionSorter" fulltitle="ExpressionSorter" subtitle="" brief="Sorts row with a custom sorting">
<qmlproperty threadsafety="unspecified" name="expression" fullname="ExpressionSorter::expression" href="qml-expressionsorter.html#expression-prop" status="active" access="public" type="expression" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="RoleSorter" qml-module-name="RoleSorter" qml-base-type="::Sorter" href="qml-rolesorter.html" status="active" access="public" title="RoleSorter" fulltitle="RoleSorter" subtitle="" brief="Sorts rows based on a source model role">
<qmlproperty threadsafety="unspecified" name="roleName" fullname="RoleSorter::roleName" href="qml-rolesorter.html#roleName-prop" status="active" access="public" type="string" attached="false" writable="true"/>
</qmlclass>
<qmlclass threadsafety="unspecified" name="Sorter" qml-module-name="Sorter" href="qml-sorter.html" status="active" access="public" title="Sorter" fulltitle="Sorter" subtitle="" brief="Base type for the SortFilterProxyModel sorters">
<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="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="">
<qmlproperty threadsafety="unspecified" name="filters" fullname="tst_indexfilter::filters" href="qml-tst-indexfilter.html#filters-prop" status="active" access="public" location="tst_indexfilter.qml" filepath="D:/coding/SortFilterProxyModel/tests/tst_indexfilter.qml" lineno="7" type="IndexFilter" attached="false" writable="true"/>
</qmlclass>
<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_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"/>
</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"/>
</namespace>
</INDEX>

782
docs/style/offline.css Normal file
View File

@ -0,0 +1,782 @@
body {
font: normal 400 14px/1.2 Arial;
margin-top: 85px;
font-family: Arial, Helvetica;
text-align: left;
margin-left: 5px;
margin-right: 5px;
background-color: #fff;
}
p {
line-height: 20px
}
img {
margin-left: 0px;
max-width: 800px;
height: auto;
}
.content .border img {
box-shadow:3px 3px 8px 3px rgba(200,200,200,0.5)
}
.content .border .player {
box-shadow:3px 3px 8px 3px rgba(200,200,200,0.5)
}
.content .indexboxcont li {
font: normal bold 13px/1 Verdana
}
.content .normallist li {
font: normal 13px/1 Verdana
}
.descr {
margin-top: 35px;
margin-bottom: 45px;
margin-left: 5px;
text-align: left;
vertical-align: top;
}
.name {
max-width: 75%;
font-weight: 100;
}
tt {
text-align: left
}
/*
-----------
links
-----------
*/
a:link {
color: #007330;
text-decoration: none;
text-align: left;
}
a.qa-mark:target:before {
content: "***";
color: #ff0000;
}
a:hover {
color: #44a51c;
text-align: left;
}
a:visited {
color: #007330;
text-align: left;
}
a:visited:hover {
color: #44a51c;
text-align: left;
}
/*
-----------
offline viewing: HTML links display an icon
-----------
*/
a[href*="http://"], a[href*="ftp://"], a[href*="https://"] {
text-decoration: none;
background-image: url(../images/ico_out.png);
background-repeat: no-repeat;
background-position: left;
padding-left: 20px;
text-align: left;
}
.flags {
text-decoration: none;
text-height: 24px;
}
.flags:target {
background-color: #FFFFD6;
}
/*
-------------------------------
NOTE styles
-------------------------------
*/
.notetitle, .tiptitle, .fastpathtitle {
font-weight: bold
}
.attentiontitle, .cautiontitle, .dangertitle, .importanttitle, .remembertitle, .restrictiontitle {
font-weight: bold
}
.note, .tip, .fastpath {
background: #F2F2F2 url(../images/ico_note.png);
background-repeat: no-repeat;
background-position: top left;
padding: 5px;
padding-left: 40px;
padding-bottom: 10px;
border: #999 1px dotted;
color: #666666;
margin: 5px;
}
.attention, .caution, .danger, .important, .remember, .restriction {
background: #F2F2F2 url(../images/ico_note_attention.png);
background-repeat: no-repeat;
background-position: top left;
padding: 5px;
padding-left: 40px;
padding-bottom: 10px;
border: #999 1px dotted;
color: #666666;
margin: 5px;
}
/*
-------------------------------
Top navigation
-------------------------------
*/
.qtref {
display: block;
position: relative;
height: 15px;
z-index: 1;
font-size: 11px;
padding-right: 10px;
float: right;
}
.naviNextPrevious {
clear: both;
display: block;
position: relative;
text-align: right;
top: -47px;
float: right;
height: 20px;
z-index: 1;
padding-right: 10px;
padding-top: 2px;
vertical-align: top;
margin: 0px;
}
.naviNextPrevious > a:first-child {
background-image: url(../images/btn_prev.png);
background-repeat: no-repeat;
background-position: left;
padding-left: 20px;
height: 20px;
padding-left: 20px;
}
.naviNextPrevious > a:last-child {
background-image: url(../images/btn_next.png);
background-repeat: no-repeat;
background-position: right;
padding-right: 20px;
height: 20px;
margin-left: 30px;
}
.naviSeparator { display: none }
/*
-----------
footer and license
-----------
*/
.footer {
text-align: left;
padding-top: 45px;
padding-left: 5px;
margin-top: 45px;
margin-bottom: 45px;
font-size: 10px;
border-top: 1px solid #999;
}
.footer p {
line-height: 14px;
font-size: 11px;
padding: 0;
margin: 0;
}
.footer a[href*="http://"], a[href*="ftp://"], a[href*="https://"] {
font-weight: bold;
}
.footerNavi {
width: auto;
text-align: right;
margin-top: 50px;
z-index: 1;
}
.navigationbar {
display: block;
position: relative;
top: -20px;
border-top: 1px solid #cecece;
border-bottom: 1px solid #cecece;
background-color: #F2F2F2;
z-index: 1;
height: 20px;
padding-left: 7px;
margin: 0px;
padding-top: 2px;
margin-left: -5px;
margin-right: -5px;
}
.navigationbar .first {
background: url(../images/home.png);
background-position: left;
background-repeat: no-repeat;
padding-left: 20px;
}
.navigationbar ul {
margin: 0px;
padding: 0px;
}
.navigationbar ul li {
list-style-type: none;
padding-top: 2px;
padding-left: 4px;
margin: 0;
height: 20px;
}
.navigationbar li {
float: left
}
.navigationbar li a, .navigationbar td a {
display: block;
text-decoration: none;
background: url(../images/arrow_bc.png);
background-repeat: no-repeat;
background-position: right;
padding-right: 17px;
}
table.buildversion {
float: right;
margin-top: -18px !important;
}
.navigationbar table {
border-radius: 0;
border: 0 none;
background-color: #F2F2F2;
margin: 0;
}
.navigationbar table td {
padding: 0;
border: 0 none;
}
#buildversion {
font-style: italic;
font-size: small;
float: right;
margin-right: 5px;
}
/*
/* table of content
no display
*/
/*
-----------
headers
-----------
*/
@media screen {
.title {
color: #313131;
font-size: 24px;
font-weight: normal;
left: 0;
padding-bottom: 20px;
padding-left: 10px;
padding-top: 20px;
position: absolute;
right: 0;
top: 0;
background-color: #E6E6E6;
border-bottom: 1px #CCC solid;
border-top: 2px #CCC solid;
font-weight: bold;
margin-left: 0px;
margin-right: 0px;
}
.subtitle, .small-subtitle {
display: block;
clear: left;
}
}
h1 {
margin: 0
}
h2, p.h2 {
font: 500 16px/1.2 Arial;
font-weight: 100;
background-color: #F2F3F4;
padding: 4px;
margin-bottom: 30px;
margin-top: 30px;
border-top: #E0E0DE 1px solid;
border-bottom: #E0E0DE 1px solid;
max-width: 99%;
}
h2:target {
background-color: #F2F3D4;
}
h3 {
font: 500 14px/1.2 Arial;
font-weight: 100;
text-decoration: underline;
margin-bottom: 30px;
margin-top: 30px;
}
h3.fn, span.fn {
border-width: 1px;
border-style: solid;
border-color: #E6E6E6;
-moz-border-radius: 7px 7px 7px 7px;
-webkit-border-radius: 7px 7px 7px 7px;
border-radius: 7px 7px 7px 7px;
background-color: #F6F6F6;
word-spacing: 3px;
padding: 5px 5px;
text-decoration: none;
font-weight: bold;
max-width: 75%;
font-size: 14px;
margin: 0px;
margin-top: 45px;
}
h3.fn code {
float: right;
}
h3.fn:target {
background-color: #F6F6D6;
}
.name {
color: #1A1A1A
}
.type {
color: #808080
}
@media print {
.title {
color: #0066CB;
font-family: Arial, Helvetica;
font-size: 32px;
font-weight: normal;
left: 0;
position: absolute;
right: 0;
top: 0;
}
}
/*
-----------------
table styles
-----------------
*/
.table img {
border: none;
margin-left: 0px;
-moz-box-shadow: 0px 0px 0px #fff;
-webkit-box-shadow: 0px 0px 0px #fff;
box-shadow: 0px 0px 0px #fff;
}
/* table with border alternative colours*/
table, pre, .LegaleseLeft {
-moz-border-radius: 7px 7px 7px 7px;
-webkit-border-radius: 7px 7px 7px 7px;
border-radius: 7px 7px 7px 7px;
background-color: #F6F6F6;
border: 1px solid #E6E6E6;
border-collapse: separate;
margin-bottom: 25px;
margin-left: 15px;
font-size: 12px;
line-height: 1.2;
}
table tr.even {
background-color: white;
color: #66666E;
}
table tr.odd {
background-color: #F6F6F6;
color: #66666E;
}
table tr:target {
background-color: #F6F6D6;
}
table thead {
text-align: left;
padding-left: 20px;
background-color: #e1e0e0;
border-left: none;
border-right: none;
}
table thead th {
padding-top: 5px;
padding-left: 10px;
padding-bottom: 5px;
border-bottom: 2px solid #D1D1D1;
padding-right: 10px;
}
table th {
text-align: left;
padding-left: 20px;
}
table td {
padding: 3px 15px 3px 20px;
border-bottom: #CCC dotted 1px;
}
table p {
margin: 0px
}
.LegaleseLeft {
font-family: monospace;
white-space: pre-wrap;
}
/* table bodless & white*/
.borderless {
border-radius: 0px 0px 0px 0px;
background-color: #fff;
border: 1px solid #fff;
}
.borderless tr {
background-color: #FFF;
color: #66666E;
}
.borderless td {
border: none;
border-bottom: #fff dotted 1px;
}
/*
-----------
List
-----------
*/
ul {
margin-top: 10px;
}
li {
margin-bottom: 10px;
padding-left: 8px;
list-style: outside;
text-align: left;
}
ul > li {
list-style-type: square;
}
ol {
margin: 10px;
padding: 0;
}
ol.A > li {
list-style-type: upper-alpha;
}
ol.a > li{
list-style-type: lower-alpha;
}
ol > li {
margin-left: 30px;
padding-left: 8px;
list-style: decimal;
}
.centerAlign {
text-align: left
}
.cpp, .LegaleseLeft {
display: block;
margin: 10px;
overflow: auto;
padding: 20px 20px 20px 20px;
}
.js {
display: block;
margin: 10px;
overflow: auto;
padding: 20px 20px 20px 20px;
}
.memItemLeft {
padding-right: 3px
}
.memItemRight {
padding: 3px 15px 3px 0
}
.qml {
display: block;
margin: 10px;
overflow: auto;
padding: 20px 20px 20px 20px;
}
.qmldefault {
padding-left: 5px;
float: right;
color: red;
}
.qmlreadonly {
padding-left: 5px;
float: right;
color: #254117;
}
.rightAlign {
padding: 3px 5px 3px 10px;
text-align: right;
}
.qmldoc {
margin-left: 15px
}
.flowList {
padding: 25px
}
.flowList dd {
display: inline-block;
margin-left: 10px;
width: 255px;
line-height: 1.15em;
overflow-x: hidden;
text-overflow: ellipsis
}
.alphaChar {
font-size: 2em;
position: relative
}
/*
-----------
Content table
-----------
*/
@media print {
.toc {
float: right;
clear: right;
padding-bottom: 10px;
padding-top: 50px;
width: 100%;
background-image: url(../images/bgrContent.png);
background-position: top;
background-repeat: no-repeat;
}
}
@media screen {
.toc {
float: right;
clear: right;
vertical-align: top;
-moz-border-radius: 7px 7px 7px 7px;
-webkit-border-radius: 7px 7px 7px 7px;
border-radius: 7px 7px 7px 7px;
background: #FFF url('../images/bgrContent.png');
background-position: top;
background-repeat: repeat-x;
border: 1px solid #E6E6E6;
padding-left: 5px;
padding-bottom: 10px;
height: auto;
width: 200px;
text-align: left;
margin-left: 20px;
}
}
.toc h3 {
text-decoration: none
}
.toc h3 {
font: 500 14px/1.2 Arial;
font-weight: 100;
padding: 0px;
margin: 0px;
padding-top: 5px;
padding-left: 5px;
}
.toc ul {
padding-left: 10px;
padding-right: 5px;
}
.toc ul li {
margin-left: 15px;
list-style-image: url(../images/bullet_dn.png);
marker-offset: 0px;
margin-bottom: 8px;
padding-left: 0px;
}
.toc .level1 {
border: none
}
.toc .level2 {
border: none;
margin-left: 25px;
}
.level3 {
border: none;
margin-left: 30px;
}
.clearfix {
clear: both
}
/*
-----------
Landing page
-----------
*/
.col-group {
white-space: nowrap;
vertical-align: top;
}
.landing h2 {
background-color: transparent;
border: none;
margin-bottom: 0px;
font-size: 18px;
}
.landing a, .landing li {
font-size: 13px;
font-weight: bold !important;
}
.col-1 {
display: inline-block;
white-space: normal;
width: 70%;
height: 100%;
float: left;
}
.col-2 {
display: inline-block;
white-space: normal;
width: 20%;
margin-left: 5%;
position: relative;
top: -20px;
}
.col-1 h1 {
margin: 20px 0 0 0;
}
.col-1 h2 {
font-size: 18px;
font-weight: bold !important;
}
.landingicons {
display: inline-block;
width: 100%;
}
.icons1of3 {
display: inline-block;
width: 33.3333%;
float: left;
}
.icons1of3 h2, .doc-column h2 {
font-size: 15px;
margin: 0px;
padding: 0px;
}
div.multi-column {
position: relative;
}
div.multi-column div {
display: -moz-inline-box;
display: inline-block;
vertical-align: top;
margin-top: 1em;
margin-right: 4em;
width: 24em;
}