QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Classes | Signals | Public Member Functions | List of all members
QgsCoordinateOperationWidget Class Reference

A widget for selecting the coordinate operation to use when transforming between a source and destination coordinate reference system. More...

#include <qgscoordinateoperationwidget.h>

Inheritance diagram for QgsCoordinateOperationWidget:
Inheritance graph
[legend]

Classes

struct  OperationDetails
 Coordinate operation details. More...
 

Signals

void operationChanged ()
 Emitted when the operation selected in the dialog is changed. More...
 
void operationDoubleClicked ()
 Emitted when an operation is double-clicked in the widget. More...
 

Public Member Functions

 QgsCoordinateOperationWidget (QWidget *parent=nullptr)
 Constructor for QgsCoordinateOperationWidget. More...
 
 ~QgsCoordinateOperationWidget () override
 
QList< QgsCoordinateOperationWidget::OperationDetailsavailableOperations () const
 Returns a list of the available operations shown in the widget. More...
 
QgsCoordinateOperationWidget::OperationDetails defaultOperation () const
 Returns the details of the default operation suggested by the widget. More...
 
QgsCoordinateReferenceSystem destinationCrs () const
 Returns the destination CRS for the operations shown in the widget. More...
 
bool hasSelection () const
 Returns true if there is a valid selection in the widget. More...
 
bool makeDefaultSelected () const
 Returns true if the "make default" option is selected. More...
 
QgsCoordinateOperationWidget::OperationDetails selectedOperation () const
 Returns the details of the operation currently selected within the widget. More...
 
void setDestinationCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the destination crs for the operations shown in the widget. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets a map canvas to link to the widget, which allows the widget's choices to reflect the current canvas state. More...
 
void setSelectedOperation (const QgsCoordinateOperationWidget::OperationDetails &operation)
 Sets the details of the operation currently selected within the widget. More...
 
void setSelectedOperationUsingContext (const QgsCoordinateTransformContext &context)
 Automatically sets the selected operation using the settings encapsulated in a transform context. More...
 
void setShowFallbackOption (bool visible)
 Sets whether the "allow fallback" operations option is visible. More...
 
void setShowMakeDefault (bool show)
 Sets whether the "make default" checkbox should be shown. More...
 
void setSourceCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the source crs for the operations shown in the widget. More...
 
QgsCoordinateReferenceSystem sourceCrs () const
 Returns the source CRS for the operations shown in the widget. More...
 

Detailed Description

A widget for selecting the coordinate operation to use when transforming between a source and destination coordinate reference system.

Since
QGIS 3.12

Definition at line 33 of file qgscoordinateoperationwidget.h.

Constructor & Destructor Documentation

◆ QgsCoordinateOperationWidget()

QgsCoordinateOperationWidget::QgsCoordinateOperationWidget ( QWidget *  parent = nullptr)

Constructor for QgsCoordinateOperationWidget.

Definition at line 37 of file qgscoordinateoperationwidget.cpp.

◆ ~QgsCoordinateOperationWidget()

QgsCoordinateOperationWidget::~QgsCoordinateOperationWidget ( )
override

Definition at line 458 of file qgscoordinateoperationwidget.cpp.

Member Function Documentation

◆ availableOperations()

QList< QgsCoordinateOperationWidget::OperationDetails > QgsCoordinateOperationWidget::availableOperations ( ) const

Returns a list of the available operations shown in the widget.

Definition at line 139 of file qgscoordinateoperationwidget.cpp.

◆ defaultOperation()

QgsCoordinateOperationWidget::OperationDetails QgsCoordinateOperationWidget::defaultOperation ( ) const

Returns the details of the default operation suggested by the widget.

Definition at line 469 of file qgscoordinateoperationwidget.cpp.

◆ destinationCrs()

QgsCoordinateReferenceSystem QgsCoordinateOperationWidget::destinationCrs ( ) const
inline

Returns the destination CRS for the operations shown in the widget.

See also
setDestinationCrs()
sourceCrs()

Definition at line 78 of file qgscoordinateoperationwidget.h.

◆ hasSelection()

bool QgsCoordinateOperationWidget::hasSelection ( ) const

Returns true if there is a valid selection in the widget.

Definition at line 134 of file qgscoordinateoperationwidget.cpp.

◆ makeDefaultSelected()

bool QgsCoordinateOperationWidget::makeDefaultSelected ( ) const

Returns true if the "make default" option is selected.

Definition at line 129 of file qgscoordinateoperationwidget.cpp.

◆ operationChanged

void QgsCoordinateOperationWidget::operationChanged ( )
signal

Emitted when the operation selected in the dialog is changed.

◆ operationDoubleClicked

void QgsCoordinateOperationWidget::operationDoubleClicked ( )
signal

Emitted when an operation is double-clicked in the widget.

◆ selectedOperation()

QgsCoordinateOperationWidget::OperationDetails QgsCoordinateOperationWidget::selectedOperation ( ) const

Returns the details of the operation currently selected within the widget.

See also
setSelectedOperation()

Definition at line 555 of file qgscoordinateoperationwidget.cpp.

◆ setDestinationCrs()

void QgsCoordinateOperationWidget::setDestinationCrs ( const QgsCoordinateReferenceSystem crs)

Sets the destination crs for the operations shown in the widget.

See also
destinationCrs()
setSourceCrs()

Definition at line 795 of file qgscoordinateoperationwidget.cpp.

◆ setMapCanvas()

void QgsCoordinateOperationWidget::setMapCanvas ( QgsMapCanvas canvas)

Sets a map canvas to link to the widget, which allows the widget's choices to reflect the current canvas state.

Definition at line 91 of file qgscoordinateoperationwidget.cpp.

◆ setSelectedOperation()

void QgsCoordinateOperationWidget::setSelectedOperation ( const QgsCoordinateOperationWidget::OperationDetails operation)

Sets the details of the operation currently selected within the widget.

See also
selectedOperation()

Definition at line 579 of file qgscoordinateoperationwidget.cpp.

◆ setSelectedOperationUsingContext()

void QgsCoordinateOperationWidget::setSelectedOperationUsingContext ( const QgsCoordinateTransformContext context)

Automatically sets the selected operation using the settings encapsulated in a transform context.

If no matching operations are found within the context then the defaultOperation() will be selected.

Definition at line 624 of file qgscoordinateoperationwidget.cpp.

◆ setShowFallbackOption()

void QgsCoordinateOperationWidget::setShowFallbackOption ( bool  visible)

Sets whether the "allow fallback" operations option is visible.

Since
QGIS 3.12

Definition at line 658 of file qgscoordinateoperationwidget.cpp.

◆ setShowMakeDefault()

void QgsCoordinateOperationWidget::setShowMakeDefault ( bool  show)

Sets whether the "make default" checkbox should be shown.

Definition at line 124 of file qgscoordinateoperationwidget.cpp.

◆ setSourceCrs()

void QgsCoordinateOperationWidget::setSourceCrs ( const QgsCoordinateReferenceSystem crs)

Sets the source crs for the operations shown in the widget.

See also
sourceCrs()
setDestinationCrs()

Definition at line 782 of file qgscoordinateoperationwidget.cpp.

◆ sourceCrs()

QgsCoordinateReferenceSystem QgsCoordinateOperationWidget::sourceCrs ( ) const
inline

Returns the source CRS for the operations shown in the widget.

See also
setSourceCrs()
destinationCrs()

Definition at line 70 of file qgscoordinateoperationwidget.h.


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