pqPythonTextArea.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef pqPythonTextArea_h
#define pqPythonTextArea_h
 
#include "pqPythonModule.h"
 
#include "pqPythonEditorActions.h"
#include "pqPythonUndoCommand.h"
#include "pqPythonUtils.h"
#include "pqTextLinkerPython.h"
 
#include "vtkType.h" // For vtkTypeUInt32
 
#include <QKeyEvent>
#include <QUndoStack>
#include <QWidget>
 
class pqPythonSyntaxHighlighter;
class pqPythonFileIO;
class pqPythonLineNumberArea;
class QTextEdit;
 
class PQPYTHON_EXPORT pqPythonTextArea : public QWidget
{
  Q_OBJECT
 
public:
  explicit pqPythonTextArea(QWidget* parent);
 
  const QTextEdit* getTextEdit() const { return this->TextEdit; }
 
  QTextEdit* getTextEdit() { return this->TextEdit; }
 
  const QUndoStack& getUndoStack() const { return this->UndoStack; }
 
  bool saveOnClose();
 
  bool openFile(const QString& filename, vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);
 
  void setDefaultSaveDirectory(const QString& dir);
 
  void connectActions(pqPythonEditorActions& actions);
 
  void disconnectActions(pqPythonEditorActions& actions);
 
  const QString& getFilename() const;
 
  bool isEmpty() const;
 
  bool isDirty() const;
 
  void setText(const QString& text);
 
  template <typename T>
  void linkTo(T* /*obj*/)
  {
    static_assert(sizeof(T) == 0, "Only specializations of linkTo(T* t) can be used");
  }
 
  void unlink();
 
  bool isLinkedTo(const QObject* obj) const { return this->TextLinker.isLinkedTo(obj); }
 
  bool isLinked() const { return this->TextLinker.isLinked(); }
 
  QString getLinkedName() const { return this->TextLinker.getSecondObjectName(); }
 
Q_SIGNALS:
  void bufferErased();
 
  void fileOpened(const QString&);
 
  void fileSaved(const QString&);
 
  void contentChanged();
 
protected:
  bool eventFilter(QObject* obj, QEvent* event) override;
 
private:
  void setupActions();
 
  void setupMenus();
 
  QPointer<QTextEdit> TextEdit;
 
  QPointer<pqPythonLineNumberArea> LineNumberArea;
 
  QPointer<pqPythonSyntaxHighlighter> SyntaxHighlighter;
 
  QPointer<pqPythonFileIO> FileIO;
 
  pqTextLinker TextLinker;
 
  QUndoStack UndoStack;
 
  pqPythonTextHistoryEntry lastEntry;
};
 
#include "pqPythonTextArea.txx"
 
#endif // pqPythonTextArea_h