1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
|
// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqPythonTabWidget_h
#define pqPythonTabWidget_h
#include "pqPythonModule.h"
#include "vtkType.h" // For vtkTypeUInt32
#include <QLabel>
#include <QMouseEvent>
#include <QStyle>
#include <QTabWidget>
class pqPythonTextArea;
struct pqPythonEditorActions;
/**
* @class pqPythonTabWidget
* @brief Encapsulates the multitab python editor
* @details Provides a QWidget with multiple QTextArea
* to edit python scripts in paraview. The widget handles
* automatic saving, syntax highlighting and undo/redo
* features within each tab.
*/
class PQPYTHON_EXPORT pqPythonTabWidget : public QTabWidget
{
Q_OBJECT
public:
/**
* @brief Default constructor
* @param[in] parent the QWidget owning this widget
*/
pqPythonTabWidget(QWidget* parent);
/**
* @brief Returns the current displayed \ref pqPythonTextArea
*/
pqPythonTextArea* getCurrentTextArea() const;
/**
* @brief Connects this class to the actions
*/
void connectActions(pqPythonEditorActions& actions);
/**
* @brief Connects the current \ref pqPythonTextArea
* to the actions
*/
void updateActions(pqPythonEditorActions& actions);
/**
* @brief Returns true if all opened buffer
* were saved on the disk.
*/
bool saveOnClose();
/**
* @brief Update the text in the paraview trace
* tab. Creates a new one if the tab doesn't exist.
*/
void updateTrace(const QString& str);
/**
* @brief Update the text in the paraview python
* trace tab and converts it into a unamed script.
* If no tab exists, creates a new one.
*/
void stopTrace(const QString& str);
/**
* @brief Link the input QTextEdit to
* one of the tab of the editor.
* If this objects is already linked within
* the editor, switch to that tab otherwise creates
* a new one
*/
template <typename T>
void linkTo(T* /*obj*/)
{
static_assert(sizeof(T) == 0, "Only specializations of linkTo(T* t) can be used");
}
void loadFile(const QString& filename);
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
/**
* @brief Add a new empty text area
*/
void createNewEmptyTab();
/**
* @brief Loads the content of the file
* into the current tab if it's empty
* and not linked to another QText.
* Otherwise adds a new tab.
*/
void addNewTextArea(
const QString& filename, vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);
/**
* @brief Request to close the current tab
*/
void closeCurrentTab();
Q_SIGNALS:
/**
* @brief Raised when a file has been opened and loaded
* into the text edit widget
*/
void fileOpened(const QString&);
/**
* @brief Raised when a file has been saved successfuly
*/
void fileSaved(const QString&);
protected:
void keyPressEvent(QKeyEvent* keyEvent) override;
void mousePressEvent(QMouseEvent* mouseEvent) override;
private:
void updateTab(QWidget* widget);
void addNewTabWidget();
void setTabCloseButton(pqPythonTextArea* widget);
void createParaviewTraceTab();
void generateTabName(const pqPythonTextArea* widget, QString& tabName, QString& elidedTabName,
QString& unstyledTabName) const;
/**
* @brief Returns -1 if the editor doesn't contain
* this file. Otherwise returns the index
*/
int fileIsOpened(const QString& filename) const;
template <typename T>
T* getWidget(int idx) const
{
if (idx < 0 || idx >= this->count() - 1)
{
return nullptr;
}
return reinterpret_cast<T*>(this->widget(idx));
}
pqPythonTextArea* lastFocus = nullptr;
pqPythonTextArea* TraceWidget = nullptr;
};
#include "pqPythonTabWidget.txx"
#endif // pqPythonTabWidget_h
|