From f77d37178607f212d0d33aefc45519f42d942504 Mon Sep 17 00:00:00 2001 From: Grecko Date: Mon, 1 Oct 2018 21:24:50 +0200 Subject: [PATCH] doc: regenerate doc --- docs/index.html | 14 +++-- docs/qml-allof-members.html | 2 +- docs/qml-allof.html | 2 +- docs/qml-anyof-members.html | 2 +- docs/qml-anyof.html | 2 +- docs/qml-expressionfilter-members.html | 2 +- docs/qml-expressionfilter.html | 2 +- docs/qml-expressionrole-members.html | 6 +- docs/qml-expressionrole.html | 4 +- docs/qml-expressionsorter-members.html | 2 +- docs/qml-expressionsorter.html | 2 +- docs/qml-filterrole-members.html | 22 +++++++ docs/qml-filterrole.html | 61 +++++++++++++++++++ docs/qml-filtersorter-members.html | 23 ++++++++ docs/qml-filtersorter.html | 60 +++++++++++++++++++ docs/qml-indexfilter-members.html | 2 +- docs/qml-indexfilter.html | 2 +- docs/qml-joinrole-members.html | 6 +- docs/qml-joinrole.html | 4 +- docs/qml-proxyrole-members.html | 3 - docs/qml-proxyrole.html | 19 +----- docs/qml-rangefilter-members.html | 2 +- docs/qml-rangefilter.html | 2 +- docs/qml-regexpfilter-members.html | 2 +- docs/qml-regexpfilter.html | 4 +- docs/qml-regexprole-members.html | 20 +++++++ docs/qml-regexprole.html | 82 ++++++++++++++++++++++++++ docs/qml-rolefilter-members.html | 2 +- docs/qml-rolefilter.html | 2 +- docs/qml-rolesorter-members.html | 2 +- docs/qml-rolesorter.html | 2 +- docs/qml-singlerole-members.html | 18 ++++++ docs/qml-singlerole.html | 53 +++++++++++++++++ docs/qml-sorter.html | 2 +- docs/qml-stringsorter-members.html | 2 +- docs/qml-stringsorter.html | 2 +- docs/qml-switchrole-members.html | 6 +- docs/qml-switchrole.html | 6 +- docs/qml-valuefilter-members.html | 2 +- docs/qml-valuefilter.html | 2 +- docs/sortfilterproxymodel.index | 68 +++++++++++++-------- 41 files changed, 432 insertions(+), 91 deletions(-) create mode 100644 docs/qml-filterrole-members.html create mode 100644 docs/qml-filterrole.html create mode 100644 docs/qml-filtersorter-members.html create mode 100644 docs/qml-filtersorter.html create mode 100644 docs/qml-regexprole-members.html create mode 100644 docs/qml-regexprole.html create mode 100644 docs/qml-singlerole-members.html create mode 100644 docs/qml-singlerole.html diff --git a/docs/index.html b/docs/index.html index 56c0222..ec8e798 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,11 +25,15 @@

RoleFilter

Base type for filters based on a source model role

ValueFilter

Filters rows matching exactly a value

ExpressionRole

A custom role computed from a javascrip expression

-

JoinRole

Role made from concatenating other roles

-

ProxyRole

Base type for the SortFilterProxyModel proxy roles

-

SwitchRole

Role using Filter to conditionnaly compute its data

-

SortFilterProxyModel

Filters and sorts data coming from a source QAbstractItemModel

-

ExpressionSorter

Sorts row with a custom sorting

+

FilterRole

A role resolving to true for rows matching all its filters

+

JoinRole

Role made from concatenating other roles

+

ProxyRole

Base type for the SortFilterProxyModel proxy roles

+

RegExpRole

A ProxyRole extracting data from a source role via a regular expression

+

SingleRole

Base type for the SortFilterProxyModel proxy roles defining a single role

+

SwitchRole

A role using Filter to conditionnaly compute its data

+

SortFilterProxyModel

Filters and sorts data coming from a source QAbstractItemModel

+

ExpressionSorter

Sorts row with a custom sorting

+

