QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Member Functions | List of all members
QgsLayoutImageExportOptionsDialog Class Reference

A dialog for customizing the properties of an exported image file. More...

#include <qgslayoutimageexportoptionsdialog.h>

Inheritance diagram for QgsLayoutImageExportOptionsDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutImageExportOptionsDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Constructor for QgsLayoutImageExportOptionsDialog. More...
 
bool antialiasing () const
 Returns whether antialiasing should be used in the export. More...
 
bool cropToContents () const
 Returns whether the crop to contents option is checked in the dialog. More...
 
bool generateWorldFile () const
 Returns whether the generate world file option is checked in the dialog. More...
 
void getCropMargins (int &topMargin, int &rightMargin, int &bottomMargin, int &leftMargin) const
 Fetches the current crop to contents margin values, in pixels. More...
 
int imageHeight () const
 Returns the user-set image height in pixels. More...
 
int imageWidth () const
 Returns the user-set image width in pixels. More...
 
double resolution () const
 Returns the selected resolution from the dialog. More...
 
void setAntialiasing (bool antialias)
 Sets whether antialiasing should be used in the export. More...
 
void setCropMargins (int topMargin, int rightMargin, int bottomMargin, int leftMargin)
 Sets the current crop to contents margin values, in pixels. More...
 
void setCropToContents (bool crop)
 Sets whether the crop to contents option should be checked in the dialog. More...
 
void setGenerateWorldFile (bool generate)
 Sets whether the generate world file option should be checked. More...
 
void setImageSize (QSizeF size)
 Sets the target image size. More...
 
void setResolution (double resolution)
 Sets the initial resolution displayed in the dialog. More...
 

Detailed Description

A dialog for customizing the properties of an exported image file.

Note
This class is not a part of public API
Since
QGIS 3.0

Definition at line 36 of file qgslayoutimageexportoptionsdialog.h.

Constructor & Destructor Documentation

◆ QgsLayoutImageExportOptionsDialog()

QgsLayoutImageExportOptionsDialog::QgsLayoutImageExportOptionsDialog ( QWidget *  parent = nullptr,
Qt::WindowFlags  flags = Qt::WindowFlags() 
)

Constructor for QgsLayoutImageExportOptionsDialog.

Parameters
parentparent widget
flagswindow flags

Definition at line 27 of file qgslayoutimageexportoptionsdialog.cpp.

Member Function Documentation

◆ antialiasing()

bool QgsLayoutImageExportOptionsDialog::antialiasing ( ) const

Returns whether antialiasing should be used in the export.

See also
setAntialiasing()

Definition at line 114 of file qgslayoutimageexportoptionsdialog.cpp.

◆ cropToContents()

bool QgsLayoutImageExportOptionsDialog::cropToContents ( ) const

Returns whether the crop to contents option is checked in the dialog.

See also
setCropToContents()

Definition at line 94 of file qgslayoutimageexportoptionsdialog.cpp.

◆ generateWorldFile()

bool QgsLayoutImageExportOptionsDialog::generateWorldFile ( ) const

Returns whether the generate world file option is checked in the dialog.

See also
setGenerateWorldFile()

Definition at line 104 of file qgslayoutimageexportoptionsdialog.cpp.

◆ getCropMargins()

void QgsLayoutImageExportOptionsDialog::getCropMargins ( int &  topMargin,
int &  rightMargin,
int &  bottomMargin,
int &  leftMargin 
) const

Fetches the current crop to contents margin values, in pixels.

Parameters
topMargindestination for top margin
rightMargindestination for right margin
bottomMargindestination for bottom margin
leftMargindestination for left margin

Definition at line 119 of file qgslayoutimageexportoptionsdialog.cpp.

◆ imageHeight()

int QgsLayoutImageExportOptionsDialog::imageHeight ( ) const

Returns the user-set image height in pixels.

See also
imageWidth

Definition at line 84 of file qgslayoutimageexportoptionsdialog.cpp.

◆ imageWidth()

int QgsLayoutImageExportOptionsDialog::imageWidth ( ) const

Returns the user-set image width in pixels.

See also
imageHeight

Definition at line 79 of file qgslayoutimageexportoptionsdialog.cpp.

◆ resolution()

double QgsLayoutImageExportOptionsDialog::resolution ( ) const

Returns the selected resolution from the dialog.

Returns
image resolution in DPI
See also
setResolution()

Definition at line 63 of file qgslayoutimageexportoptionsdialog.cpp.

◆ setAntialiasing()

void QgsLayoutImageExportOptionsDialog::setAntialiasing ( bool  antialias)

Sets whether antialiasing should be used in the export.

See also
antialiasing()

Definition at line 109 of file qgslayoutimageexportoptionsdialog.cpp.

◆ setCropMargins()

void QgsLayoutImageExportOptionsDialog::setCropMargins ( int  topMargin,
int  rightMargin,
int  bottomMargin,
int  leftMargin 
)

Sets the current crop to contents margin values, in pixels.

Parameters
topMargintop margin
rightMarginright margin
bottomMarginbottom margin
leftMarginleft margin

Definition at line 127 of file qgslayoutimageexportoptionsdialog.cpp.

◆ setCropToContents()

void QgsLayoutImageExportOptionsDialog::setCropToContents ( bool  crop)

Sets whether the crop to contents option should be checked in the dialog.

Parameters
cropset to true to check crop to contents
See also
cropToContents()

Definition at line 89 of file qgslayoutimageexportoptionsdialog.cpp.

◆ setGenerateWorldFile()

void QgsLayoutImageExportOptionsDialog::setGenerateWorldFile ( bool  generate)

Sets whether the generate world file option should be checked.

See also
generateWorldFile()

Definition at line 99 of file qgslayoutimageexportoptionsdialog.cpp.

◆ setImageSize()

void QgsLayoutImageExportOptionsDialog::setImageSize ( QSizeF  size)

Sets the target image size.

This is used to calculate the default size in pixels and also for determining the image's width to height ratio.

Parameters
sizeimage size

Definition at line 68 of file qgslayoutimageexportoptionsdialog.cpp.

◆ setResolution()

void QgsLayoutImageExportOptionsDialog::setResolution ( double  resolution)

Sets the initial resolution displayed in the dialog.

Parameters
resolutiondefault resolution in DPI
See also
resolution()

Definition at line 40 of file qgslayoutimageexportoptionsdialog.cpp.


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