src/PyConsole/PyConsole_Console.h

   1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 // File   : PyConsole_Console.h
  24 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  25 //
  26 #ifndef PYCONSOLE_CONSOLE_H
  27 #define PYCONSOLE_CONSOLE_H
  28
  29 #include "PyConsole.h"
  30
  31 #include <SUIT_PopupClient.h>
  32 #include <QWidget>
  33 #include <QMap>
  34
  35 class PyConsole_Interp;
  36 class PyConsole_Editor;
  37 class PyConsole_EnhInterp;
  38
  39 class PYCONSOLE_EXPORT PyConsole_Console : public QWidget, public SUIT_PopupClient
  40 {
  41   Q_OBJECT
  42
  43 public:
  44   //! Context popup menu actions flags
  45   enum
  46   {
  47     CopyId         = 0x01,                                                      //!< "Copy" menu action
  48     PasteId        = 0x02,                                                      //!< "Paste" menu action
  49     ClearId        = 0x04,                                                      //!< "Clear" menu action
  50     SelectAllId    = 0x08,                                                      //!< "Select All" menu action
  51     DumpCommandsId = 0x10,                                                      //!< "DumpCommands" menu action
  52     SaveLogId      = 0x20,                                                      //!< "Save log" menu action
  53     All = CopyId | PasteId | ClearId | SelectAllId | DumpCommandsId | SaveLogId //!< all menu actions
  54   };
  55
  56 public:
  57   PyConsole_Console( QWidget* parent, PyConsole_Interp* interp = 0 );
  58   virtual ~PyConsole_Console();
  59
  60   //! \brief Get python interperter
  61   PyConsole_Interp*   getInterp() { return myInterp; }
  62   QFont               font() const;
  63   virtual void        setFont( const QFont& );
  64
  65   bool                isSync() const;
  66   void                setIsSync( const bool );
  67
  68   bool                isSuppressOutput() const;
  69   void                setIsSuppressOutput( const bool );
  70
  71   bool                isShowBanner() const;
  72   void                setIsShowBanner( const bool );
  73
  74   void                exec( const QString& );
  75   void                execAndWait( const QString& );
  76
  77   virtual bool        eventFilter( QObject*, QEvent* );
  78
  79   //! \brief Get popup client symbolic name
  80   virtual QString     popupClientType() const { return QString( "PyConsole" ); }
  81   virtual void        contextMenuPopup( QMenu* );
  82
  83   void                setMenuActions( const int );
  84   int                 menuActions() const;
  85
  86 protected:
  87   void                createActions();
  88   void                updateActions();
  89
  90   PyConsole_Console( QWidget* parent, PyConsole_Interp*,  PyConsole_Editor*);
  91
  92
  93   PyConsole_Interp*   myInterp;    //!< python interpreter
  94   PyConsole_Editor*   myEditor;    //!< python console editor widget
  95   QMap<int, QAction*> myActions;   //!< menu actions list
  96 };
  97
  98 /**
  99  * Enhance console object providing auto-completion.
 100  * Similar to PyConsole_Console except that an enhanced interpreter and enhanced editor
 101  * are encapsulated.
 102  */
 103 class PYCONSOLE_EXPORT PyConsole_EnhConsole: public PyConsole_Console
 104 {
 105   Q_OBJECT
 106
 107 public:
 108   PyConsole_EnhConsole( QWidget* parent, PyConsole_EnhInterp* interp = 0);
 109   virtual ~PyConsole_EnhConsole() {}
 110 };
 111
 112 #endif // PYCONSOLE_CONSOLE_H