FilterSorter

Sorts rows based on if they match filters

RoleSorter

Sorts rows based on a source model role

Sorter

Base type for the SortFilterProxyModel sorters

StringSorter

Sorts rows based on a source model string role

diff --git a/docs/qml-allof-members.html b/docs/qml-allof-members.html index 36cdeee..1878d0c 100644 --- a/docs/qml-allof-members.html +++ b/docs/qml-allof-members.html @@ -3,7 +3,7 @@ - + List of All Members for AllOf | SortFilterProxyModel diff --git a/docs/qml-allof.html b/docs/qml-allof.html index 14948b7..b02053c 100644 --- a/docs/qml-allof.html +++ b/docs/qml-allof.html @@ -3,7 +3,7 @@ - + AllOf QML Type | SortFilterProxyModel diff --git a/docs/qml-anyof-members.html b/docs/qml-anyof-members.html index 3bfaa29..17972ac 100644 --- a/docs/qml-anyof-members.html +++ b/docs/qml-anyof-members.html @@ -3,7 +3,7 @@ - + List of All Members for AnyOf | SortFilterProxyModel diff --git a/docs/qml-anyof.html b/docs/qml-anyof.html index c1e8a74..84a5e07 100644 --- a/docs/qml-anyof.html +++ b/docs/qml-anyof.html @@ -3,7 +3,7 @@ - + AnyOf QML Type | SortFilterProxyModel diff --git a/docs/qml-expressionfilter-members.html b/docs/qml-expressionfilter-members.html index d7a5b21..3dbf4dd 100644 --- a/docs/qml-expressionfilter-members.html +++ b/docs/qml-expressionfilter-members.html @@ -3,7 +3,7 @@ - + List of All Members for ExpressionFilter | SortFilterProxyModel diff --git a/docs/qml-expressionfilter.html b/docs/qml-expressionfilter.html index d79c0a9..f6f0457 100644 --- a/docs/qml-expressionfilter.html +++ b/docs/qml-expressionfilter.html @@ -3,7 +3,7 @@ - + ExpressionFilter QML Type | SortFilterProxyModel diff --git a/docs/qml-expressionrole-members.html b/docs/qml-expressionrole-members.html index b05f7f3..8f640d3 100644 --- a/docs/qml-expressionrole-members.html +++ b/docs/qml-expressionrole-members.html @@ -3,7 +3,7 @@ - + List of All Members for ExpressionRole | SortFilterProxyModel @@ -14,9 +14,9 @@ -

The following members are inherited from ProxyRole.

+

The following members are inherited from SingleRole.

diff --git a/docs/qml-expressionrole.html b/docs/qml-expressionrole.html index b3e1366..d8d2c57 100644 --- a/docs/qml-expressionrole.html +++ b/docs/qml-expressionrole.html @@ -3,7 +3,7 @@ - + ExpressionRole QML Type | SortFilterProxyModel @@ -23,7 +23,7 @@

A custom role computed from a javascrip expression More...

-
Import Statement: import .
Inherits:

ProxyRole

+
Import Statement: import .
Inherits:

SingleRole

diff --git a/docs/qml-expressionsorter-members.html b/docs/qml-expressionsorter-members.html index 9216a37..89c89d7 100644 --- a/docs/qml-expressionsorter-members.html +++ b/docs/qml-expressionsorter-members.html @@ -3,7 +3,7 @@ - + List of All Members for ExpressionSorter | SortFilterProxyModel diff --git a/docs/qml-expressionsorter.html b/docs/qml-expressionsorter.html index 2576f81..e1ec4ce 100644 --- a/docs/qml-expressionsorter.html +++ b/docs/qml-expressionsorter.html @@ -3,7 +3,7 @@ - + ExpressionSorter QML Type | SortFilterProxyModel diff --git a/docs/qml-filterrole-members.html b/docs/qml-filterrole-members.html new file mode 100644 index 0000000..70af5d1 --- /dev/null +++ b/docs/qml-filterrole-members.html @@ -0,0 +1,22 @@ + + + + + + + List of All Members for FilterRole | SortFilterProxyModel + + + +
+

