Change all ocurrences on_buttonBox_helpRequested to showHelp

Add help button to 3 dialogs Fix missing QStringLiteral Fix CMakeLists.txt indentation Fix qhelp.h and qgis_sip.h includes with <>
qgis · Aug 15, 2017 · fe59a19 · fe59a19
1 parent c07ac6e
commit fe59a19
Show file tree

Hide file tree

Showing 97 changed files with 297 additions and 149 deletions.
diff --git a/python/gui/qgsnewhttpconnection.sip b/python/gui/qgsnewhttpconnection.sip
@@ -29,11 +29,6 @@ Constructor
   public slots:
     virtual void accept();
 
-
-    void helpRequest();
-%Docstring
- Open the help in a browser
-%End
     void on_txtName_textChanged( const QString & );
     void on_txtUrl_textChanged( const QString & );
 

diff --git a/python/gui/qgsnewvectorlayerdialog.sip b/python/gui/qgsnewvectorlayerdialog.sip
@@ -65,7 +65,7 @@ Returns the file format for storage
     void on_mRemoveAttributeButton_clicked();
     void on_mFileFormatComboBox_currentIndexChanged( int index );
     void on_mTypeBox_currentIndexChanged( int index );
-    void on_buttonBox_helpRequested();
+    void showHelp();
     void nameChanged( const QString & );
     void selectionChanged();
 

diff --git a/python/gui/qgsquerybuilder.sip b/python/gui/qgsquerybuilder.sip
@@ -68,8 +68,6 @@ class QgsQueryBuilder : QDialog
     void on_btnNot_clicked();
     void on_btnOr_clicked();
 
-    void on_buttonBox_helpRequested();
-
     void test();
 %Docstring
  Test the constructed sql statement to see if the vector layer data provider likes it.

diff --git a/python/gui/qgssearchquerybuilder.sip b/python/gui/qgssearchquerybuilder.sip
@@ -78,11 +78,6 @@ change search string shown in text field
  are inserted into the values list box.
 %End
 
-    void helpRequest();
-%Docstring
- Open the help in a browser
-%End
-
     void saveQuery();
     void loadQuery();
 

diff --git a/python/gui/symbology/qgsstylemanagerdialog.sip b/python/gui/symbology/qgsstylemanagerdialog.sip
@@ -47,7 +47,8 @@ adds symbols of some type to list
 called when the dialog is going to be closed
 %End
 
-    void on_buttonBox_helpRequested();
+    void onClose();
+    void showHelp();
 
     void itemChanged( QStandardItem *item );
 

diff --git a/src/app/pluginmanager/qgspluginmanager.cpp b/src/app/pluginmanager/qgspluginmanager.cpp
@@ -67,6 +67,7 @@ QgsPluginManager::QgsPluginManager( QWidget *parent, bool pluginsAreEnabled, Qt:
   mPythonUtils = nullptr;
 
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsPluginManager::showHelp );
 
   // QgsOptionsDialogBase handles saving/restoring of geometry, splitter and current tab states,
   // switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left),
@@ -1576,4 +1577,7 @@ void QgsPluginManager::pushMessage( const QString &text, QgsMessageBar::MessageL
   msgBar->pushMessage( text, level, duration );
 }
 
-
+void QgsPluginManager::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "plugins/plugins.html" ) );
+}
diff --git a/src/app/pluginmanager/qgspluginmanager.h b/src/app/pluginmanager/qgspluginmanager.h
@@ -155,7 +155,7 @@ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManag
     void on_ckbDeprecated_toggled( bool state );
 
     //! Open help browser
-    void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "plugins/plugins.html" ) ); }
+    void showHelp();
 
     //! Reimplement QgsOptionsDialogBase method to prevent modifying the tab list by signals from the stacked widget
     void optionsStackedWidget_CurrentChanged( int indx ) { Q_UNUSED( indx ) }

