pqConsoleWidget.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 pqConsoleWidget_h
#define pqConsoleWidget_h
 
#include "pqWidgetCompleter.h"
#include "pqWidgetsModule.h"
 
#include <QTextCharFormat>
#include <QWidget>
 
class PQWIDGETS_EXPORT pqConsoleWidget : public QWidget
{
  Q_OBJECT
 
public:
  pqConsoleWidget(QWidget* parent = nullptr);
  ~pqConsoleWidget() override;
 
  QTextCharFormat getFormat();
  void setFormat(const QTextCharFormat& Format);
 
  void setCompleter(pqWidgetCompleter* completer);
 
  QPoint getCursorPosition();
 
  void setFontSize(int size);
 
Q_SIGNALS:
  void executeCommand(const QString& Command);
 
  void consoleFocusInEvent();
 
public Q_SLOTS:
  void printString(const QString& Text);
 
  void printCommand(const QString& cmd);
 
  QString text();
 
  void clear();
 
  void prompt(const QString& text);
 
  void insertCompletion(const QString& text);
 
  void takeFocus();
 
private:
  pqConsoleWidget(const pqConsoleWidget&);
  pqConsoleWidget& operator=(const pqConsoleWidget&);
 
  void internalExecuteCommand(const QString& Command);
 
  class pqImplementation;
  pqImplementation* const Implementation;
  friend class pqImplementation;
 
  friend class pqConsoleWidgetEventPlayer;
 
  int FontSize;
 
  void printAndExecuteCommand(const QString& text);
};
 
#endif // pqConsoleWidget_h