QGIS API Documentation  2.99.0-Master (7705179)
Signals | Public Member Functions | Properties | List of all members
QgsMapUnitScaleWidget Class Reference

A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters. More...

#include <qgsunitselectionwidget.h>

Inheritance diagram for QgsMapUnitScaleWidget:
Inheritance graph
[legend]

Signals

void mapUnitScaleChanged (const QgsMapUnitScale &scale)
 Emitted when the settings in the widget are modified. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsMapUnitScaleWidget (QWidget *parent=0)
 Constructor for QgsMapUnitScaleWidget. More...
 
QgsMapUnitScale mapUnitScale () const
 Returns a QgsMapUnitScale representing the settings shown in the widget. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the widget. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale)
 Updates the widget to reflect the settings from the specified QgsMapUnitScale object. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=0)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
void connectChildPanel (QgsPanelWidget *panel)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
void connectChildPanels (const QList< QgsPanelWidget *> &panels)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
bool dockMode ()
 Return the dock mode state. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Properties

QgsMapUnitScale mapUnitScale
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
void openPanel (QgsPanelWidget *panel)
 Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event)
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters.

This widget is designed to allow users to edit the properties of a QgsMapUnitScale object.

Since
QGIS 3.0
See also
QgsMapUnitScaleDialog
QgsUnitSelectionWidget

Definition at line 41 of file qgsunitselectionwidget.h.

Constructor & Destructor Documentation

◆ QgsMapUnitScaleWidget()

QgsMapUnitScaleWidget::QgsMapUnitScaleWidget ( QWidget *  parent = 0)

Constructor for QgsMapUnitScaleWidget.

Parameters
parentparent widget

Definition at line 22 of file qgsunitselectionwidget.cpp.

Member Function Documentation

◆ mapUnitScale()

QgsMapUnitScale QgsMapUnitScaleWidget::mapUnitScale ( ) const

Returns a QgsMapUnitScale representing the settings shown in the widget.

See also
setMapUnitScale()
mapUnitScaleChanged()

◆ mapUnitScaleChanged

void QgsMapUnitScaleWidget::mapUnitScaleChanged ( const QgsMapUnitScale scale)
signal

Emitted when the settings in the widget are modified.

Parameters
scaleQgsMapUnitScale reflecting new settings from the widget

◆ setMapCanvas()

void QgsMapUnitScaleWidget::setMapCanvas ( QgsMapCanvas canvas)

Sets the map canvas associated with the widget.

This allows the widget to retrieve the current map scale from the canvas.

Parameters
canvasmap canvas

Definition at line 76 of file qgsunitselectionwidget.cpp.

◆ setMapUnitScale()

void QgsMapUnitScaleWidget::setMapUnitScale ( const QgsMapUnitScale scale)

Updates the widget to reflect the settings from the specified QgsMapUnitScale object.

Parameters
scalemap unit scale to show in widget
See also
mapUnitScale()
mapUnitScaleChanged()

Definition at line 52 of file qgsunitselectionwidget.cpp.

Property Documentation

◆ mapUnitScale

QgsMapUnitScale QgsMapUnitScaleWidget::mapUnitScale
readwrite

Definition at line 44 of file qgsunitselectionwidget.h.


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