QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
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.
 
CORE_EXPORT OrderBy (const QList< QgsFeatureRequest::OrderByClause > &other)
 Create a new order by from a list of clauses.
 
QString CORE_EXPORT dump () const
 Dumps the content to an SQL equivalent syntax.
 
QList< QgsFeatureRequest::OrderByClause > CORE_EXPORT list () const
 Gets a copy as a list of OrderByClauses.
 
void CORE_EXPORT load (const QDomElement &elem)
 Deserialize from XML.
 
CORE_EXPORT bool operator!= (const OrderBy &v) const
 Inequality operator.
 
CORE_EXPORT bool operator== (const OrderBy &v) const
 Equality operator.
 
void CORE_EXPORT save (QDomElement &elem) const
 Serialize to XML.
 
QSet< int > CORE_EXPORT usedAttributeIndices (const QgsFields &fields) const
 Returns a set of used, validated attribute indices.
 
QSet< QString > CORE_EXPORT usedAttributes () const
 Returns a set of used attributes.
 

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 537 of file qgsfeaturerequest.cpp.

Member Function Documentation

◆ dump()

QString QgsFeatureRequest::OrderBy::dump ( ) const

Dumps the content to an SQL equivalent syntax.

Definition at line 636 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 565 of file qgsfeaturerequest.cpp.

◆ load()

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

Deserialize from XML.

Definition at line 586 of file qgsfeaturerequest.cpp.

◆ operator!=()

bool QgsFeatureRequest::OrderBy::operator!= ( const OrderBy v) const

Inequality operator.

Since
QGIS 3.38

Definition at line 560 of file qgsfeaturerequest.cpp.

◆ operator==()

bool QgsFeatureRequest::OrderBy::operator== ( const OrderBy v) const

Equality operator.

Since
QGIS 3.38

Definition at line 546 of file qgsfeaturerequest.cpp.

◆ save()

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

Serialize to XML.

Definition at line 570 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 618 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 603 of file qgsfeaturerequest.cpp.


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