qgsjsoneditwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsjsoneditwidget.h
     --------------------------------------
    Date                 : 3.5.2021
    Copyright            : (C) 2021 Damiano Lombardi
    Email                : damiano at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSJSONEDITWIDGET_H
#define QGSJSONEDITWIDGET_H
 
#include "ui_qgsjsoneditwidget.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgseditorconfigwidget.h"
 
SIP_IF_MODULE( HAVE_QSCI_SIP )
 

class GUI_EXPORT QgsJsonEditWidget : public QWidget, private Ui::QgsJsonEditWidget
{
    Q_OBJECT
 
  public:
    enum class View : int
    {
      Text = 0, 
      Tree = 1  
    };

    enum class FormatJson : int
    {
      Indented = 0, 
      Compact = 1,  
      Disabled = 2  
    };

    explicit QgsJsonEditWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QgsCodeEditorJson *jsonEditor();

    void setJsonText( const QString &jsonText );

    QString jsonText() const;

    void setView( View view ) const;

    void setFormatJsonMode( FormatJson formatJson );

    void setControlsVisible( bool visible );
 
  private slots:
 
    void textToolButtonClicked( bool checked );
    void treeToolButtonClicked( bool checked );
 
    void copyValueActionTriggered();
    void copyKeyActionTriggered();
 
    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:
    enum class TreeWidgetColumn : int
    {
      Key = 0,
      Value = 1
    };
 
    const int SCINTILLA_UNDERLINE_INDICATOR_INDEX = 15;
 
    void refreshTreeView( const QJsonDocument &jsonDocument );
    void refreshTreeViewItem( QTreeWidgetItem *treeWidgetItemParent, const QJsonValue &jsonValue );
    void refreshTreeViewItemValue( QTreeWidgetItem *treeWidgetItem, const QString &jsonValueString, const QColor &textColor );
 
    QFont monospaceFont() const;
 
    QString mJsonText;
 
    FormatJson mFormatJsonMode = FormatJson::Indented;
 
    QStringList mClickableLinkList;
 
    QAction *mCopyValueAction;
    QAction *mCopyKeyAction;
 
    bool mEnableUrlHighlighting = true;
};
 
#endif // QGSJSONEDITWIDGET_H