QGIS API Documentation: QgsScaleVisibilityDialog Class Reference

QGIS API Documentation 3.20.0-Odense (decaadbb31)

A dialog allowing users to enter a scale visibility range. More...

#include <qgsscalevisibilitydialog.h>

Inheritance diagram for QgsScaleVisibilityDialog:

Inheritance graph

[legend]

Public Slots
void	setMaximumScale (double scale)
	Set the maximum scale, or 0 to indicate the minimum is not set. More...

void	setMinimumScale (double scale)
	Set the minimum scale, or 0 to indicate the minimum is not set. More...

void	setScaleVisiblity (bool hasScaleVisibility)
	Set whether scale based visibility is enabled. More...

Public Member Functions
	QgsScaleVisibilityDialog (QWidget parent=nullptr, const QString &title=QString(), QgsMapCanvas mapCanvas=nullptr)
	Constructor for QgsScaleVisibilityDialog, with specified dialog title. More...

bool	hasScaleVisibility () const
	Returns `true` if scale based visibility is enabled. More...

double	maximumScale () const
	Returns the selected maximum scale, or 0 if maximum scale is not set. More...

double	minimumScale () const
	Returns the selected minimum scale, or 0 if minimum scale is not set. More...

Properties
bool	hasScaleVisibility

double	maximumScale

double	minimumScale

Detailed Description

A dialog allowing users to enter a scale visibility range.

Definition at line 32 of file qgsscalevisibilitydialog.h.

Constructor & Destructor Documentation

◆ QgsScaleVisibilityDialog()

QgsScaleVisibilityDialog::QgsScaleVisibilityDialog	(	QWidget *	parent = `nullptr`,
		const QString &	title = `QString()`,
		QgsMapCanvas *	mapCanvas = `nullptr`
	)

explicit

Constructor for QgsScaleVisibilityDialog, with specified dialog title.

The mapCanvas argument can be used to associate the dialog with a map canvas, allowing use of the current map scale within the dialog.

Definition at line 24 of file qgsscalevisibilitydialog.cpp.

Member Function Documentation

◆ hasScaleVisibility()

bool QgsScaleVisibilityDialog::hasScaleVisibility ( ) const

Returns true if scale based visibility is enabled.

Definition at line 62 of file qgsscalevisibilitydialog.cpp.

◆ maximumScale()

double QgsScaleVisibilityDialog::maximumScale ( ) const

Returns the selected maximum scale, or 0 if maximum scale is not set.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also: minimumScale(); setMaximumScale())

Definition at line 82 of file qgsscalevisibilitydialog.cpp.

◆ minimumScale()

double QgsScaleVisibilityDialog::minimumScale ( ) const

Returns the selected minimum scale, or 0 if minimum scale is not set.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also: maximumScale(); setMinimumScale()

Definition at line 72 of file qgsscalevisibilitydialog.cpp.

◆ setMaximumScale

void QgsScaleVisibilityDialog::setMaximumScale ( double scale )

slot

Set the maximum scale, or 0 to indicate the minimum is not set.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also: maximumScale(); setMinimumScale()

Definition at line 77 of file qgsscalevisibilitydialog.cpp.

◆ setMinimumScale

void QgsScaleVisibilityDialog::setMinimumScale ( double scale )

slot

Set the minimum scale, or 0 to indicate the minimum is not set.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also: minimumScale(); setMaximumScale()

Definition at line 67 of file qgsscalevisibilitydialog.cpp.

◆ setScaleVisiblity

void QgsScaleVisibilityDialog::setScaleVisiblity ( bool hasScaleVisibility )

slot

Set whether scale based visibility is enabled.

See also: hasScaleVisibility()

Definition at line 57 of file qgsscalevisibilitydialog.cpp.

Property Documentation

◆ hasScaleVisibility

bool QgsScaleVisibilityDialog::hasScaleVisibility

readwrite

Definition at line 1 of file qgsscalevisibilitydialog.h.

◆ maximumScale

double QgsScaleVisibilityDialog::maximumScale

readwrite

Definition at line 1 of file qgsscalevisibilitydialog.h.

◆ minimumScale

double QgsScaleVisibilityDialog::minimumScale

readwrite

Definition at line 1 of file qgsscalevisibilitydialog.h.

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

/build/qgis-3.20.0+99unstable/src/gui/qgsscalevisibilitydialog.h
/build/qgis-3.20.0+99unstable/src/gui/qgsscalevisibilitydialog.cpp