QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
QgsRasterAttributeTable::Field Class Reference

The Field class represents a Raster Attribute Table field, including its name, usage and type. More...

#include <qgsrasterattributetable.h>

Public Member Functions

 Field (const QString &name, const Qgis::RasterAttributeTableFieldUsage &usage, const QMetaType::Type type)
 Creates a new Field with name, type and usage.
 
Q_DECL_DEPRECATED Field (const QString &name, const Qgis::RasterAttributeTableFieldUsage &usage, const QVariant::Type type)
 Creates a new Field with name, type and usage.
 
bool isColor () const
 Returns true if the field carries a color component (Red, Green, Blue and optionally Alpha) information.
 
bool isRamp () const
 Returns true if the field carries a color ramp component information (RedMin/RedMax, GreenMin/GreenMax, BlueMin/BlueMax and optionally AlphaMin/AlphaMax) information.
 

Public Attributes

QString name
 
QMetaType::Type type
 
Qgis::RasterAttributeTableFieldUsage usage
 

Detailed Description

The Field class represents a Raster Attribute Table field, including its name, usage and type.

Since
QGIS 3.30

Definition at line 89 of file qgsrasterattributetable.h.

Constructor & Destructor Documentation

◆ Field() [1/2]

QgsRasterAttributeTable::Field::Field ( const QString &  name,
const Qgis::RasterAttributeTableFieldUsage usage,
const QMetaType::Type  type 
)
inline

Creates a new Field with name, type and usage.

Definition at line 97 of file qgsrasterattributetable.h.

◆ Field() [2/2]

Q_DECL_DEPRECATED QgsRasterAttributeTable::Field::Field ( const QString &  name,
const Qgis::RasterAttributeTableFieldUsage usage,
const QVariant::Type  type 
)
inline

Creates a new Field with name, type and usage.

Deprecated:
since QGIS 3.38, use the method with a QMetaType::Type argument instead

Definition at line 103 of file qgsrasterattributetable.h.

Member Function Documentation

◆ isColor()

bool QgsRasterAttributeTable::Field::isColor ( ) const

Returns true if the field carries a color component (Red, Green, Blue and optionally Alpha) information.

Definition at line 1623 of file qgsrasterattributetable.cpp.

◆ isRamp()

bool QgsRasterAttributeTable::Field::isRamp ( ) const

Returns true if the field carries a color ramp component information (RedMin/RedMax, GreenMin/GreenMax, BlueMin/BlueMax and optionally AlphaMin/AlphaMax) information.

Definition at line 1628 of file qgsrasterattributetable.cpp.

Member Data Documentation

◆ name

QString QgsRasterAttributeTable::Field::name

Definition at line 115 of file qgsrasterattributetable.h.

◆ type

QMetaType::Type QgsRasterAttributeTable::Field::type

Definition at line 117 of file qgsrasterattributetable.h.

◆ usage

Qgis::RasterAttributeTableFieldUsage QgsRasterAttributeTable::Field::usage

Definition at line 116 of file qgsrasterattributetable.h.


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