vtkKWLogWidget.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWLogWidget.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWLogWidget_h
#define __vtkKWLogWidget_h

#include "vtkKWCompositeWidget.h"

class vtkKWMultiColumnListWithScrollbars;
class vtkKWLogWidgetInternals;
class vtkKWToolbar;
class vtkKWLoadSaveButton;
class vtkKWPushButton;
class vtkKWTextWithScrollbars;
class vtkKWFrameWithLabel;

class KWWidgets_EXPORT vtkKWLogWidget : public vtkKWCompositeWidget
{
// @cond section_public
public:
  static vtkKWLogWidget* New();
  vtkTypeRevisionMacro(vtkKWLogWidget,vtkKWCompositeWidget);
  void PrintSelf(ostream& os, vtkIndent indent);
  

  virtual int AddErrorRecord(const char *description);
  virtual int AddWarningRecord(const char *description);
  virtual int AddInformationRecord(const char *description);
  virtual int AddDebugRecord(const char *description);
  
  virtual int GetNumberOfRecords();

  virtual void RemoveAllRecords();


  virtual void SetMaximumNumberOfRecords(int);
  vtkGetMacro(MaximumNumberOfRecords, int);
  

  virtual int WriteRecordsToStream(ostream& os);
  virtual int WriteRecordsToFile(const char *filename);
  
  virtual int EmailRecords(const char *recipient);

  virtual char *GetFormatTimeStringCallback(const char *celltext);
  
  virtual void WriteRecordsToFileCallback();
  

  virtual void RemoveSelectedRecordsCallback();
  virtual void RemoveAllRecordsCallback();
  virtual void EmailRecordsCallback();

  virtual void SelectionChangedCallback();
  

  virtual void UpdateEnableState();
  virtual void Update();


  enum
  {
    RecordsClearedEvent = 15000
  };
  //ETX

// @endcond
// @cond section_protected
protected:
  vtkKWLogWidget();
  ~vtkKWLogWidget();

  virtual void CreateWidget();
  

  enum
  {
    ErrorType = 0,
    WarningType,
    InformationType,
    DebugType
  };
  //ETX
  
  virtual void CreateRecordList();
  
  virtual unsigned int GetCurrentTimeInSeconds();
  
  virtual void RemoveInternalRecord(int record_id);
  
  virtual const char* GetRecordDescription(int record_id);
  
  virtual int AddRecord(const char *description, int type);
  
  virtual void PruneRecords();
  
  virtual void RemoveRowWithRecordId(int record_id);

  virtual int GetIndexOfRowWithRecordId(int record_id);
  

  vtkKWLogWidgetInternals *Internals;
  vtkKWMultiColumnListWithScrollbars *RecordList;
  vtkKWToolbar *Toolbar;
  vtkKWLoadSaveButton *SaveButton;
  vtkKWPushButton *RemoveSelectedButton;
  vtkKWPushButton *RemoveAllButton;
  vtkKWPushButton *EmailButton;
  vtkKWFrameWithLabel *DescriptionFrame;
  vtkKWTextWithScrollbars *DescriptionText;

  int MaximumNumberOfRecords;
  
// @endcond
// @cond section_private
private:

  static vtkIdType IdCounter;

  vtkKWLogWidget(const vtkKWLogWidget&); // Not implemented
  void operator=(const vtkKWLogWidget&); // Not implemented
};
#endif
// @endcond

---