QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | List of all members
QgsFeatureRequest::OrderBy Class Reference

Represents a list of OrderByClauses, with the most important first and the least important last. More...

#include <qgsfeaturerequest.h>

Inheritance diagram for QgsFeatureRequest::OrderBy:
Inheritance graph
[legend]

Public Member Functions

CORE_EXPORT OrderBy ()
 Create a new empty order by. More...
 
CORE_EXPORT OrderBy (const QList< QgsFeatureRequest::OrderByClause > &other)
 Create a new order by from a list of clauses. More...
 
QString CORE_EXPORT dump () const
 Dumps the content to an SQL equivalent syntax. More...
 
QList< QgsFeatureRequest::OrderByClause > CORE_EXPORT list () const
 Gets a copy as a list of OrderByClauses. More...
 
void CORE_EXPORT load (const QDomElement &elem)
 Deserialize from XML. More...
 
void CORE_EXPORT save (QDomElement &elem) const
 Serialize to XML. More...
 
QSet< int > CORE_EXPORT usedAttributeIndices (const QgsFields &fields) const
 Returns a set of used, validated attribute indices. More...
 
QSet< QString > CORE_EXPORT usedAttributes () const
 Returns a set of used attributes. More...
 

Detailed Description

Represents a list of OrderByClauses, with the most important first and the least important last.

Definition at line 219 of file qgsfeaturerequest.h.

Constructor & Destructor Documentation

◆ OrderBy() [1/2]

QgsFeatureRequest::OrderBy::OrderBy ( )
default

Create a new empty order by.

◆ OrderBy() [2/2]

QgsFeatureRequest::OrderBy::OrderBy ( const QList< QgsFeatureRequest::OrderByClause > &  other)

Create a new order by from a list of clauses.

Definition at line 509 of file qgsfeaturerequest.cpp.

Member Function Documentation

◆ dump()

QString QgsFeatureRequest::OrderBy::dump ( ) const

Dumps the content to an SQL equivalent syntax.

Definition at line 589 of file qgsfeaturerequest.cpp.

◆ list()

QList< QgsFeatureRequest::OrderByClause > QgsFeatureRequest::OrderBy::list ( ) const

Gets a copy as a list of OrderByClauses.

This is only required in Python where the inheritance is not properly propagated and this makes it usable.

Definition at line 518 of file qgsfeaturerequest.cpp.

◆ load()

void QgsFeatureRequest::OrderBy::load ( const QDomElement &  elem)

Deserialize from XML.

Definition at line 539 of file qgsfeaturerequest.cpp.

◆ save()

void QgsFeatureRequest::OrderBy::save ( QDomElement &  elem) const

Serialize to XML.

Definition at line 523 of file qgsfeaturerequest.cpp.

◆ usedAttributeIndices()

QSet< int > QgsFeatureRequest::OrderBy::usedAttributeIndices ( const QgsFields fields) const

Returns a set of used, validated attribute indices.

Since
QGIS 3.8

Definition at line 571 of file qgsfeaturerequest.cpp.

◆ usedAttributes()

QSet< QString > QgsFeatureRequest::OrderBy::usedAttributes ( ) const

Returns a set of used attributes.

Note
The returned attributes names are NOT guaranteed to be valid.

Definition at line 556 of file qgsfeaturerequest.cpp.


The documentation for this class was generated from the following files: