pqConsoleWidget.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    pqConsoleWidget.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/

#ifndef _pqConsoleWidget_h
#define _pqConsoleWidget_h

#include "pqWidgetsModule.h"

#include <QCompleter>
#include <QTextCharFormat>
#include <QWidget>

class pqConsoleWidgetCompleter;

class PQWIDGETS_EXPORT pqConsoleWidget : public QWidget
{
  Q_OBJECT

public:
  pqConsoleWidget(QWidget* parent = nullptr);
  ~pqConsoleWidget() override;

  QTextCharFormat getFormat();
  void setFormat(const QTextCharFormat& Format);

  void setCompleter(pqConsoleWidgetCompleter* 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);
};

class PQWIDGETS_EXPORT pqConsoleWidgetCompleter : public QCompleter
{
public:
  virtual void updateCompletionModel(const QString& str) = 0;
};

#endif // !_pqConsoleWidget_h