diff --git a/src/app/qgscustomprojectiondialog.cpp b/src/app/qgscustomprojectiondialog.cpp
@@ -47,6 +47,7 @@ QgsCustomProjectionDialog::QgsCustomProjectionDialog( QWidget *parent, Qt::Windo
   : QDialog( parent, fl )
 {
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsCustomProjectionDialog::showHelp );
 
   QgsSettings settings;
   restoreGeometry( settings.value( QStringLiteral( "Windows/CustomProjection/geometry" ) ).toByteArray() );
@@ -531,3 +532,7 @@ QString QgsCustomProjectionDialog::quotedValue( QString value )
   return value.prepend( '\'' ).append( '\'' );
 }
 
+void QgsCustomProjectionDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "working_with_projections/working_with_projections.html" ) );
+}
diff --git a/src/app/qgscustomprojectiondialog.h b/src/app/qgscustomprojectiondialog.h
@@ -41,8 +41,6 @@ class APP_EXPORT QgsCustomProjectionDialog : public QDialog, private Ui::QgsCust
     void on_pbnRemove_clicked();
     void on_pbnCopyCRS_clicked();
     void on_leNameList_currentItemChanged( QTreeWidgetItem *current, QTreeWidgetItem *prev );
-
-    void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "working_with_projections/working_with_projections.html" ) ); }
     void on_buttonBox_accepted();
 
   private:
@@ -53,6 +51,7 @@ class APP_EXPORT QgsCustomProjectionDialog : public QDialog, private Ui::QgsCust
     bool deleteCrs( const QString &id );
     bool saveCrs( QgsCoordinateReferenceSystem myParameters, const QString &myName, QString myId, bool newEntry );
     void insertProjection( const QString &myProjectionAcronym );
+    void showHelp();
 
     //These two QMap store the values as they are on the database when loading
     QMap <QString, QString> existingCRSparameters;

diff --git a/src/app/qgsdecorationcopyrightdialog.cpp b/src/app/qgsdecorationcopyrightdialog.cpp
@@ -28,6 +28,7 @@ QgsDecorationCopyrightDialog::QgsDecorationCopyrightDialog( QgsDecorationCopyrig
   , mDeco( deco )
 {
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsDecorationCopyrightDialog::showHelp );
 
   QgsSettings settings;
   restoreGeometry( settings.value( QStringLiteral( "Windows/DecorationCopyright/geometry" ) ).toByteArray() );
@@ -99,7 +100,7 @@ void QgsDecorationCopyrightDialog::apply()
   mDeco.update();
 }
 
-void QgsDecorationCopyrightDialog::on_buttonBox_helpRequested()
+void QgsDecorationCopyrightDialog::showHelp()
 {
   QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#copyright-label" ) );
 }
diff --git a/src/app/qgsdecorationcopyrightdialog.h b/src/app/qgsdecorationcopyrightdialog.h
@@ -31,7 +31,7 @@ class APP_EXPORT QgsDecorationCopyrightDialog : public QDialog, private Ui::QgsD
   private slots:
     void on_buttonBox_accepted();
     void on_buttonBox_rejected();
-    void on_buttonBox_helpRequested();
+    void showHelp();
     void on_pbnColorChooser_colorChanged( const QColor &c );
     void apply();
 

diff --git a/src/app/qgsdecorationgriddialog.cpp b/src/app/qgsdecorationgriddialog.cpp
@@ -33,6 +33,7 @@ QgsDecorationGridDialog::QgsDecorationGridDialog( QgsDecorationGrid &deco, QWidg
   , mDeco( deco )
 {
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsDecorationGridDialog::showHelp );
 
   mMarkerSymbolButton->setSymbolType( QgsSymbol::Marker );
   mLineSymbolButton->setSymbolType( QgsSymbol::Line );
@@ -157,7 +158,7 @@ QgsDecorationGridDialog::~QgsDecorationGridDialog()
   settings.setValue( QStringLiteral( "/Windows/DecorationGrid/geometry" ), saveGeometry() );
 }
 
-void QgsDecorationGridDialog::on_buttonBox_helpRequested()
+void QgsDecorationGridDialog::showHelp()
 {
   QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#grid" ) );
 }

diff --git a/src/app/qgsdecorationgriddialog.h b/src/app/qgsdecorationgriddialog.h
@@ -38,7 +38,7 @@ class APP_EXPORT QgsDecorationGridDialog : public QDialog, private Ui::QgsDecora
     void apply();
     void on_buttonBox_accepted();
     void on_buttonBox_rejected();
