qgscodeeditorwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgscodeeditorwidget.h
     --------------------------------------
    Date                 : May 2024
    Copyright            : (C) 2024 by Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSCODEEDITORWIDGET_H
#define QGSCODEEDITORWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgspanelwidget.h"
 
#include <QDateTime>
 
class QgsCodeEditor;
class QgsFilterLineEdit;
class QToolButton;
class QCheckBox;
class QgsMessageBar;
class QgsScrollBarHighlightController;
 
SIP_IF_MODULE( HAVE_QSCI_SIP )
 

class GUI_EXPORT QgsCodeEditorWidget : public QgsPanelWidget
{
    Q_OBJECT
 
  public:
    QgsCodeEditorWidget( QgsCodeEditor *editor SIP_TRANSFER, QgsMessageBar *messageBar = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsCodeEditorWidget() override;
 
    void resizeEvent( QResizeEvent *event ) override;
    void showEvent( QShowEvent *event ) override;
    bool eventFilter( QObject *obj, QEvent *event ) override;

    QgsCodeEditor *editor() { return mEditor; }

    bool isSearchBarVisible() const;

    QgsMessageBar *messageBar();

    QgsScrollBarHighlightController *scrollbarHighlightController();

    void addWarning( int lineNumber, const QString &warning );

    void clearWarnings();

    QString filePath() const { return mFilePath; }

    bool save( const QString &path = QString() );
 
  public slots:

    void showSearchBar();

    void hideSearchBar();

    void setSearchBarVisible( bool visible );

    void setReplaceBarVisible( bool visible );

    void triggerFind();

    bool loadFile( const QString &path );

    void setFilePath( const QString &path );

    bool openInExternalEditor( int line = -1, int column = -1 );

    bool shareOnGist( bool isPublic );
 
  signals:

    void searchBarToggled( bool visible );

    void filePathChanged( const QString &path );

    void loadedExternalChanges();
 
  private slots:
 
    bool findNext();
    void findPrevious();
    void textSearchChanged( const QString &text );
    void updateSearch();
    void replace();
    void replaceSelection();
    void replaceAll();
 
  private:
    void clearSearchHighlights();
    void addSearchHighlights();
    int searchFlags() const;
    bool findText( bool forward, bool findFirst );
    void updateHighlightController();
    void searchMatchCountChanged( int matchCount );
 
    enum HighlightCategory
    {
      SearchMatch = 0,
      Warning = 1
    };
 
    QgsCodeEditor *mEditor = nullptr;
    QWidget *mFindWidget = nullptr;
    QgsFilterLineEdit *mLineEditFind = nullptr;
    QgsFilterLineEdit *mLineEditReplace = nullptr;
    QToolButton *mFindPrevButton = nullptr;
    QToolButton *mFindNextButton = nullptr;
    QToolButton *mCaseSensitiveButton = nullptr;
    QToolButton *mWholeWordButton = nullptr;
    QToolButton *mRegexButton = nullptr;
    QToolButton *mWrapAroundButton = nullptr;
    QToolButton *mShowReplaceBarButton = nullptr;
    QToolButton *mReplaceButton = nullptr;
    QToolButton *mReplaceAllButton = nullptr;
    int mBlockSearching = 0;
    QgsMessageBar *mMessageBar = nullptr;
    std::unique_ptr<QgsScrollBarHighlightController> mHighlightController;
    QString mFilePath;
    QDateTime mLastModified;
};
 
#endif // QGSCODEEDITORWIDGET_H