sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs for QgsProjectionSelectionWidget

Browse Source
This commit is contained in:
Nyall Dawson 2015-04-30 07:05:56 +10:00
parent 721d9f5908
commit eb4d8c76b7
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
python/gui/qgsprojectionselectionwidget.sip
View File

@ -25,18 +25,18 @@ class QgsProjectionSelectionWidget : QWidget
explicit QgsProjectionSelectionWidget( QWidget *parent /TransferThis/ = 0 ); explicit QgsProjectionSelectionWidget( QWidget *parent /TransferThis/ = 0 );
/* Returns a pointer to the projection selector dialog used by the widget. /** Returns a pointer to the projection selector dialog used by the widget.
* Can be used to modify how the projection selector dialog behaves. * Can be used to modify how the projection selector dialog behaves.
* @returns projection selector dialog * @returns projection selector dialog
*/ */
QgsGenericProjectionSelector* dialog(); QgsGenericProjectionSelector* dialog();
/* Returns the currently selected CRS for the widget /** Returns the currently selected CRS for the widget
* @returns current CRS * @returns current CRS
*/ */
QgsCoordinateReferenceSystem crs() const; QgsCoordinateReferenceSystem crs() const;
/* Sets whether a predefined CRS option should be shown in the widget. /** Sets whether a predefined CRS option should be shown in the widget.
* @param option CRS option to show/hide * @param option CRS option to show/hide
* @param visible whether the option should be shown * @param visible whether the option should be shown
*/ */
@ -44,24 +44,24 @@ class QgsProjectionSelectionWidget : QWidget
signals: signals:
/* Emitted when the selected CRS is changed /** Emitted when the selected CRS is changed
*/ */
void crsChanged( QgsCoordinateReferenceSystem ); void crsChanged( QgsCoordinateReferenceSystem );
public slots: public slots:
/* Sets the current CRS for the widget /** Sets the current CRS for the widget
* @param crs new CRS * @param crs new CRS
*/ */
void setCrs( const QgsCoordinateReferenceSystem& crs ); void setCrs( const QgsCoordinateReferenceSystem& crs );
/* Sets the layer CRS for the widget. If set, this will be added as an option /** Sets the layer CRS for the widget. If set, this will be added as an option
* to the preset CRSes shown in the widget. * to the preset CRSes shown in the widget.
* @param crs layer CRS * @param crs layer CRS
*/ */
void setLayerCrs( const QgsCoordinateReferenceSystem& crs ); void setLayerCrs( const QgsCoordinateReferenceSystem& crs );
/* Opens the dialog for selecting a new CRS /** Opens the dialog for selecting a new CRS
*/ */
void selectCrs(); void selectCrs();

14
src/gui/qgsprojectionselectionwidget.h
View File

@ -50,18 +50,18 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget
explicit QgsProjectionSelectionWidget( QWidget *parent = 0 ); explicit QgsProjectionSelectionWidget( QWidget *parent = 0 );
/* Returns a pointer to the projection selector dialog used by the widget. /** Returns a pointer to the projection selector dialog used by the widget.
* Can be used to modify how the projection selector dialog behaves. * Can be used to modify how the projection selector dialog behaves.
* @returns projection selector dialog * @returns projection selector dialog
*/ */
QgsGenericProjectionSelector* dialog() { return mDialog; } QgsGenericProjectionSelector* dialog() { return mDialog; }
/* Returns the currently selected CRS for the widget /** Returns the currently selected CRS for the widget
* @returns current CRS * @returns current CRS
*/ */
QgsCoordinateReferenceSystem crs() const; QgsCoordinateReferenceSystem crs() const;
/* Sets whether a predefined CRS option should be shown in the widget. /** Sets whether a predefined CRS option should be shown in the widget.
* @param option CRS option to show/hide * @param option CRS option to show/hide
* @param visible whether the option should be shown * @param visible whether the option should be shown
*/ */
@ -69,24 +69,24 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget
signals: signals:
/* Emitted when the selected CRS is changed /** Emitted when the selected CRS is changed
*/ */
void crsChanged( QgsCoordinateReferenceSystem ); void crsChanged( QgsCoordinateReferenceSystem );
public slots: public slots:
/* Sets the current CRS for the widget /** Sets the current CRS for the widget
* @param crs new CRS * @param crs new CRS
*/ */
void setCrs( const QgsCoordinateReferenceSystem& crs ); void setCrs( const QgsCoordinateReferenceSystem& crs );
/* Sets the layer CRS for the widget. If set, this will be added as an option /** Sets the layer CRS for the widget. If set, this will be added as an option
* to the preset CRSes shown in the widget. * to the preset CRSes shown in the widget.
* @param crs layer CRS * @param crs layer CRS
*/ */
void setLayerCrs( const QgsCoordinateReferenceSystem& crs ); void setLayerCrs( const QgsCoordinateReferenceSystem& crs );
/* Opens the dialog for selecting a new CRS /** Opens the dialog for selecting a new CRS
*/ */
void selectCrs(); void selectCrs();