ParaView
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 :
52  public QWidget
53 {
54  Q_OBJECT
55 
56 public:
57  pqConsoleWidget(QWidget* Parent);
58  virtual ~pqConsoleWidget();
59 
61  QTextCharFormat getFormat();
63  void setFormat(const QTextCharFormat& Format);
64 
66  void setCompleter(pqConsoleWidgetCompleter* completer);
67 
68  QPoint getCursorPosition();
69 
70 signals:
72  void executeCommand(const QString& Command);
73 
74 public slots:
76  void printString(const QString& Text);
77 
80  void printCommand(const QString& cmd);
81 
83  void clear();
84 
89  void prompt(const QString& text);
90 
94  void insertCompletion(const QString& text);
95 
96 private:
98  pqConsoleWidget& operator=(const pqConsoleWidget&);
99 
100  void internalExecuteCommand(const QString& Command);
101 
102  class pqImplementation;
103  pqImplementation* const Implementation;
104  friend class pqImplementation;
105 
107 
110  void printAndExecuteCommand(const QString& text);
111 };
112 
113 
114 class PQWIDGETS_EXPORT pqConsoleWidgetCompleter : public QCompleter
115 {
116 public:
117 
121  virtual void updateCompletionModel(const QString& str) = 0;
122 };
123 
124 
125 #endif // !_pqConsoleWidget_h
126 
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...