LogWindow.h

Go to the documentation of this file.

// Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
//  KERNEL SALOME_Event : Define event posting mechanism
// File   : LogWindow.h
// Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
//
#ifndef LOGWINDOW_H
#define LOGWINDOW_H
 
#if defined WIN32
#  if defined LOGWINDOW_EXPORTS || defined LogWindow_EXPORTS
#    define LOGWINDOW_EXPORT __declspec( dllexport )
#  else
#    define LOGWINDOW_EXPORT __declspec( dllimport )
#  endif
#else
#  define LOGWINDOW_EXPORT
#endif
 
#include "QtxMsgHandler.h"
#include "SUIT_PopupClient.h"
 
#include <QWidget>
#include <QMap>
#include <QStringList>
 
#ifdef WIN32
#pragma warning( disable:4251 )
#endif
 
class QAction;
class QTextEdit;
 
class LOGWINDOW_EXPORT LogWindow : public QWidget, public SUIT_PopupClient, public QtxMsgHandlerCallback
{
  Q_OBJECT
 
public:
  enum
  {
    CopyId       = 0x01,                                
    ClearId      = 0x02,                                
    SelectAllId  = 0x04,                                
    SaveToFileId = 0x08,                                
    All = CopyId | ClearId | SelectAllId | SaveToFileId 
  };
 
  enum
  {
    DisplayNormal    = 0x00,                     
    DisplayDate      = 0x01,                     
    DisplayTime      = 0x02,                     
    DisplaySeparator = 0x04,                     
    DisplayNoColor   = 0x08,                     
    DisplayDateTime  = DisplayDate | DisplayTime 
  };
 
public:
  LogWindow( QWidget* );
  virtual ~LogWindow();
 
  virtual             QString popupClientType() const { return QString( "LogWindow" ); }
  virtual void        contextMenuPopup( QMenu* );
 
  virtual bool        eventFilter( QObject*, QEvent* );
 
  QString             banner() const;
  QString             separator() const;
 
  void                setBanner( const QString& );
  void                setSeparator( const QString& );
 
  void                putMessage( const QString&, const int = DisplayNormal );
  virtual void        putMessage( const QString&, const QColor&, const int = DisplayNormal );
  void                clear( const bool = false );
 
  bool                saveLog( const QString& );
 
  void                setMenuActions( const int );
  int                 menuActions() const;
 
  void                handleQtMessages(bool);
 
protected slots:
  void                onSaveToFile();
  void                onSelectAll();
  void                onClear();
  void                onCopy();
 
private:
  void                append( const QString text );
  void                createActions();
  void                updateActions();
  void                qtMessage( QtMsgType, const QMessageLogContext&, const QString& );
 
private:
  QTextEdit*          myView;           
  QString             myBanner;         
  QStringList         myHistory;        
  QString             mySeparator;      
  int                 myBannerSize;     
  QMap<int, QAction*> myActions;        
};
 
#ifdef WIN32
#pragma warning( default:4251 )
#endif
 
#endif // LOGWINDOW_H