vtkKWLogWidget Class Reference

a log widget. More...

#include <vtkKWLogWidget.h>

Inheritance diagram for vtkKWLogWidget:

[legend]

Collaboration diagram for vtkKWLogWidget:

[legend]

List of all members.

Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetNumberOfRecords ()
virtual void	RemoveAllRecords ()
virtual int	EmailRecords (const char *recipient)
virtual char *	GetFormatTimeStringCallback (const char *celltext)
virtual void	WriteRecordsToFileCallback ()
virtual void	SelectionChangedCallback ()
Static Public Member Functions
static vtkKWLogWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkKWLogWidget *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWLogWidget ()
	~vtkKWLogWidget ()
virtual void	CreateWidget ()
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)
Protected Attributes
int	MaximumNumberOfRecords
enum	{ RecordsClearedEvent = 15000 }
enum	{ ErrorType = 0, WarningType, InformationType, DebugType }
vtkKWLogWidgetInternals *	Internals
vtkKWMultiColumnListWithScrollbars *	RecordList
vtkKWToolbar *	Toolbar
vtkKWLoadSaveButton *	SaveButton
vtkKWPushButton *	RemoveSelectedButton
vtkKWPushButton *	RemoveAllButton
vtkKWPushButton *	EmailButton
vtkKWFrameWithLabel *	DescriptionFrame
vtkKWTextWithScrollbars *	DescriptionText
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 void	SetMaximumNumberOfRecords (int)
virtual int	GetMaximumNumberOfRecords ()
virtual int	WriteRecordsToStream (ostream &os)
virtual int	WriteRecordsToFile (const char *filename)
virtual void	RemoveSelectedRecordsCallback ()
virtual void	RemoveAllRecordsCallback ()
virtual void	EmailRecordsCallback ()
virtual void	UpdateEnableState ()
virtual void	Update ()

---

Detailed Description

a log widget.

This widget can be used to display various types of records/events in the form of a multicolumn log. Each record is timestamped automatically, and / the interface allow the user to sort the list by time, type, or description. This widget can be inserted in any widget hierarchy, or used a standalone dialog through the vtkKWLogDialog class.

Thanks:

This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.

See also:

vtkKWLogDialog

Events:

vtkKWEvent::WarningMessageEvent vtkKWLogWidget::RecordsClearedEvent vtkKWEvent::DebugMessageEvent vtkKWEvent::ErrorMessageEvent vtkKWEvent::InformationMessageEvent

Definition at line 49 of file vtkKWLogWidget.h.

---

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWLogWidget::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 54 of file vtkKWLogWidget.h.

---

Member Enumeration Documentation

anonymous enum

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Enumerator:

RecordsClearedEvent

Definition at line 120 of file vtkKWLogWidget.h.

anonymous enum [protected]

Define the record types with enumeration BTX

Enumerator:

ErrorType
WarningType
InformationType
DebugType

Definition at line 138 of file vtkKWLogWidget.h.

---

Constructor & Destructor Documentation

vtkKWLogWidget::vtkKWLogWidget

(

)

[protected]

vtkKWLogWidget::~vtkKWLogWidget

(

)

[protected]

---

Member Function Documentation

static vtkKWLogWidget* vtkKWLogWidget::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWLogWidget::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWLogWidget::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWLogWidget::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWLogWidget* vtkKWLogWidget::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

void vtkKWLogWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWLogWidget::AddErrorRecord

(

const char *

description

)

[virtual]

Add a record. Return a unique record ID, which can be used to retrieve later on.

virtual int vtkKWLogWidget::AddWarningRecord