-    void on_buttonBox_helpRequested();
+    void showHelp();
     void on_mGridTypeComboBox_currentIndexChanged( int index );
     void on_mPbtnUpdateFromExtents_clicked();
     void on_mPbtnUpdateFromLayer_clicked();

diff --git a/src/app/qgsdecorationnortharrowdialog.cpp b/src/app/qgsdecorationnortharrowdialog.cpp
@@ -34,6 +34,7 @@ QgsDecorationNorthArrowDialog::QgsDecorationNorthArrowDialog( QgsDecorationNorth
 
   QPushButton *applyButton = buttonBox->button( QDialogButtonBox::Apply );
   connect( applyButton, &QAbstractButton::clicked, this, &QgsDecorationNorthArrowDialog::apply );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsDecorationNorthArrowDialog::showHelp );
 
   // signal/slot connection defined in 'designer' causes the slider to
   // be moved to reflect the change in the spinbox.
@@ -78,7 +79,7 @@ QgsDecorationNorthArrowDialog::~QgsDecorationNorthArrowDialog()
   settings.setValue( QStringLiteral( "Windows/DecorationNorthArrow/geometry" ), saveGeometry() );
 }
 
-void QgsDecorationNorthArrowDialog::on_buttonBox_helpRequested()
+void QgsDecorationNorthArrowDialog::showHelp()
 {
   QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#north-arrow" ) );
 }

diff --git a/src/app/qgsdecorationnortharrowdialog.h b/src/app/qgsdecorationnortharrowdialog.h
@@ -32,7 +32,7 @@ class APP_EXPORT QgsDecorationNorthArrowDialog : public QDialog, private Ui::Qgs
   private slots:
     void on_buttonBox_accepted();
     void on_buttonBox_rejected();
-    void on_buttonBox_helpRequested();
+    void showHelp();
     void on_spinAngle_valueChanged( int spinAngle );
     void on_sliderRotation_valueChanged( int rotationValue );
     void apply();

diff --git a/src/app/qgsdecorationscalebardialog.cpp b/src/app/qgsdecorationscalebardialog.cpp
@@ -25,6 +25,7 @@ QgsDecorationScaleBarDialog::QgsDecorationScaleBarDialog( QgsDecorationScaleBar
   , mDeco( deco )
 {
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsDecorationScaleBarDialog::showHelp );
 
   QgsSettings settings;
   restoreGeometry( settings.value( QStringLiteral( "Windows/DecorationScaleBar/geometry" ) ).toByteArray() );
@@ -88,7 +89,7 @@ QgsDecorationScaleBarDialog::~QgsDecorationScaleBarDialog()
   settings.setValue( QStringLiteral( "Windows/DecorationScaleBar/geometry" ), saveGeometry() );
 }
 
-void QgsDecorationScaleBarDialog::on_buttonBox_helpRequested()
+void QgsDecorationScaleBarDialog::showHelp()
 {
   QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#scale-bar" ) );
 }

diff --git a/src/app/qgsdecorationscalebardialog.h b/src/app/qgsdecorationscalebardialog.h
@@ -29,7 +29,7 @@ class APP_EXPORT QgsDecorationScaleBarDialog : public QDialog, private Ui::QgsDe
   private slots:
     void on_buttonBox_accepted();
     void on_buttonBox_rejected();
-    void on_buttonBox_helpRequested();
+    void showHelp();
     void apply();
 
   protected:

diff --git a/src/app/qgsfieldcalculator.cpp b/src/app/qgsfieldcalculator.cpp
@@ -53,7 +53,7 @@ QgsFieldCalculator::QgsFieldCalculator( QgsVectorLayer *vl, QWidget *parent )
 
   connect( builder, &QgsExpressionBuilderWidget::expressionParsed, this, &QgsFieldCalculator::setOkButtonState );
   connect( mOutputFieldWidthSpinBox, &QAbstractSpinBox::editingFinished, this, &QgsFieldCalculator::setPrecisionMinMax );
