tools/PyConsole/src/PyConsole_Event.h

   1 // Copyright (C) 2007-2024  CEA, EDF, 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 // File   : PyConsole_Event.h
  23 // Author : Vadim SANDLER (Open CASCADE S.A.S), Adrien Bruneton (CEA/DEN)
  24
  25 #ifndef PYCONSOLE_EVENT_H
  26 #define PYCONSOLE_EVENT_H
  27
  28 #include "PyConsole.h"
  29 #include "PyInterp_Event.h"
  30
  31 #include <QEvent>
  32 #include <QString>
  33 #include <QStringList>
  34
  35 class PyConsole_PrintEvent : public QEvent
  36 {
  37 public:
  38   static const int EVENT_ID = 65432;
  39
  40   PyConsole_PrintEvent( const QString&, bool = false );
  41
  42   QString text() const;
  43   bool isError() const;
  44
  45 private:
  46   QString myText;  //!< Event message (python trace)
  47   bool    myError; //!< Set to \c true if an error msg is to be displayed
  48 };
  49
  50 class PyConsole_CompletionEvent : public PyInterp_Event
  51 {
  52 public:
  53   static const int EVENT_ID = 65433;
  54
  55   PyConsole_CompletionEvent( PyInterp_Request*, bool, const QStringList&, const QString& );
  56
  57   bool status() const;
  58   QStringList matches() const;
  59   QString doc() const;
  60
  61 protected:
  62   bool        myStatus;  //!< Status of execution
  63   QStringList myMatches; //!< Command matches (completions)
  64   QString     myDoc;     //!< Docstring of the match (in case if there is sinlge match)
  65 };
  66
  67 #endif // PYCONSOLE_EVENT_H