From f9f311f7da7010c1fa856978e6219a9181df7b6c Mon Sep 17 00:00:00 2001 From: Harrissou Sant-anna Date: Mon, 16 Dec 2024 01:15:36 +0100 Subject: [PATCH 1/2] Add help button to labeling rules dialogs --- src/gui/labeling/qgslabelingengineruleswidget.cpp | 6 +++++- src/gui/labeling/qgslabelingenginerulewidget.cpp | 6 +++++- src/ui/labeling/qgslabelingengineruleswidgetbase.ui | 1 - 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/gui/labeling/qgslabelingengineruleswidget.cpp b/src/gui/labeling/qgslabelingengineruleswidget.cpp index 1ef812863a6e..7780f88b1be6 100644 --- a/src/gui/labeling/qgslabelingengineruleswidget.cpp +++ b/src/gui/labeling/qgslabelingengineruleswidget.cpp @@ -20,6 +20,7 @@ #include "qgslabelingenginerule.h" #include "qgslabelingenginerulewidget.h" #include "qgsgui.h" +#include "qgshelp.h" #include #include @@ -408,7 +409,7 @@ QgsLabelingEngineRulesDialog::QgsLabelingEngineRulesDialog( QWidget *parent, Qt: QVBoxLayout *layout = new QVBoxLayout( this ); layout->addWidget( mWidget ); - mButtonBox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel, Qt::Horizontal, this ); + mButtonBox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help, Qt::Horizontal, this ); layout->addWidget( mButtonBox ); setLayout( layout ); @@ -416,6 +417,9 @@ QgsLabelingEngineRulesDialog::QgsLabelingEngineRulesDialog( QWidget *parent, Qt: connect( mButtonBox->button( QDialogButtonBox::Ok ), &QAbstractButton::clicked, this, &QDialog::accept ); connect( mButtonBox->button( QDialogButtonBox::Cancel ), &QAbstractButton::clicked, this, &QDialog::reject ); + connect( mButtonBox, &QDialogButtonBox::helpRequested, this, [=] { + QgsHelp::openHelp( QStringLiteral( "working_with_vector/vector_properties.html#labeling-rules" ) ); + } ); } void QgsLabelingEngineRulesDialog::setRules( const QList &rules ) diff --git a/src/gui/labeling/qgslabelingenginerulewidget.cpp b/src/gui/labeling/qgslabelingenginerulewidget.cpp index 806a70be6632..c90ddd4b2393 100644 --- a/src/gui/labeling/qgslabelingenginerulewidget.cpp +++ b/src/gui/labeling/qgslabelingenginerulewidget.cpp @@ -17,6 +17,7 @@ #include "moc_qgslabelingenginerulewidget.cpp" #include "qgslabelingenginerule_impl.h" #include "qgsgui.h" +#include "qgshelp.h" #include #include @@ -36,7 +37,7 @@ QgsLabelingEngineRuleDialog::QgsLabelingEngineRuleDialog( QgsLabelingEngineRuleW QVBoxLayout *layout = new QVBoxLayout( this ); layout->addWidget( mWidget ); - mButtonBox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel, Qt::Horizontal, this ); + mButtonBox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help, Qt::Horizontal, this ); layout->addWidget( mButtonBox ); setLayout( layout ); @@ -44,6 +45,9 @@ QgsLabelingEngineRuleDialog::QgsLabelingEngineRuleDialog( QgsLabelingEngineRuleW connect( mButtonBox->button( QDialogButtonBox::Ok ), &QAbstractButton::clicked, this, &QDialog::accept ); connect( mButtonBox->button( QDialogButtonBox::Cancel ), &QAbstractButton::clicked, this, &QDialog::reject ); + connect( mButtonBox, &QDialogButtonBox::helpRequested, this, [=] { + QgsHelp::openHelp( QStringLiteral( "working_with_vector/vector_properties.html#labeling-rules" ) ); + } ); } void QgsLabelingEngineRuleDialog::setRule( const QgsAbstractLabelingEngineRule *rule ) diff --git a/src/ui/labeling/qgslabelingengineruleswidgetbase.ui b/src/ui/labeling/qgslabelingengineruleswidgetbase.ui index 89058051ea53..95ff5c7ce7a7 100644 --- a/src/ui/labeling/qgslabelingengineruleswidgetbase.ui +++ b/src/ui/labeling/qgslabelingengineruleswidgetbase.ui @@ -105,7 +105,6 @@ - From 9600da72462f6fba0cc73c8f96cf3992e2cf6a46 Mon Sep 17 00:00:00 2001 From: Harrissou Sant-anna Date: Mon, 16 Dec 2024 22:26:24 +0100 Subject: [PATCH 2/2] Typo fix --- .../labeling/qgslabelingenginesettings.sip.in | 6 +++--- .../labeling/qgslabelingenginesettings.sip.in | 6 +++--- src/core/labeling/qgslabelingenginesettings.h | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/python/PyQt6/core/auto_generated/labeling/qgslabelingenginesettings.sip.in b/python/PyQt6/core/auto_generated/labeling/qgslabelingenginesettings.sip.in index 2a9ad1d288b0..10465e676da8 100644 --- a/python/PyQt6/core/auto_generated/labeling/qgslabelingenginesettings.sip.in +++ b/python/PyQt6/core/auto_generated/labeling/qgslabelingenginesettings.sip.in @@ -247,7 +247,7 @@ Sets the placement engine ``version``, which dictates how the label placement pr QList< QgsAbstractLabelingEngineRule * > rules(); %Docstring -Returns a list of labeling engine rules which must be satifisfied +Returns a list of labeling engine rules which must be satisfied while placing labels. .. seealso:: :py:func:`addRule` @@ -260,7 +260,7 @@ while placing labels. void addRule( QgsAbstractLabelingEngineRule *rule /Transfer/ ); %Docstring -Adds a labeling engine ``rule`` which must be satifisfied +Adds a labeling engine ``rule`` which must be satisfied while placing labels. Ownership of the rule is transferred to the settings. @@ -274,7 +274,7 @@ Ownership of the rule is transferred to the settings. void setRules( const QList< QgsAbstractLabelingEngineRule * > &rules /Transfer/ ); %Docstring -Sets the labeling engine ``rules`` which must be satifisfied +Sets the labeling engine ``rules`` which must be satisfied while placing labels. Ownership of the rules are transferred to the settings. diff --git a/python/core/auto_generated/labeling/qgslabelingenginesettings.sip.in b/python/core/auto_generated/labeling/qgslabelingenginesettings.sip.in index 12417c961f9e..05d61d9e3f1a 100644 --- a/python/core/auto_generated/labeling/qgslabelingenginesettings.sip.in +++ b/python/core/auto_generated/labeling/qgslabelingenginesettings.sip.in @@ -247,7 +247,7 @@ Sets the placement engine ``version``, which dictates how the label placement pr QList< QgsAbstractLabelingEngineRule * > rules(); %Docstring -Returns a list of labeling engine rules which must be satifisfied +Returns a list of labeling engine rules which must be satisfied while placing labels. .. seealso:: :py:func:`addRule` @@ -260,7 +260,7 @@ while placing labels. void addRule( QgsAbstractLabelingEngineRule *rule /Transfer/ ); %Docstring -Adds a labeling engine ``rule`` which must be satifisfied +Adds a labeling engine ``rule`` which must be satisfied while placing labels. Ownership of the rule is transferred to the settings. @@ -274,7 +274,7 @@ Ownership of the rule is transferred to the settings. void setRules( const QList< QgsAbstractLabelingEngineRule * > &rules /Transfer/ ); %Docstring -Sets the labeling engine ``rules`` which must be satifisfied +Sets the labeling engine ``rules`` which must be satisfied while placing labels. Ownership of the rules are transferred to the settings. diff --git a/src/core/labeling/qgslabelingenginesettings.h b/src/core/labeling/qgslabelingenginesettings.h index 9e11d649b9ea..e0f71466249f 100644 --- a/src/core/labeling/qgslabelingenginesettings.h +++ b/src/core/labeling/qgslabelingenginesettings.h @@ -243,7 +243,7 @@ class CORE_EXPORT QgsLabelingEngineSettings void setPlacementVersion( Qgis::LabelPlacementEngineVersion version ); /** - * Returns a list of labeling engine rules which must be satifisfied + * Returns a list of labeling engine rules which must be satisfied * while placing labels. * * \see addRule() @@ -253,7 +253,7 @@ class CORE_EXPORT QgsLabelingEngineSettings QList< QgsAbstractLabelingEngineRule * > rules(); /** - * Returns a list of labeling engine rules which must be satifisfied + * Returns a list of labeling engine rules which must be satisfied * while placing labels. * * \see addRule() @@ -263,7 +263,7 @@ class CORE_EXPORT QgsLabelingEngineSettings QList< const QgsAbstractLabelingEngineRule * > rules() const SIP_SKIP; /** - * Adds a labeling engine \a rule which must be satifisfied + * Adds a labeling engine \a rule which must be satisfied * while placing labels. * * Ownership of the rule is transferred to the settings. @@ -275,7 +275,7 @@ class CORE_EXPORT QgsLabelingEngineSettings void addRule( QgsAbstractLabelingEngineRule *rule SIP_TRANSFER ); /** - * Sets the labeling engine \a rules which must be satifisfied + * Sets the labeling engine \a rules which must be satisfied * while placing labels. * * Ownership of the rules are transferred to the settings.