Add help button and link to user manual

to some print layout dialogs
qgis · Jun 21, 2019 · 4fdcc4b · 4fdcc4b
1 parent 4c2a533
commit 4fdcc4b
Show file tree

Hide file tree

Showing 19 changed files with 64 additions and 62 deletions.
diff --git a/src/app/layout/qgslayoutaddpagesdialog.cpp b/src/app/layout/qgslayoutaddpagesdialog.cpp
@@ -19,6 +19,7 @@
 #include "qgslayout.h"
 #include "qgslayoutmeasurementconverter.h"
 #include "qgslayoutpagecollection.h"
+#include "qgshelp.h"
 
 QgsLayoutAddPagesDialog::QgsLayoutAddPagesDialog( QWidget *parent, Qt::WindowFlags flags )
   : QDialog( parent, flags )
@@ -53,6 +54,8 @@ QgsLayoutAddPagesDialog::QgsLayoutAddPagesDialog( QWidget *parent, Qt::WindowFla
 
   connect( mWidthSpin, static_cast< void ( QDoubleSpinBox::* )( double )>( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutAddPagesDialog::setToCustomSize );
   connect( mHeightSpin, static_cast< void ( QDoubleSpinBox::* )( double )>( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutAddPagesDialog::setToCustomSize );
+
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsLayoutAddPagesDialog::showHelp );
 }
 
 void QgsLayoutAddPagesDialog::setLayout( QgsLayout *layout )
@@ -158,3 +161,8 @@ void QgsLayoutAddPagesDialog::setToCustomSize()
   mLockAspectRatio->setEnabled( true );
   mSizeUnitsComboBox->setEnabled( true );
 }
+
+void QgsLayoutAddPagesDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "print_composer/overview_composer.html#working-with-the-page-properties" ) );
+}
diff --git a/src/app/layout/qgslayoutaddpagesdialog.h b/src/app/layout/qgslayoutaddpagesdialog.h
@@ -79,6 +79,7 @@ class QgsLayoutAddPagesDialog : public QDialog, private Ui::QgsLayoutNewPageDial
     void pageSizeChanged( int index );
     void orientationChanged( int index );
     void setToCustomSize();
+    void showHelp();
 
   private:
 

diff --git a/src/app/layout/qgslayoutattributeselectiondialog.cpp b/src/app/layout/qgslayoutattributeselectiondialog.cpp
@@ -22,6 +22,7 @@
 #include "qgsdoublespinbox.h"
 #include "qgssettings.h"
 #include "qgslayouttablecolumn.h"
+#include "qgshelp.h"
 
 #include <QCheckBox>
 #include <QDialogButtonBox>
@@ -895,6 +896,7 @@ QgsLayoutAttributeSelectionDialog::QgsLayoutAttributeSelectionDialog( QgsLayoutI
   connect( mRemoveSortColumnPushButton, &QPushButton::clicked, this, &QgsLayoutAttributeSelectionDialog::mRemoveSortColumnPushButton_clicked );
   connect( mSortColumnUpPushButton, &QPushButton::clicked, this, &QgsLayoutAttributeSelectionDialog::mSortColumnUpPushButton_clicked );
   connect( mSortColumnDownPushButton, &QPushButton::clicked, this, &QgsLayoutAttributeSelectionDialog::mSortColumnDownPushButton_clicked );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsLayoutAttributeSelectionDialog::showHelp );
 
   QgsSettings settings;
   restoreGeometry( settings.value( QStringLiteral( "Windows/AttributeSelectionDialog/geometry" ) ).toByteArray() );
@@ -1032,6 +1034,11 @@ void QgsLayoutAttributeSelectionDialog::mRemoveSortColumnPushButton_clicked()
   mSortColumnTableView->selectRow( rowToRemove );
 }
 
+void QgsLayoutAttributeSelectionDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "print_composer/composer_items/composer_attribute_table.html" ) );
+}
+
 void QgsLayoutAttributeSelectionDialog::mSortColumnUpPushButton_clicked()
 {
   //find selected row

diff --git a/src/app/layout/qgslayoutattributeselectiondialog.h b/src/app/layout/qgslayoutattributeselectiondialog.h
@@ -299,6 +299,7 @@ class QgsLayoutAttributeSelectionDialog: public QDialog, private Ui::QgsLayoutAt
     void mRemoveSortColumnPushButton_clicked();
     void mSortColumnUpPushButton_clicked();
     void mSortColumnDownPushButton_clicked();
+    void showHelp();
 
   private:
     QgsLayoutItemAttributeTable *mTable = nullptr;

diff --git a/src/app/layout/qgslayoutdesignerdialog.cpp b/src/app/layout/qgslayoutdesignerdialog.cpp
@@ -42,6 +42,7 @@
 #include "qgsrendercontext.h"
 #include "qgsmessagebar.h"
 #include "qgsmessageviewer.h"
+#include "qgshelp.h"
 #include "qgsgui.h"
 #include "qgsfeedback.h"
 #include "qgslayoutitemguiregistry.h"
@@ -4093,6 +4094,12 @@ bool QgsLayoutDesignerDialog::getSvgExportSettings( QgsLayoutExporter::SvgExport
   Ui::QgsSvgExportOptionsDialog options;
   options.setupUi( &dialog );
 
+  connect( options.buttonBox, &QDialogButtonBox::helpRequested, this, [ & ]
+  {
+    QgsHelp::openHelp( QStringLiteral( "print_composer/create_output.html" ) );
+  }
+         );
+
   options.mTextRenderFormatComboBox->addItem( tr( "Always Export Text as Paths (Recommended)" ), QgsRenderContext::TextFormatAlwaysOutlines );
   options.mTextRenderFormatComboBox->addItem( tr( "Always Export Text as Text Objects" ), QgsRenderContext::TextFormatAlwaysText );
 
@@ -4176,6 +4183,12 @@ bool QgsLayoutDesignerDialog::getPdfExportSettings( QgsLayoutExporter::PdfExport
   Ui::QgsPdfExportOptionsDialog options;
   options.setupUi( &dialog );
 
+  connect( options.buttonBox, &QDialogButtonBox::helpRequested, this, [ & ]
+  {
+    QgsHelp::openHelp( QStringLiteral( "print_composer/create_output.html" ) );
+  }
+         );
+
   options.mTextRenderFormatComboBox->addItem( tr( "Always Export Text as Paths (Recommended)" ), QgsRenderContext::TextFormatAlwaysOutlines );
   options.mTextRenderFormatComboBox->addItem( tr( "Always Export Text as Text Objects" ), QgsRenderContext::TextFormatAlwaysText );
 

diff --git a/src/app/layout/qgslayoutimageexportoptionsdialog.cpp b/src/app/layout/qgslayoutimageexportoptionsdialog.cpp
@@ -19,6 +19,7 @@
 #include "qgis.h"
 #include "qgssettings.h"
 #include "qgsgui.h"
+#include "qgshelp.h"
 
 #include <QCheckBox>
 #include <QPushButton>
@@ -32,7 +33,7 @@ QgsLayoutImageExportOptionsDialog::QgsLayoutImageExportOptionsDialog( QWidget *p
   connect( mResolutionSpinBox, static_cast < void ( QSpinBox::* )( int ) > ( &QSpinBox::valueChanged ), this, &QgsLayoutImageExportOptionsDialog::mResolutionSpinBox_valueChanged );
 
   connect( mClipToContentGroupBox, &QGroupBox::toggled, this, &QgsLayoutImageExportOptionsDialog::clipToContentsToggled );
-
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsLayoutImageExportOptionsDialog::showHelp );
   QgsGui::enableAutoGeometryRestore( this );
 }
 
@@ -185,3 +186,8 @@ void QgsLayoutImageExportOptionsDialog::clipToContentsToggled( bool state )
     whileBlocking( mHeightSpinBox )->setValue( mImageSize.height() * mResolutionSpinBox->value() / 25.4 );
   }
 }
+
+void QgsLayoutImageExportOptionsDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "print_composer/create_output.html" ) );
+}
diff --git a/src/app/layout/qgslayoutimageexportoptionsdialog.h b/src/app/layout/qgslayoutimageexportoptionsdialog.h
@@ -133,6 +133,7 @@ class QgsLayoutImageExportOptionsDialog: public QDialog, private Ui::QgsLayoutIm
     void mHeightSpinBox_valueChanged( int value );
     void mResolutionSpinBox_valueChanged( int value );
     void clipToContentsToggled( bool state );
+    void showHelp();
 
   private:
 

diff --git a/src/app/layout/qgslayouttablebackgroundcolorsdialog.cpp b/src/app/layout/qgslayouttablebackgroundcolorsdialog.cpp
@@ -19,6 +19,7 @@
 #include "qgslayouttable.h"
 #include "qgslayout.h"
 #include "qgssettings.h"
+#include "qgshelp.h"
 
 #include <QCheckBox>
 #include <QPushButton>
@@ -30,6 +31,7 @@ QgsLayoutTableBackgroundColorsDialog::QgsLayoutTableBackgroundColorsDialog( QgsL
   setupUi( this );
   connect( buttonBox, &QDialogButtonBox::accepted, this, &QgsLayoutTableBackgroundColorsDialog::buttonBox_accepted );
   connect( buttonBox, &QDialogButtonBox::rejected, this, &QgsLayoutTableBackgroundColorsDialog::buttonBox_rejected );
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsLayoutTableBackgroundColorsDialog::showHelp );
 
   mCheckBoxMap.insert( QgsLayoutTable::OddColumns, mOddColumnsCheckBox );
   mCheckBoxMap.insert( QgsLayoutTable::EvenColumns, mEvenColumnsCheckBox );
@@ -97,6 +99,11 @@ void QgsLayoutTableBackgroundColorsDialog::buttonBox_rejected()
   reject();
 }
 
+void QgsLayoutTableBackgroundColorsDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "print_composer/composer_items/composer_attribute_table.html#appearance" ) );
+}
+
 void QgsLayoutTableBackgroundColorsDialog::setGuiElementValues()
 {
   if ( !mTable )

diff --git a/src/app/layout/qgslayouttablebackgroundcolorsdialog.h b/src/app/layout/qgslayouttablebackgroundcolorsdialog.h
@@ -50,6 +50,7 @@ class QgsLayoutTableBackgroundColorsDialog: public QDialog, private Ui::QgsLayou
 
     void buttonBox_accepted();
     void buttonBox_rejected();
+    void showHelp();
 
   private:
 

diff --git a/src/gui/layout/qgslayoutnewitempropertiesdialog.cpp b/src/gui/layout/qgslayoutnewitempropertiesdialog.cpp
@@ -17,6 +17,7 @@
 #include "qgssettings.h"
 #include "qgslayout.h"
 #include "qgslayoutpagecollection.h"
+#include "qgshelp.h"
 #include "qgsgui.h"
 
 #include <QButtonGroup>
@@ -54,6 +55,8 @@ QgsLayoutItemPropertiesDialog::QgsLayoutItemPropertiesDialog( QWidget *parent, Q
 
   mLockAspectRatio->setWidthSpinBox( mWidthSpin );
   mLockAspectRatio->setHeightSpinBox( mHeightSpin );
+
+  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsLayoutItemPropertiesDialog::showHelp );
 }
 
 void QgsLayoutItemPropertiesDialog::setItemPosition( QgsLayoutPoint position )
@@ -182,3 +185,8 @@ void QgsLayoutItemPropertiesDialog::setLayout( QgsLayout *layout )
   mPosUnitsComboBox->setConverter( &layout->renderContext().measurementConverter() );
   mLayout = layout;
 }
+
+void QgsLayoutItemPropertiesDialog::showHelp()
+{
+  QgsHelp::openHelp( QStringLiteral( "print_composer/composer_items/composer_items_options.html#creating-a-layout-item" ) );
+}
diff --git a/src/gui/layout/qgslayoutnewitempropertiesdialog.h b/src/gui/layout/qgslayoutnewitempropertiesdialog.h
@@ -96,6 +96,9 @@ class GUI_EXPORT QgsLayoutItemPropertiesDialog : public QDialog, private Ui::Qgs
 
     QgsLayout *mLayout = nullptr;
 
+  private slots:
+    void showHelp();
+
 };
 
 #endif // QGSLAYOUTNEWITEMPROPERTIESDIALOG_H
diff --git a/src/ui/layout/qgslayoutattributeselectiondialogbase.ui b/src/ui/layout/qgslayoutattributeselectiondialogbase.ui
@@ -254,7 +254,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Ok</set>
      </property>
     </widget>
    </item>
@@ -278,32 +278,6 @@
  </tabstops>
  <resources>
   <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
  </resources>
  <connections>
   <connection>

diff --git a/src/ui/layout/qgslayoutattributetablewidgetbase.ui b/src/ui/layout/qgslayoutattributetablewidgetbase.ui
@@ -896,34 +896,6 @@
  </tabstops>
  <resources>
   <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
-  <include location="../../../images/images.qrc"/>
  </resources>
  <connections/>
 </ui>
diff --git a/src/ui/layout/qgslayoutimageexportoptions.ui b/src/ui/layout/qgslayoutimageexportoptions.ui
@@ -273,7 +273,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Save</set>
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Save</set>
      </property>
     </widget>
    </item>

diff --git a/src/ui/layout/qgslayoutnewitemproperties.ui b/src/ui/layout/qgslayoutnewitemproperties.ui
@@ -205,7 +205,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Ok</set>
      </property>
     </widget>
    </item>

diff --git a/src/ui/layout/qgslayoutnewpagedialog.ui b/src/ui/layout/qgslayoutnewpagedialog.ui
@@ -207,7 +207,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Ok</set>
      </property>
     </widget>
    </item>

diff --git a/src/ui/layout/qgslayouttablebackgroundstyles.ui b/src/ui/layout/qgslayouttablebackgroundstyles.ui
@@ -239,7 +239,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Apply|QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+      <set>QDialogButtonBox::Apply|QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Ok</set>
      </property>
     </widget>
    </item>

diff --git a/src/ui/layout/qgspdfexportoptions.ui b/src/ui/layout/qgspdfexportoptions.ui
@@ -94,7 +94,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Save</set>
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Save</set>
      </property>
     </widget>
    </item>

diff --git a/src/ui/layout/qgssvgexportoptions.ui b/src/ui/layout/qgssvgexportoptions.ui
@@ -209,7 +209,7 @@
       <enum>Qt::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Save</set>
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Help|QDialogButtonBox::Save</set>
      </property>
     </widget>
    </item>