List of All Members for FilterRole

+

This is the complete list of members for FilterRole, including inherited members.

+ +

The following members are inherited from SingleRole.

+ + + diff --git a/docs/qml-filterrole.html b/docs/qml-filterrole.html new file mode 100644 index 0000000..02c1fce --- /dev/null +++ b/docs/qml-filterrole.html @@ -0,0 +1,61 @@ + + + + + + + FilterRole QML Type | SortFilterProxyModel + + + +
+
+

Contents

+ +
+
+

FilterRole QML Type

+ + +

A role resolving to true for rows matching all its filters More...

+ +
+
Import Statement: import .
Inherits:

SingleRole

+
+ +

Properties

+ + + +

Detailed Description

+

A FilterRole is a ProxyRole that returns true for rows matching all its filters.

+

In the following example, the isAdult role will be equal to true if the age role is superior or equal to 18.

+
SortFilterProxyModel {
+    sourceModel: personModel
+    proxyRoles: FilterRole {
+        name: "isAdult"
+        RangeFilter { roleName: "age"; minimumValue: 18; minimumInclusive: true }
+    }
+}
+ +

Property Documentation

+ +
+
+ + +

+filters : string

+

This property holds the list of filters for this filter role. The data of this role will be equal to the true if all its filters match the model row, false otherwise.

+

See also Filter.

+
+
+ + diff --git a/docs/qml-filtersorter-members.html b/docs/qml-filtersorter-members.html new file mode 100644 index 0000000..7afca22 --- /dev/null +++ b/docs/qml-filtersorter-members.html @@ -0,0 +1,23 @@ + + + + + + + List of All Members for FilterSorter | SortFilterProxyModel + + + +
+

List of All Members for FilterSorter

+

This is the complete list of members for FilterSorter, including inherited members.

+ +

The following members are inherited from Sorter.

+ + + diff --git a/docs/qml-filtersorter.html b/docs/qml-filtersorter.html new file mode 100644 index 0000000..1c13ba0 --- /dev/null +++ b/docs/qml-filtersorter.html @@ -0,0 +1,60 @@ + + + + + + + FilterSorter QML Type | SortFilterProxyModel + + + +
+
+

Contents

+ +
+
+

FilterSorter QML Type

+ + +

Sorts rows based on if they match filters More...

+ +
+
Import Statement: import .
Inherits:

Sorter

+
+ +

Properties

+ + + +

Detailed Description

+

A FilterSorter is a Sorter that orders row matching its filters before the rows not matching the filters.

+

In the following example, rows with their favorite role set to true will be ordered at the beginning :

+
SortFilterProxyModel {
+    sourceModel: contactModel
+    sorters: FilterSorter {
+        ValueFilter { roleName: "favorite"; value: true }
+    }
+}
+ +

Property Documentation

+ +
+
+ + +

+filters : string

+

This property holds the list of filters for this filter sorter. If a row match all this FilterSorter's filters, it will be ordered before rows not matching all the filters.

+

See also Filter.

