You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: python/core/qgsfeaturerequest.sip
+80-11
Original file line number
Diff line number
Diff line change
@@ -15,17 +15,39 @@ class QgsFeatureRequest
15
15
};
16
16
typedef QFlags<QgsFeatureRequest::Flag> Flags;
17
17
18
+
/**
19
+
* Types of filters.
20
+
*/
18
21
enum FilterType
19
22
{
20
23
FilterNone, //!< No filter is applied
21
-
FilterRect, //!< Filter using a rectangle, no need to set NoGeometry
24
+
FilterRect, //!< Obsolete, will be ignored. If a filterRect is set it will be used anyway. Filter using a rectangle, no need to set NoGeometry. Instead check for request.filterRect().isNull()
22
25
FilterFid, //!< Filter using feature ID
23
26
FilterExpression, //!< Filter using expression
24
27
FilterFids //!< Filter using feature IDs
25
28
};
26
29
27
30
/**
28
-
* @brief The OrderByClause class represents an order by clause for a QgsFeatureRequest
31
+
* The OrderByClause class represents an order by clause for a QgsFeatureRequest.
32
+
*
33
+
* It can be a simple field or an expression. Multiple order by clauses can be added to
34
+
* a QgsFeatureRequest to fine tune the behavior if a single field or expression is not
35
+
* enough to completely specify the required behavior.
36
+
*
37
+
* If expression compilation is activated in the settings and the expression can be
38
+
* translated for the provider in question, it will be evaluated on provider side.
39
+
* If one of these two premises does not apply, the ordering will take place locally
40
+
* which results in increased memory and CPU usage.
41
+
*
42
+
* If the ordering is done on strings, the order depends on the system's locale if the
43
+
* local fallback implementation is used. The order depends on the server system's locale
44
+
* and implementation if ordering is done on the server.
45
+
*
46
+
* In case the fallback code needs to be used, a limit set on the request will be respected
47
+
* for the features returned by the iterator but internally all features will be requested
48
+
* from the provider.
49
+
*
50
+
* @note added in QGIS 2.14
29
51
*/
30
52
class OrderByClause
31
53
{
@@ -35,8 +57,8 @@ class QgsFeatureRequest
35
57
*
36
58
* @param expression The expression to use for ordering
37
59
* @param ascending If the order should be ascending (1,2,3) or descending (3,2,1)
38
-
* If thr order is ascending, by default nulls are last
39
-
* If thr order is descending, by default nulls are first
60
+
* If the order is ascending, by default nulls are last
61
+
* If the order is descending, by default nulls are first
0 commit comments