src/PyConsole/PyConsole_Console.h

   1 // Copyright (C) 2007-2013  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.
  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 = 0x16,                                           //!< "DumpCommands" menu action
  52     All = CopyId | PasteId | ClearId | SelectAllId | DumpCommandsId  //!< all menu actions
  53   };
  54
  55 public:
  56   PyConsole_Console( QWidget* parent, PyConsole_Interp* interp = 0 );
  57   virtual ~PyConsole_Console();
  58
  59   //! \brief Get python interperter
  60   PyConsole_Interp*   getInterp() { return myInterp; }
  61   QFont               font() const;
  62   virtual void        setFont( const QFont& );
  63
  64   bool                isSync() const;
  65   void                setIsSync( const bool );
  66
  67   bool                isSuppressOutput() const;
  68   void                setIsSuppressOutput( const bool );
  69
  70   bool                isShowBanner() const;
  71   void                setIsShowBanner( const bool );
  72
  73   void                exec( const QString& );
  74   void                execAndWait( const QString& );
  75
  76   virtual bool        eventFilter( QObject*, QEvent* );
  77
  78   //! \brief Get popup client symbolic name
  79   virtual QString     popupClientType() const { return QString( "PyConsole" ); }
  80   virtual void        contextMenuPopup( QMenu* );
  81
  82   void                setMenuActions( const int );
  83   int                 menuActions() const;
  84
  85 protected:
  86   void                createActions();
  87   void                updateActions();
  88
  89   PyConsole_Console( QWidget* parent, PyConsole_Interp*,  PyConsole_Editor*);
  90
  91
  92   PyConsole_Interp*   myInterp;    //!< python interpreter
  93   PyConsole_Editor*   myEditor;    //!< python console editor widget
  94   QMap<int, QAction*> myActions;   //!< menu actions list
  95 };
  96
  97 /**
  98  * Enhance console object providing auto-completion.
  99  * Similar to PyConsole_Console except that an enhanced interpreter and enhanced editor
 100  * are encapsulated.
 101  */
 102 class PYCONSOLE_EXPORT PyConsole_EnhConsole: public PyConsole_Console
 103 {
 104   Q_OBJECT
 105
 106 public:
 107   PyConsole_EnhConsole( QWidget* parent, PyConsole_EnhInterp* interp = 0);
 108   virtual ~PyConsole_EnhConsole() {}
 109 };
 110
 111 #endif // PYCONSOLE_CONSOLE_H