+
+
+ + diff --git a/docs/qml-indexfilter-members.html b/docs/qml-indexfilter-members.html index e2fa4b0..784a8ca 100644 --- a/docs/qml-indexfilter-members.html +++ b/docs/qml-indexfilter-members.html @@ -3,7 +3,7 @@ - + List of All Members for IndexFilter | SortFilterProxyModel diff --git a/docs/qml-indexfilter.html b/docs/qml-indexfilter.html index 08a5e76..59a5b90 100644 --- a/docs/qml-indexfilter.html +++ b/docs/qml-indexfilter.html @@ -3,7 +3,7 @@ - + IndexFilter QML Type | SortFilterProxyModel diff --git a/docs/qml-joinrole-members.html b/docs/qml-joinrole-members.html index 1a59130..c6804e2 100644 --- a/docs/qml-joinrole-members.html +++ b/docs/qml-joinrole-members.html @@ -3,7 +3,7 @@ - + List of All Members for JoinRole | SortFilterProxyModel @@ -15,9 +15,9 @@
  • roleNames : list<string>
  • separator : string
    • -

    The following members are inherited from ProxyRole.

    +

    The following members are inherited from SingleRole.

    diff --git a/docs/qml-joinrole.html b/docs/qml-joinrole.html index c663ff4..355eecf 100644 --- a/docs/qml-joinrole.html +++ b/docs/qml-joinrole.html @@ -3,7 +3,7 @@ - + JoinRole QML Type | SortFilterProxyModel @@ -23,7 +23,7 @@

    a role made from concatenating other roles More...

    -
    Import Statement: import .
    Inherits:

    ProxyRole

    +
    Import Statement: import .
    Inherits:

    SingleRole

    diff --git a/docs/qml-proxyrole-members.html b/docs/qml-proxyrole-members.html index 3951284..06c52dd 100644 --- a/docs/qml-proxyrole-members.html +++ b/docs/qml-proxyrole-members.html @@ -11,8 +11,5 @@

    List of All Members for ProxyRole

    This is the complete list of members for ProxyRole, including inherited members.

    - diff --git a/docs/qml-proxyrole.html b/docs/qml-proxyrole.html index 7547d14..1df27b5 100644 --- a/docs/qml-proxyrole.html +++ b/docs/qml-proxyrole.html @@ -12,7 +12,6 @@

    Contents

    @@ -23,30 +22,14 @@

    Base type for the SortFilterProxyModel proxy roles More...

    -
    Import Statement: import .
    Inherited By:

    ExpressionRole, JoinRole, and SwitchRole

    +
    Import Statement: import .
    Inherited By:

    RegExpRole and SingleRole

    - -

    Properties

    -

    Detailed Description

    The ProxyRole 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 proxy role types that inherit from it. Attempting to use the ProxyRole type directly will result in an error.

    -

    Property Documentation

    - -
    -
    - - -

    -name : string

    -

    This property holds the role name of the proxy role.

    -
    -
    diff --git a/docs/qml-rangefilter-members.html b/docs/qml-rangefilter-members.html index 92431e8..632db4d 100644 --- a/docs/qml-rangefilter-members.html +++ b/docs/qml-rangefilter-members.html @@ -3,7 +3,7 @@ - + List of All Members for RangeFilter | SortFilterProxyModel diff --git a/docs/qml-rangefilter.html b/docs/qml-rangefilter.html index 396c1fd..278277c 100644 --- a/docs/qml-rangefilter.html +++ b/docs/qml-rangefilter.html @@ -3,7 +3,7 @@ - + RangeFilter QML Type | SortFilterProxyModel diff --git a/docs/qml-regexpfilter-members.html b/docs/qml-regexpfilter-members.html index ab65b12..81de448 100644 --- a/docs/qml-regexpfilter-members.html +++ b/docs/qml-regexpfilter-members.html @@ -3,7 +3,7 @@ - + List of All Members for RegExpFilter | SortFilterProxyModel diff --git a/docs/qml-regexpfilter.html b/docs/qml-regexpfilter.html index dc2db90..4018c3e 100644 --- a/docs/qml-regexpfilter.html +++ b/docs/qml-regexpfilter.html @@ -3,7 +3,7 @@ - + RegExpFilter QML Type | SortFilterProxyModel @@ -92,7 +92,7 @@ SortFilterProxyModel { syntax : enum

    The pattern used to filter the contents of the source model.

    -

    Only the source model's value having their roleName data matching this pattern with the specified syntax will be kept.

    +

    Only the source model's value having their RoleFilter::roleName data matching this pattern with the specified syntax will be kept.

    diff --git a/docs/qml-regexprole-members.html b/docs/qml-regexprole-members.html new file mode 100644 index 0000000..34849ac --- /dev/null +++ b/docs/qml-regexprole-members.html @@ -0,0 +1,20 @@ + + + + + + + List of All Members for RegExpRole | SortFilterProxyModel + + + +
    +

    List of All Members for RegExpRole

    +

    This is the complete list of members for RegExpRole, including inherited members.

    + + + diff --git a/docs/qml-regexprole.html b/docs/qml-regexprole.html new file mode 100644 index 0000000..162db9f --- /dev/null +++ b/docs/qml-regexprole.html @@ -0,0 +1,82 @@ + + + + + + + RegExpRole QML Type | SortFilterProxyModel + + + +
    +
    +

    Contents

    + +
    +
    +

    RegExpRole QML Type

    + + +

    A ProxyRole extracting data from a source role via a regular expression. More...

    + +
    ConstantDescription
    RegExpFilter.RegExpA rich Perl-like pattern matching syntax. This is the default.
    RegExpFilter.WildcardThis provides a simple pattern matching syntax similar to that used by shells (command interpreters) for "file globbing".
    +
    Import Statement: import .
    Inherits:

    ProxyRole

    +
    + +

    Properties

    + + + +

    Detailed Description

    +

    A RegExpRole is a ProxyRole that provides a role for each named capture group of its regular expression pattern.

    +

    In the following example, the date role of the source model will be extracted in 3 roles in the proxy moodel: year, month and day.

    +
    SortFilterProxyModel {
+    sourceModel: eventModel
+    proxyRoles: RegExpRole {
+        roleName: "date"
+        pattern: "(?<year>\\d{4})-(?<month>\\d{2})-(?<day>\\d{2})"
+    }
+}
    + +

    Property Documentation

    + +
    +
    + + +

    +caseSensitivity : Qt::CaseSensitivity

    +

    This property holds the caseSensitivity of the regular expression.

    +
    +
    + +
    +
    + + +

    +pattern : QString

    +

    This property holds the pattern of the regular expression of this RegExpRole. The RegExpRole will expose a role for each of the named capture group of the pattern.

    +
    +
    + +
    +
    + + +

    +roleName : QString

    +

    This property holds the role name that the RegExpRole is using to query the source model's data to extract new roles from.

    +
    +
    + + diff --git a/docs/qml-rolefilter-members.html b/docs/qml-rolefilter-members.html index ecbeb83..d0ef0be 100644 --- a/docs/qml-rolefilter-members.html +++ b/docs/qml-rolefilter-members.html @@ -3,7 +3,7 @@ - + List of All Members for RoleFilter | SortFilterProxyModel diff --git a/docs/qml-rolefilter.html b/docs/qml-rolefilter.html index 4104528..531afaf 100644 --- a/docs/qml-rolefilter.html +++ b/docs/qml-rolefilter.html @@ -3,7 +3,7 @@ - + RoleFilter QML Type | SortFilterProxyModel diff --git a/docs/qml-rolesorter-members.html b/docs/qml-rolesorter-members.html index 0f50daa..0c5d6e4 100644 --- a/docs/qml-rolesorter-members.html +++ b/docs/qml-rolesorter-members.html @@ -3,7 +3,7 @@ - + List of All Members for RoleSorter | SortFilterProxyModel diff --git a/docs/qml-rolesorter.html b/docs/qml-rolesorter.html index 512e19e..84fde7d 100644 --- a/docs/qml-rolesorter.html +++ b/docs/qml-rolesorter.html @@ -3,7 +3,7 @@ - + RoleSorter QML Type | SortFilterProxyModel diff --git a/docs/qml-singlerole-members.html b/docs/qml-singlerole-members.html new file mode 100644 index 0000000..fdd2e99 --- /dev/null +++ b/docs/qml-singlerole-members.html @@ -0,0 +1,18 @@ + + + + + + + List of All Members for SingleRole | SortFilterProxyModel + + + +
    +

    List of All Members for SingleRole

    +

    This is the complete list of members for SingleRole, including inherited members.

    + + + diff --git a/docs/qml-singlerole.html b/docs/qml-singlerole.html new file mode 100644 index 0000000..8b30b6d --- /dev/null +++ b/docs/qml-singlerole.html @@ -0,0 +1,53 @@ + + + + + + + SingleRole QML Type | SortFilterProxyModel + + + +
    +
    +

    Contents

    + +
    +
    +

    SingleRole QML Type

    + + +

    Base type for the SortFilterProxyModel proxy roles defining a single role More...

    + +
    +
    Import Statement: import .
    Inherits:

    ProxyRole

    +
    Inherited By:

    ExpressionRole, FilterRole, JoinRole, and SwitchRole

    +
    + +

    Properties

    + + + +

    Detailed Description

    +

    SingleRole is a convenience base class for proxy roles who define a single role. It cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the other proxy role types that inherit from it. Attempting to use the SingleRole type directly will result in an error.

    + +

    Property Documentation

    + +
    +
    + + +

    +name : string

    +

    This property holds the role name of the proxy role.

    +
    +
    + + diff --git a/docs/qml-sorter.html b/docs/qml-sorter.html index f39e1ca..87b00b3 100644 --- a/docs/qml-sorter.html +++ b/docs/qml-sorter.html @@ -23,7 +23,7 @@

    Base type for the SortFilterProxyModel sorters More...

    -
    Import Statement: import .
    Inherited By:

    ExpressionSorter and RoleSorter

    +
    Import Statement: import .
    Inherited By:

    ExpressionSorter, FilterSorter, and RoleSorter

    diff --git a/docs/qml-stringsorter-members.html b/docs/qml-stringsorter-members.html index 6b4e805..bdbb908 100644 --- a/docs/qml-stringsorter-members.html +++ b/docs/qml-stringsorter-members.html @@ -3,7 +3,7 @@ - + List of All Members for StringSorter | SortFilterProxyModel diff --git a/docs/qml-stringsorter.html b/docs/qml-stringsorter.html index 687ed80..1a979e4 100644 --- a/docs/qml-stringsorter.html +++ b/docs/qml-stringsorter.html @@ -3,7 +3,7 @@ - + StringSorter QML Type | SortFilterProxyModel diff --git a/docs/qml-switchrole-members.html b/docs/qml-switchrole-members.html index 44f58b9..07f9faa 100644 --- a/docs/qml-switchrole-members.html +++ b/docs/qml-switchrole-members.html @@ -3,7 +3,7 @@ - + List of All Members for SwitchRole | SortFilterProxyModel @@ -17,9 +17,9 @@
  • filters : list<Filter>
  • value : var [attached]
    • -

    The following members are inherited from ProxyRole.

    +

    The following members are inherited from SingleRole.

    diff --git a/docs/qml-switchrole.html b/docs/qml-switchrole.html index 267f887..266ba42 100644 --- a/docs/qml-switchrole.html +++ b/docs/qml-switchrole.html @@ -3,7 +3,7 @@ - + SwitchRole QML Type | SortFilterProxyModel @@ -21,10 +21,10 @@

    SwitchRole QML Type

    -

    a role using Filter to conditionnaly compute its data More...

    +

    A role using Filter to conditionnaly compute its data More...

    -
    Import Statement: import .
    Inherits:

    ProxyRole

    +
    Import Statement: import .
    Inherits:

    SingleRole

    diff --git a/docs/qml-valuefilter-members.html b/docs/qml-valuefilter-members.html index 00b988f..3b57e20 100644 --- a/docs/qml-valuefilter-members.html +++ b/docs/qml-valuefilter-members.html @@ -3,7 +3,7 @@ - + List of All Members for ValueFilter | SortFilterProxyModel diff --git a/docs/qml-valuefilter.html b/docs/qml-valuefilter.html index 3e7ff37..daf8ff2 100644 --- a/docs/qml-valuefilter.html +++ b/docs/qml-valuefilter.html @@ -3,7 +3,7 @@ - + ValueFilter QML Type | SortFilterProxyModel diff --git a/docs/sortfilterproxymodel.index b/docs/sortfilterproxymodel.index index bd353c0..b7cfbf1 100644 --- a/docs/sortfilterproxymodel.index +++ b/docs/sortfilterproxymodel.index @@ -32,17 +32,26 @@ - + - + + + + - - + + + + + - + + + + @@ -67,6 +76,9 @@ + + + @@ -80,31 +92,37 @@ - - - + + + - - - + + - - - - + + + + + - - + + + + - - - + + + - - - + + + - - + + + + + +