JSON edit clickable links in text view (#43214)

qgis · May 14, 2021 · a57a8dc · a57a8dc
1 parent 1d88f38
commit a57a8dc
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 0 deletions.
diff --git a/src/gui/editorwidgets/qgsjsoneditwidget.cpp b/src/gui/editorwidgets/qgsjsoneditwidget.cpp
@@ -19,6 +19,7 @@
 #include <QJsonArray>
 #include <QLabel>
 #include <QPushButton>
+#include <QToolTip>
 #include <QUrl>
 
 QgsJsonEditWidget::QgsJsonEditWidget( QWidget *parent )
@@ -31,18 +32,27 @@ QgsJsonEditWidget::QgsJsonEditWidget( QWidget *parent )
   mCodeEditorJson->setReadOnly( true );
   mCodeEditorJson->setHorizontalScrollBarPolicy( Qt::ScrollBarAsNeeded );
   mCodeEditorJson->setVerticalScrollBarPolicy( Qt::ScrollBarAsNeeded );
+  mCodeEditorJson->indicatorDefine( QsciScintilla::PlainIndicator, SCINTILLA_UNDERLINE_INDICATOR_INDEX );
+  mCodeEditorJson->SendScintilla( QsciScintillaBase::SCI_SETINDICATORCURRENT, SCINTILLA_UNDERLINE_INDICATOR_INDEX );
+  mCodeEditorJson->SendScintilla( QsciScintillaBase::SCI_SETMOUSEDWELLTIME, 400 );
 
   mTreeWidget->setStyleSheet( QStringLiteral( "font-family: %1;" ).arg( QgsCodeEditor::getMonospaceFont().family() ) );
 
   connect( mTextToolButton, &QToolButton::clicked, this, &QgsJsonEditWidget::textToolButtonClicked );
   connect( mTreeToolButton, &QToolButton::clicked, this, &QgsJsonEditWidget::treeToolButtonClicked );
 
   connect( mCodeEditorJson, &QgsCodeEditorJson::textChanged, this, &QgsJsonEditWidget::codeEditorJsonTextChanged );
+  // Signal indicatorClicked is used because indicatorReleased has a bug in Scintilla and the keyboard modifier state
+  // parameter is not correct. Merge request was submittet to fix it: https://sourceforge.net/p/scintilla/code/merge-requests/26/
+  connect( mCodeEditorJson, &QsciScintilla::indicatorClicked, this, &QgsJsonEditWidget::codeEditorJsonIndicatorClicked );
+  connect( mCodeEditorJson, &QsciScintillaBase::SCN_DWELLSTART, this, &QgsJsonEditWidget::codeEditorJsonDwellStart );
+  connect( mCodeEditorJson, &QsciScintillaBase::SCN_DWELLEND, this, &QgsJsonEditWidget::codeEditorJsonDwellEnd );
 }
 
 void QgsJsonEditWidget::setJsonText( const QString &jsonText )
 {
   mJsonText = jsonText;
+  mClickableLinkList.clear();
 
   const QJsonDocument jsonDocument = QJsonDocument::fromJson( mJsonText.toUtf8() );
 
@@ -125,6 +135,44 @@ void QgsJsonEditWidget::codeEditorJsonTextChanged()
   refreshTreeView( jsonDocument );
 }
 
+void QgsJsonEditWidget::codeEditorJsonIndicatorClicked( int line, int index, Qt::KeyboardModifiers state )
+{
+  if ( !state.testFlag( Qt::ControlModifier ) )
+    return;
+
+  int position = mCodeEditorJson->positionFromLineIndex( line, index );
+  int clickableLinkListIndex = mCodeEditorJson->SendScintilla( QsciScintillaBase::SCI_INDICATORVALUEAT,
+                               SCINTILLA_UNDERLINE_INDICATOR_INDEX,
+                               position );
+  if ( clickableLinkListIndex <= 0 )
+    return;
+
+  QDesktopServices::openUrl( mClickableLinkList.at( clickableLinkListIndex - 1 ) );
+}
+
+void QgsJsonEditWidget::codeEditorJsonDwellStart( int position, int x, int y )
+{
+  Q_UNUSED( x )
+  Q_UNUSED( y )
+
+  int clickableLinkListIndex = mCodeEditorJson->SendScintilla( QsciScintillaBase::SCI_INDICATORVALUEAT,
+                               SCINTILLA_UNDERLINE_INDICATOR_INDEX,
+                               position );
+  if ( clickableLinkListIndex <= 0 )
+    return;
+
+  QToolTip::showText( QCursor::pos(),
+                      tr( "%1\nCTRL + click to follow link" ).arg( mClickableLinkList.at( clickableLinkListIndex - 1 ) ) );
+}
+
+void QgsJsonEditWidget::codeEditorJsonDwellEnd( int position, int x, int y )
+{
+  Q_UNUSED( position )
+  Q_UNUSED( x )
+  Q_UNUSED( y )
+  QToolTip::hideText();
+}
+
 void QgsJsonEditWidget::refreshTreeView( const QJsonDocument &jsonDocument )
 {
   mTreeWidget->clear();
@@ -199,6 +247,12 @@ void QgsJsonEditWidget::refreshTreeViewItemValue( const QJsonValue &jsonValue, Q
         {
           QDesktopServices::openUrl( link );
         } );
+
+        mClickableLinkList.append( jsonValueString );
+        mCodeEditorJson->SendScintilla( QsciScintillaBase::SCI_SETINDICATORVALUE, mClickableLinkList.size() );
+        mCodeEditorJson->SendScintilla( QsciScintillaBase::SCI_INDICATORFILLRANGE,
+                                        mCodeEditorJson->text().indexOf( jsonValueString ),
+                                        jsonValueString.size() );
       }
     }
     break;

diff --git a/src/gui/editorwidgets/qgsjsoneditwidget.h b/src/gui/editorwidgets/qgsjsoneditwidget.h
@@ -83,6 +83,9 @@ class GUI_EXPORT QgsJsonEditWidget : public QWidget, private Ui::QgsJsonEditWidg
     void treeToolButtonClicked( bool checked );
 
     void codeEditorJsonTextChanged();
+    void codeEditorJsonIndicatorClicked( int line, int index, Qt::KeyboardModifiers state );
+    void codeEditorJsonDwellStart( int position, int x, int y );
+    void codeEditorJsonDwellEnd( int position, int x, int y );
 
   private:
 
@@ -92,12 +95,16 @@ class GUI_EXPORT QgsJsonEditWidget : public QWidget, private Ui::QgsJsonEditWidg
       Value = 1
     };
 
+    const int SCINTILLA_UNDERLINE_INDICATOR_INDEX = 15;
+
     void refreshTreeView( const QJsonDocument &jsonDocument );
     void refreshTreeViewItemValue( const QJsonValue &jsonValue, QTreeWidgetItem *treeWidgetItemParent );
 
     QString mJsonText;
 
     FormatJson mFormatJsonMode = FormatJson::Indented;
+
+    QStringList mClickableLinkList;
 };
 
 #endif // QGSJSONEDITWIDGET_H