src/PyConsole/PyConsole_ConsoleBase.h

   1 // Copyright (C) 2007-2015  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_CONSOLEBASE_H
  27 #define PYCONSOLE_CONSOLEBASE_H
  28
  29 #include "PyConsole.h"
  30
  31 #include <QWidget>
  32 #include <QMenu>
  33 #include <QMap>
  34
  35 class PyConsole_Interp;
  36 class PyConsole_EditorBase;
  37
  38 class PYCONSOLE_EXPORT PyConsole_ConsoleBase : public QWidget
  39 {
  40   Q_OBJECT
  41
  42 public:
  43
  44   struct PyConsole_Interp_CreatorBase
  45   {
  46     virtual PyConsole_EditorBase *createEditor( PyConsole_Interp *interp, PyConsole_ConsoleBase *console ) const;
  47     virtual PyConsole_Interp *createInterp( ) const;
  48   };
  49
  50 public:
  51   //! Context popup menu actions flags
  52   enum
  53   {
  54     CopyId         = 0x01,  //!< "Copy" menu action
  55     PasteId        = 0x02,  //!< "Paste" menu action
  56     ClearId        = 0x04,  //!< "Clear" menu action
  57     SelectAllId    = 0x08,  //!< "Select All" menu action
  58     DumpCommandsId = 0x10,  //!< "DumpCommands" menu action
  59     StartLogId     = 0x20,  //!< "Start log" menu action
  60     StopLogId      = 0x40,  //!< "Stop log" menu action
  61     All            = 0xFF,  //!< all menu actions
  62   };
  63
  64 public:
  65   PyConsole_ConsoleBase( QWidget* parent, PyConsole_Interp* interp = 0 );
  66   virtual ~PyConsole_ConsoleBase();
  67
  68   //! \brief Get python interperter
  69   PyConsole_Interp*   getInterp() const;
  70   QFont               font() const;
  71   virtual void        setFont( const QFont& );
  72
  73   bool                isSync() const;
  74   void                setIsSync( const bool );
  75
  76   bool                isSuppressOutput() const;
  77   void                setIsSuppressOutput( const bool );
  78
  79   bool                isShowBanner() const;
  80   void                setIsShowBanner( const bool );
  81
  82   void                exec( const QString& );
  83   void                execAndWait( const QString& );
  84
  85   void                setMenuActions( const int );
  86   int                 menuActions() const;
  87
  88   void                startLog( const QString& );
  89   void                stopLog();
  90
  91   virtual void        contextMenuPopup( QMenu* );
  92
  93 protected:
  94   void                createActions();
  95   void                updateActions();
  96   //!  MUST BE NON VIRTUAL ! (called from constructor !!!!)
  97   void defaultConstructor( PyConsole_Interp* interp, const PyConsole_Interp_CreatorBase& crea );
  98   PyConsole_ConsoleBase( QWidget* parent, PyConsole_Interp*,  PyConsole_EditorBase*);
  99
 100   PyConsole_EditorBase*   myEditor;    //!< python console editor widget
 101   QMap<int, QAction*> myActions;   //!< menu actions list
 102 };
 103
 104 /**
 105  * Enhance console object providing auto-completion.
 106  * Similar to PyConsole_Console except that an enhanced interpreter and enhanced editor
 107  * are encapsulated.
 108  */
 109 class PYCONSOLE_EXPORT PyConsole_EnhConsoleBase : public PyConsole_ConsoleBase
 110 {
 111   Q_OBJECT
 112 public:
 113
 114   struct PyConsole_Interp_EnhCreatorBase : public PyConsole_Interp_CreatorBase
 115   {
 116     virtual PyConsole_EditorBase *createEditor( PyConsole_Interp *interp, PyConsole_ConsoleBase *console ) const;
 117     virtual PyConsole_Interp *createInterp( ) const;
 118   };
 119
 120 public:
 121   PyConsole_EnhConsoleBase( QWidget* parent, PyConsole_Interp* interp = 0 );
 122   virtual ~PyConsole_EnhConsoleBase() {}
 123   virtual bool eventFilter( QObject * o, QEvent * e );
 124   virtual void contextMenuRequest( QContextMenuEvent * e ) ;
 125 };
 126
 127 #endif // PYCONSOLE_CONSOLEBASE_H