Skip to content
Permalink
Browse files

Allow QgsOptionsPageWidget to set a specific help key to view

when clicking help in the options dialog
  • Loading branch information
nyalldawson committed Sep 23, 2017
1 parent 34b9ae2 commit 8dffa33a27cf42a823be24e4653bd45d476624fe
Showing with 49 additions and 9 deletions.
  1. +13 −0 python/gui/qgsoptionswidgetfactory.sip
  2. +24 −9 src/app/qgsoptions.cpp
  3. +12 −0 src/gui/qgsoptionswidgetfactory.h
@@ -25,6 +25,19 @@ class QgsOptionsPageWidget : QWidget
Constructor for QgsOptionsPageWidget.
%End

virtual QString helpKey() const;
%Docstring
Returns the optional help key for the options page. The default implementation
returns an empty string.

If a non-empty string is returned by this method, it will be used as the help key
retrieved when the "help" button is clicked while this options page is active.

If an empty string is returned by this method the default QGIS options
help will be retrieved.
:rtype: str
%End

public slots:

virtual void apply() = 0;
@@ -2355,19 +2355,34 @@ void QgsOptions::setZoomFactorValue()
void QgsOptions::showHelp()
{
QWidget *activeTab = mOptionsStackedWidget->currentWidget();
QString link = QStringLiteral( "introduction/qgis_configuration.html" );
QString link;

if ( activeTab == mOptionsPageAuth )
// give first priority to created pages which have specified a help key
for ( const QgsOptionsPageWidget *widget : qgsAsConst( mAdditionalOptionWidgets ) )
{
link = QStringLiteral( "auth_system/index.html" );
}
else if ( activeTab == mOptionsPageVariables )
{
link = QStringLiteral( "introduction/general_tools.html#variables" );
if ( widget == activeTab )
{
link = widget->helpKey();
break;
}
}
else if ( activeTab == mOptionsPageCRS )

if ( link.isEmpty() )
{
link = QStringLiteral( "working_with_projections/working_with_projections.html" );
link = QStringLiteral( "introduction/qgis_configuration.html" );

if ( activeTab == mOptionsPageAuth )
{
link = QStringLiteral( "auth_system/index.html" );
}
else if ( activeTab == mOptionsPageVariables )
{
link = QStringLiteral( "introduction/general_tools.html#variables" );
}
else if ( activeTab == mOptionsPageCRS )
{
link = QStringLiteral( "working_with_projections/working_with_projections.html" );
}
}
QgsHelp::openHelp( link );
}
@@ -38,6 +38,18 @@ class GUI_EXPORT QgsOptionsPageWidget : public QWidget
: QWidget( parent )
{}

/**
* Returns the optional help key for the options page. The default implementation
* returns an empty string.
*
* If a non-empty string is returned by this method, it will be used as the help key
* retrieved when the "help" button is clicked while this options page is active.
*
* If an empty string is returned by this method the default QGIS options
* help will be retrieved.
*/
virtual QString helpKey() const { return QString(); }

public slots:

/**

0 comments on commit 8dffa33

Please sign in to comment.
You can’t perform that action at this time.