pqConsoleWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqConsoleWidget.h
5 
6  Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =========================================================================*/
32 
33 #ifndef pqConsoleWidget_h
34 #define pqConsoleWidget_h
35 
36 #include "pqWidgetsModule.h"
37 
38 #include <QCompleter>
39 #include <QTextCharFormat>
40 #include <QWidget>
41 
43 
51 class PQWIDGETS_EXPORT pqConsoleWidget : public QWidget
52 {
53  Q_OBJECT
54 
55 public:
56  pqConsoleWidget(QWidget* parent = nullptr);
57  ~pqConsoleWidget() override;
58 
62  QTextCharFormat getFormat();
66  void setFormat(const QTextCharFormat& Format);
67 
71  void setCompleter(pqConsoleWidgetCompleter* completer);
72 
73  QPoint getCursorPosition();
74 
78  void setFontSize(int size);
79 
80 Q_SIGNALS:
84  void executeCommand(const QString& Command);
85 
89  void consoleFocusInEvent();
90 
91 public Q_SLOTS:
95  void printString(const QString& Text);
96 
101  void printCommand(const QString& cmd);
102 
106  QString text();
107 
111  void clear();
112 
119  void prompt(const QString& text);
120 
126  void insertCompletion(const QString& text);
127 
131  void takeFocus();
132 
133 private:
135  pqConsoleWidget& operator=(const pqConsoleWidget&);
136 
137  void internalExecuteCommand(const QString& Command);
138 
139  class pqImplementation;
140  pqImplementation* const Implementation;
141  friend class pqImplementation;
142 
144 
145  int FontSize;
146 
151  void printAndExecuteCommand(const QString& text);
152 };
153 
155 {
156 public:
162  virtual void updateCompletionModel(const QString& str) = 0;
163 };
164 
165 #endif // !pqConsoleWidget_h
Text
#define PQWIDGETS_EXPORT
size
Qt widget that provides an interactive console - you can send text to the console by calling printStr...
pqConsoleWidgetEventPlayer is used to play back test commands recorded by pqConsoleWidgetEventTransla...