QGIS API Documentation  2.99.0-Master (cd0ba91)
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsRasterFormatSaveOptionsWidget Class Reference

A widget to select format-specific raster saving options. More...

#include <qgsrasterformatsaveoptionswidget.h>

Inheritance diagram for QgsRasterFormatSaveOptionsWidget:
Inheritance graph
[legend]

Public Types

enum  Type {
  Default, Full, Table, LineEdit,
  ProfileLineEdit
}
 

Public Slots

void apply ()
 
void helpOptions ()
 Opens window with options desctiption for given provider and output format. More...
 
void updateProfiles ()
 Reloads profiles list from QGIS settings. More...
 
QString validateOptions (bool gui=true, bool reportOk=true)
 Validates options correctness. More...
 

Signals

void optionsChanged ()
 

Public Member Functions

 QgsRasterFormatSaveOptionsWidget (QWidget *parent SIP_TRANSFERTHIS=nullptr, const QString &format="GTiff", QgsRasterFormatSaveOptionsWidget::Type type=Default, const QString &provider="gdal")
 
QStringList options () const
 Returns list of selected options. More...
 
void setFormat (const QString &format)
 Set output raster format, it is used to determine list of available options. More...
 
void setOptions (const QString &options)
 Populate widget with user-defined options. More...
 
void setProvider (const QString &provider)
 Set provider key, , it is used to determine list of available options. More...
 
void setPyramidsFormat (QgsRaster::RasterPyramidsFormat format)
 Set pyramids format to use. More...
 
void setRasterFileName (const QString &file)
 Set output raster file name. More...
 
void setRasterLayer (QgsRasterLayer *rasterLayer)
 Set output raster layer. More...
 
void setType (QgsRasterFormatSaveOptionsWidget::Type type=Default)
 Set widget look and feel. More...
 

Protected Member Functions

virtual void showEvent (QShowEvent *event) override
 

Detailed Description

A widget to select format-specific raster saving options.

Definition at line 31 of file qgsrasterformatsaveoptionswidget.h.

Member Enumeration Documentation

◆ Type

Enumerator
Default 
Full 
Table 
LineEdit 
ProfileLineEdit 

Definition at line 37 of file qgsrasterformatsaveoptionswidget.h.

Constructor & Destructor Documentation

◆ QgsRasterFormatSaveOptionsWidget()

QgsRasterFormatSaveOptionsWidget::QgsRasterFormatSaveOptionsWidget ( QWidget *parent  SIP_TRANSFERTHIS = nullptr,
const QString &  format = "GTiff",
QgsRasterFormatSaveOptionsWidget::Type  type = Default,
const QString &  provider = "gdal" 
)

Definition at line 38 of file qgsrasterformatsaveoptionswidget.cpp.

Member Function Documentation

◆ apply

void QgsRasterFormatSaveOptionsWidget::apply ( )
slot

Definition at line 249 of file qgsrasterformatsaveoptionswidget.cpp.

◆ helpOptions

void QgsRasterFormatSaveOptionsWidget::helpOptions ( )
slot

Opens window with options desctiption for given provider and output format.

Definition at line 258 of file qgsrasterformatsaveoptionswidget.cpp.

◆ options()

QStringList QgsRasterFormatSaveOptionsWidget::options ( ) const

Returns list of selected options.

See also
setOptions()

Definition at line 511 of file qgsrasterformatsaveoptionswidget.cpp.

◆ optionsChanged

void QgsRasterFormatSaveOptionsWidget::optionsChanged ( )
signal

◆ setFormat()

void QgsRasterFormatSaveOptionsWidget::setFormat ( const QString &  format)

Set output raster format, it is used to determine list of available options.

Definition at line 109 of file qgsrasterformatsaveoptionswidget.cpp.

◆ setOptions()

void QgsRasterFormatSaveOptionsWidget::setOptions ( const QString &  options)

Populate widget with user-defined options.

String should contain key=value pairs separated by spaces, e.g. "TILED=YES TFW=YES"

See also
options()
Since
QGIS 3.0

Definition at line 634 of file qgsrasterformatsaveoptionswidget.cpp.

◆ setProvider()

void QgsRasterFormatSaveOptionsWidget::setProvider ( const QString &  provider)

Set provider key, , it is used to determine list of available options.

Definition at line 116 of file qgsrasterformatsaveoptionswidget.cpp.

◆ setPyramidsFormat()

void QgsRasterFormatSaveOptionsWidget::setPyramidsFormat ( QgsRaster::RasterPyramidsFormat  format)
inline

Set pyramids format to use.

Definition at line 95 of file qgsrasterformatsaveoptionswidget.h.

◆ setRasterFileName()

void QgsRasterFormatSaveOptionsWidget::setRasterFileName ( const QString &  file)
inline

Set output raster file name.

Definition at line 71 of file qgsrasterformatsaveoptionswidget.h.

◆ setRasterLayer()

void QgsRasterFormatSaveOptionsWidget::setRasterLayer ( QgsRasterLayer rasterLayer)
inline

Set output raster layer.

Definition at line 66 of file qgsrasterformatsaveoptionswidget.h.

◆ setType()

void QgsRasterFormatSaveOptionsWidget::setType ( QgsRasterFormatSaveOptionsWidget::Type  type = Default)

Set widget look and feel.

Definition at line 123 of file qgsrasterformatsaveoptionswidget.cpp.

◆ showEvent()

void QgsRasterFormatSaveOptionsWidget::showEvent ( QShowEvent *  event)
overrideprotectedvirtual

Definition at line 627 of file qgsrasterformatsaveoptionswidget.cpp.

◆ updateProfiles

void QgsRasterFormatSaveOptionsWidget::updateProfiles ( )
slot

Reloads profiles list from QGIS settings.

Definition at line 160 of file qgsrasterformatsaveoptionswidget.cpp.

◆ validateOptions

QString QgsRasterFormatSaveOptionsWidget::validateOptions ( bool  gui = true,
bool  reportOk = true 
)
slot

Validates options correctness.

Definition at line 309 of file qgsrasterformatsaveoptionswidget.cpp.


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