-  connect( mButtonBox, &QDialogButtonBox::helpRequested, this, &QgsFieldCalculator::helpRequest );
+  connect( mButtonBox, &QDialogButtonBox::helpRequested, this, &QgsFieldCalculator::showHelp );
 
   QgsDistanceArea myDa;
   myDa.setSourceCrs( vl->crs() );
@@ -484,7 +484,7 @@ void QgsFieldCalculator::setPrecisionMinMax()
   mOutputFieldPrecisionSpinBox->setMaximum( qMax( minPrecType, qMin( maxPrecType, mOutputFieldWidthSpinBox->value() ) ) );
 }
 
-void QgsFieldCalculator::helpRequest()
+void QgsFieldCalculator::showHelp()
 {
-  QgsHelp::openHelp( "working_with_vector/attribute_table.html#editing-attribute-values" );
+  QgsHelp::openHelp( QStringLiteral( "working_with_vector/attribute_table.html#editing-attribute-values" ) );
 }
diff --git a/src/app/qgsfieldcalculator.h b/src/app/qgsfieldcalculator.h
@@ -41,12 +41,12 @@ class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalcula
     void on_mCreateVirtualFieldCheckbox_stateChanged( int state );
     void on_mOutputFieldNameLineEdit_textChanged( const QString &text );
     void on_mOutputFieldTypeComboBox_activated( int index );
-    void helpRequest();
 
   private slots:
     //! Sets the OK button enabled / disabled
     void setOkButtonState();
     void setPrecisionMinMax();
+    void showHelp();
 
   private:
     //! default constructor forbidden

diff --git a/src/app/qgsidentifyresultsdialog.cpp b/src/app/qgsidentifyresultsdialog.cpp
@@ -402,7 +402,7 @@ QgsIdentifyResultsDialog::QgsIdentifyResultsDialog( QgsMapCanvas *canvas, QWidge
   connect( mActionPrint, &QAction::triggered, this, &QgsIdentifyResultsDialog::printCurrentItem );
   connect( mOpenFormAction, &QAction::triggered, this, &QgsIdentifyResultsDialog::featureForm );
   connect( mClearResultsAction, &QAction::triggered, this, &QgsIdentifyResultsDialog::clear );
-  connect( mHelpToolButton, &QAbstractButton::clicked, this, &QgsIdentifyResultsDialog::helpRequested );
+  connect( mHelpToolButton, &QAbstractButton::clicked, this, &QgsIdentifyResultsDialog::showHelp );
 }
 
 QgsIdentifyResultsDialog::~QgsIdentifyResultsDialog()
@@ -1968,3 +1968,8 @@ void QgsIdentifyResultsDialogMapLayerAction::execute()
 {
   mAction->triggerForFeature( mLayer, mFeature );
 }
+
+void QgsIdentifyResultsDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#identify" ) );
+}
diff --git a/src/app/qgsidentifyresultsdialog.h b/src/app/qgsidentifyresultsdialog.h
@@ -201,8 +201,6 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
 
     QTreeWidgetItem *retrieveAttributes( QTreeWidgetItem *item, QgsAttributeMap &attributes, int &currentIdx );
 
-    void helpRequested() { QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#identify" ) ); }
-
     void on_cmbIdentifyMode_currentIndexChanged( int index );
 
     void on_cmbViewMode_currentIndexChanged( int index );
@@ -261,6 +259,8 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
     QgsDockWidget *mDock = nullptr;
 
     QVector<QgsIdentifyPlotCurve *> mPlotCurves;
+
+    void showHelp();
 };
 
 class QgsIdentifyResultsDialogMapLayerAction : public QAction

diff --git a/src/app/qgsmeasuredialog.cpp b/src/app/qgsmeasuredialog.cpp
@@ -36,6 +36,7 @@ QgsMeasureDialog::QgsMeasureDialog( QgsMeasureTool *tool, Qt::WindowFlags f )
   , mTool( tool )
 {
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsMeasureDialog::showHelp );
 
   QPushButton *nb = new QPushButton( tr( "&New" ) );
   buttonBox->addButton( nb, QDialogButtonBox::ActionRole );