(

const char *

description

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual int vtkKWLogWidget::AddInformationRecord

(

const char *

description

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual int vtkKWLogWidget::AddDebugRecord

(

const char *

description

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual int vtkKWLogWidget::GetNumberOfRecords

(

)

[virtual]

Get number of records.

virtual void vtkKWLogWidget::RemoveAllRecords

(

)

[virtual]

Remove all records.

virtual void vtkKWLogWidget::SetMaximumNumberOfRecords

(

int

)

[virtual]

Set/Get the max number of records that will be stored.

virtual int vtkKWLogWidget::GetMaximumNumberOfRecords

(

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual int vtkKWLogWidget::WriteRecordsToStream

(

ostream &

os

)

[virtual]

Write all record to a stream or text file. Return 1 on success, 0 otherwise

virtual int vtkKWLogWidget::WriteRecordsToFile

(

const char *

filename

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual int vtkKWLogWidget::EmailRecords

(

const char *

recipient

)

[virtual]

Email records.

virtual char* vtkKWLogWidget::GetFormatTimeStringCallback

(

const char *

celltext

)

[virtual]

Callback, do NOT use. When the time column is displayed, convert the cell text (time value in seconds) to ctime format. Returns the formatted string that will be displayed.

virtual void vtkKWLogWidget::WriteRecordsToFileCallback

(

)

[virtual]

Callback, do NOT use. Write all records to a text file

virtual void vtkKWLogWidget::RemoveSelectedRecordsCallback

(

)

[virtual]

Callback, do NOT use. Remove selected or all records from the table.

virtual void vtkKWLogWidget::RemoveAllRecordsCallback

(

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual void vtkKWLogWidget::EmailRecordsCallback

(

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual void vtkKWLogWidget::SelectionChangedCallback

(

)

[virtual]

Callback, do NOT use. Invoked when selection is changed in the table.

virtual void vtkKWLogWidget::UpdateEnableState

(

)

[virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWWidget.

virtual void vtkKWLogWidget::Update

(

)

[virtual]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

virtual void vtkKWLogWidget::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWLogWidget::CreateRecordList

(

)

[protected, virtual]

Create the log list.

virtual unsigned int vtkKWLogWidget::GetCurrentTimeInSeconds

(

)

[protected, virtual]

Get current time in seconds.

virtual void vtkKWLogWidget::RemoveInternalRecord

(

int

record_id

)

[protected, virtual]

Remove the record from internal stored list.

virtual const char* vtkKWLogWidget::GetRecordDescription

(

int

record_id

)

[protected, virtual]

Get the record description.

virtual int vtkKWLogWidget::AddRecord	(	const char *	description,
		int	type
	)			[protected, virtual]

Add a record to the table and the stored list using the description and type. Return a unique record ID.

virtual void vtkKWLogWidget::PruneRecords

(

)

[protected, virtual]

Check if the stored internal records number is greater than MaximumNumberOfRecords. If yes, remove the oldest records and corresponsing rows.

virtual void vtkKWLogWidget::RemoveRowWithRecordId

(

int

record_id

)

[protected, virtual]

Remove the corresponding row from the record table given the record ID.

virtual int vtkKWLogWidget::GetIndexOfRowWithRecordId

(

int

record_id

)

[protected, virtual]

Return the index of the row for the given record ID

---

Member Data Documentation

vtkKWLogWidgetInternals* vtkKWLogWidget::Internals [protected]

Member variables

Reimplemented from vtkKWCoreWidget.

Definition at line 178 of file vtkKWLogWidget.h.

vtkKWMultiColumnListWithScrollbars* vtkKWLogWidget::RecordList [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 179 of file vtkKWLogWidget.h.

vtkKWToolbar* vtkKWLogWidget::Toolbar [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 180 of file vtkKWLogWidget.h.

vtkKWLoadSaveButton* vtkKWLogWidget::SaveButton [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 181 of file vtkKWLogWidget.h.

vtkKWPushButton* vtkKWLogWidget::RemoveSelectedButton [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 182 of file vtkKWLogWidget.h.

vtkKWPushButton* vtkKWLogWidget::RemoveAllButton [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 183 of file vtkKWLogWidget.h.

vtkKWPushButton* vtkKWLogWidget::EmailButton [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 184 of file vtkKWLogWidget.h.

vtkKWFrameWithLabel* vtkKWLogWidget::DescriptionFrame [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 185 of file vtkKWLogWidget.h.

vtkKWTextWithScrollbars* vtkKWLogWidget::DescriptionText [protected]

Events. RecordsClearedEvent is called when all records have been cleared using the "delete selected" or "delete all" button.. BTX

Definition at line 186 of file vtkKWLogWidget.h.

int vtkKWLogWidget::MaximumNumberOfRecords [protected]

Definition at line 189 of file vtkKWLogWidget.h.

---

The documentation for this class was generated from the following file:

• vtkKWLogWidget.h