ctkConsoleWidget.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Library:   CTK
00004  
00005   Copyright (c) 2010  Kitware Inc.
00006 
00007   Licensed under the Apache License, Version 2.0 (the "License");
00008   you may not use this file except in compliance with the License.
00009   You may obtain a copy of the License at
00010 
00011       http://www.commontk.org/LICENSE
00012 
00013   Unless required by applicable law or agreed to in writing, software
00014   distributed under the License is distributed on an "AS IS" BASIS,
00015   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016   See the License for the specific language governing permissions and
00017   limitations under the License.
00018  
00019 =========================================================================*/
00020 /*=========================================================================
00021 
00022    Program: ParaView
00023    Module:    $RCSfile$
00024 
00025    Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
00026    All rights reserved.
00027 
00028    ParaView is a free software; you can redistribute it and/or modify it
00029    under the terms of the ParaView license version 1.2. 
00030 
00031    See License_v1.2.txt for the full ParaView license.
00032    A copy of this license can be obtained by contacting
00033    Kitware Inc.
00034    28 Corporate Drive
00035    Clifton Park, NY 12065
00036    USA
00037 
00038 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00039 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00040 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00041 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
00042 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00043 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00044 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00045 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00046 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00047 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00048 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00049 
00050 =========================================================================*/
00051 
00052 #ifndef __ctkConsoleWidget_h
00053 #define __ctkConsoleWidget_h
00054 
00055 // Qt includes
00056 #include <QWidget>
00057 #include <QTextCharFormat>
00058 #include <QCompleter>
00059 
00060 // CTK includes
00061 #include "CTKWidgetsExport.h"
00062 
00063 class ctkConsoleWidgetCompleter;
00064 
00072 class CTK_WIDGETS_EXPORT ctkConsoleWidget : public QWidget
00073 {
00074   Q_OBJECT
00075   
00076 public:
00077   ctkConsoleWidget(QWidget* Parent);
00078   virtual ~ctkConsoleWidget();
00079 
00081   QTextCharFormat getFormat();
00082   
00084   void setFormat(const QTextCharFormat& Format);
00085 
00087   void setCompleter(ctkConsoleWidgetCompleter* completer);
00088   
00089 signals:
00091   void executeCommand(const QString& Command);
00092 
00093 public slots:
00095   void printString(const QString& Text);
00096 
00099   void printCommand(const QString& cmd);
00100 
00102   void clear();
00103 
00108   void prompt(const QString& text);
00109 
00113   void insertCompletion(const QString& text);
00114 
00115 private:
00116   ctkConsoleWidget(const ctkConsoleWidget&);
00117   ctkConsoleWidget& operator=(const ctkConsoleWidget&);
00118 
00119   void internalExecuteCommand(const QString& Command);
00120 
00121   class pqImplementation;
00122   pqImplementation* const Implementation;
00123   friend class pqImplementation;
00124 };
00125 
00126 //-----------------------------------------------------------------------------
00127 class CTK_WIDGETS_EXPORT ctkConsoleWidgetCompleter : public QCompleter
00128 {
00129 public:
00130 
00134   virtual void updateCompletionModel(const QString& str) = 0;
00135 };
00136 
00137 
00138 #endif // !__ctkConsoleWidget_h
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated on 21 May 2010 for CTK by  doxygen 1.6.1