@@ -564,3 +565,8 @@ void QgsMeasureDialog::reject()
   restart();
   QDialog::close();
 }
+
+void QgsMeasureDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#measuring" ) );
+}
diff --git a/src/app/qgsmeasuredialog.h b/src/app/qgsmeasuredialog.h
@@ -60,9 +60,6 @@ class APP_EXPORT QgsMeasureDialog : public QDialog, private Ui::QgsMeasureBase
     //! Close event
     void closeEvent( QCloseEvent *e ) override;
 
-    //! Show the help for the dialog
-    void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "introduction/general_tools.html#measuring" ) ); }
-
     //! When any external settings change
     void updateSettings();
 
@@ -119,6 +116,8 @@ class APP_EXPORT QgsMeasureDialog : public QDialog, private Ui::QgsMeasureBase
 
     QgsPointXY mLastMousePoint;
 
+    void showHelp();
+
     friend class TestQgsMeasureTool;
 };
 

diff --git a/src/app/qgsnewspatialitelayerdialog.cpp b/src/app/qgsnewspatialitelayerdialog.cpp
@@ -83,6 +83,8 @@ QgsNewSpatialiteLayerDialog::QgsNewSpatialiteLayerDialog( QWidget *parent, Qt::W
   connect( leLayerName, &QLineEdit::textChanged, this, &QgsNewSpatialiteLayerDialog::checkOk );
   connect( checkBoxPrimaryKey, &QAbstractButton::clicked, this, &QgsNewSpatialiteLayerDialog::checkOk );
 
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsNewSpatialiteLayerDialog::showHelp );
+
   mAddAttributeButton->setEnabled( false );
   mRemoveAttributeButton->setEnabled( false );
 
@@ -456,4 +458,8 @@ QString QgsNewSpatialiteLayerDialog::quotedValue( QString value )
   return value.prepend( '\'' ).append( '\'' );
 }
 
+void QgsNewSpatialiteLayerDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "managing_data_source/create_layers.html#creating-a-new-spatialite-layer" ) );
+}
 
diff --git a/src/app/qgsnewspatialitelayerdialog.h b/src/app/qgsnewspatialitelayerdialog.h
@@ -49,7 +49,6 @@ class APP_EXPORT QgsNewSpatialiteLayerDialog: public QDialog, private Ui::QgsNew
     void selectionChanged();
     void checkOk();
 
-    void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "managing_data_source/create_layers.html#creating-a-new-spatialite-layer" ) ); }
     void on_buttonBox_accepted();
     void on_buttonBox_rejected();
 
@@ -62,6 +61,8 @@ class APP_EXPORT QgsNewSpatialiteLayerDialog: public QDialog, private Ui::QgsNew
 
     bool apply();
 
+    void showHelp();
+
     static QString quotedIdentifier( QString id );
     static QString quotedValue( QString value );
 

diff --git a/src/app/qgsoptions.cpp b/src/app/qgsoptions.cpp
@@ -82,6 +82,7 @@ QgsOptions::QgsOptions( QWidget *parent, Qt::WindowFlags fl, const QList<QgsOpti
   , mSettings( nullptr )
 {
   setupUi( this );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsOptions::showHelp );
 
   // QgsOptionsDialogBase handles saving/restoring of geometry, splitter and current tab states,
   // switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left),
@@ -2352,3 +2353,8 @@ void QgsOptions::setZoomFactorValue()
     spinZoomFactor->setValue( percentValue );
   }
 }
+
+void QgsOptions::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "introduction/qgis_configuration.html#options" ) );
+}
diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h
@@ -180,9 +180,6 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
      * for the browser */
     void on_mBtnRemoveHiddenPath_clicked();
 
-
-    void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "introduction/qgis_configuration.html#options" ) ); }
-
     void on_mBrowseCacheDirectory_clicked();
     void on_mClearCache_clicked();
 
@@ -241,6 +238,8 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
 
     void saveDefaultDatumTransformations();
 
+    void showHelp();
+
     QListWidgetItem *addScaleToScaleList( const QString &newScale );
     void addScaleToScaleList( QListWidgetItem *newItem );