vtkKWCanvas Class Reference

canvas widget More...

#include <vtkKWCanvas.h>

Inheritance diagram for vtkKWCanvas:

[legend]

Collaboration diagram for vtkKWCanvas:

[legend]

List of all members.

Public Types
typedef vtkKWCoreWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	HasTag (const char *tag)
virtual void	DeleteTag (const char *tag)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWCanvas *	New ()
static int	IsTypeOf (const char *type)
static vtkKWCanvas *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWCanvas ()
	~vtkKWCanvas ()
virtual void	CreateWidget ()
virtual void	SetWidth (int)
virtual int	GetWidth ()
virtual void	SetHeight (int)
virtual int	GetHeight ()
virtual int	AddHorizontalGradient (vtkColorTransferFunction *ctf, int x1, int y1, int x2, int y2, const char *tag)
virtual int	AddHorizontalRGBGradient (double r1, double g1, double b1, double r2, double g2, double b2, int x1, int y1, int x2, int y2, const char *tag)
virtual int	AddVerticalGradient (vtkColorTransferFunction *ctf, int x1, int y1, int x2, int y2, const char *tag)
virtual int	AddVerticalRGBGradient (double r1, double g1, double b1, double r2, double g2, double b2, int x1, int y1, int x2, int y2, const char *tag)
virtual void	GetBackgroundColor (double *r, double *g, double *b)
virtual double *	GetBackgroundColor ()
virtual void	SetBackgroundColor (double r, double g, double b)
virtual void	SetBackgroundColor (double rgb[3])
virtual void	SetHighlightThickness (int)
virtual int	GetHighlightThickness ()
virtual void	SetBorderWidth (int)
virtual int	GetBorderWidth ()
virtual void	SetRelief (int)
virtual int	GetRelief ()
virtual void	SetReliefToRaised ()
virtual void	SetReliefToSunken ()
virtual void	SetReliefToFlat ()
virtual void	SetReliefToRidge ()
virtual void	SetReliefToSolid ()
virtual void	SetReliefToGroove ()
virtual void	SetCanvasBinding (const char *tag, const char *event, vtkObject *object, const char *method)
virtual void	SetCanvasBinding (const char *tag, const char *event, const char *command)
virtual const char *	GetCanvasBinding (const char *tag, const char *event)
virtual void	AddCanvasBinding (const char *tag, const char *event, vtkObject *object, const char *method)
virtual void	AddCanvasBinding (const char *tag, const char *event, const char *command)
virtual void	RemoveCanvasBinding (const char *tag, const char *event)
virtual void	RemoveCanvasBinding (const char *tag, const char *event, vtkObject *object, const char *method)
virtual int	AddGradient (vtkColorTransferFunction *ctf, int x1, int y1, int x2, int y2, const char *tag, int horizontal)

---

Detailed Description

canvas widget

A simple widget that represents a canvas.

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.

Definition at line 55 of file vtkKWCanvas.h.

---

Member Typedef Documentation

typedef vtkKWCoreWidget vtkKWCanvas::Superclass

Reimplemented from vtkKWCoreWidget.

Definition at line 60 of file vtkKWCanvas.h.

---

Constructor & Destructor Documentation

vtkKWCanvas::vtkKWCanvas

(

)

[inline, protected]

Definition at line 172 of file vtkKWCanvas.h.

vtkKWCanvas::~vtkKWCanvas

(

)

[inline, protected]

Definition at line 173 of file vtkKWCanvas.h.

---

Member Function Documentation

static vtkKWCanvas* vtkKWCanvas::New

(

)

[static]

Reimplemented from vtkKWCoreWidget.

virtual const char* vtkKWCanvas::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCoreWidget.

static int vtkKWCanvas::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCoreWidget.

virtual int vtkKWCanvas::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCoreWidget.

static vtkKWCanvas* vtkKWCanvas::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCoreWidget.

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

Reimplemented from vtkKWCoreWidget.

virtual void vtkKWCanvas::SetWidth

(

int

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual int vtkKWCanvas::GetWidth

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetHeight

(

int

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual int vtkKWCanvas::GetHeight

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual int vtkKWCanvas::AddHorizontalGradient	(	vtkColorTransferFunction *	ctf,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		const char *	tag
	)			[virtual]

Add horizontal or vertical gradient (constrained to a rectange). The arguments x1, y1, x2, and y2 give the coordinates of two diagonally opposite corners of the rectangle.

virtual int vtkKWCanvas::AddHorizontalRGBGradient	(	double	r1,
		double	g1,
		double	b1,
		double	r2,
		double	g2,
		double	b2,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		const char *	tag
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual int vtkKWCanvas::AddVerticalGradient	(	vtkColorTransferFunction *	ctf,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		const char *	tag
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual int vtkKWCanvas::AddVerticalRGBGradient	(	double	r1,
		double	g1,
		double	b1,
		double	r2,
		double	g2,
		double	b2,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		const char *	tag
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual int vtkKWCanvas::HasTag

(

const char *

tag

)

[virtual]

Query if the canvas has a tag

virtual void vtkKWCanvas::DeleteTag

(

const char *

tag

)

[virtual]

Delete a tag in the canvas

virtual void vtkKWCanvas::GetBackgroundColor	(	double *	r,
		double *	g,
		double *	b
	)			[virtual]

Set/Get the background color of the widget.

virtual double* vtkKWCanvas::GetBackgroundColor

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetBackgroundColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetBackgroundColor

(

double

rgb[3]

)

[inline, virtual]

Set the width and height of the canvas. No effect before Create() is called.

Definition at line 103 of file vtkKWCanvas.h.

virtual void vtkKWCanvas::SetHighlightThickness

(

int

)

[virtual]

Set/Get the highlight thickness, a non-negative value indicating the width of the highlight rectangle to draw around the outside of the widget when it has the input focus.

virtual int vtkKWCanvas::GetHighlightThickness

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetBorderWidth

(

int

)

[virtual]

Set/Get the border width, a non-negative value indicating the width of the 3-D border to draw around the outside of the widget (if such a border is being drawn; the Relief option typically determines this).

virtual int vtkKWCanvas::GetBorderWidth

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetRelief

(

int

)

[virtual]

Set/Get the 3-D effect desired for the widget. The value indicates how the interior of the widget should appear relative to its exterior. Valid constants can be found in vtkKWOptions::ReliefType.

virtual int vtkKWCanvas::GetRelief

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetReliefToRaised

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetReliefToSunken

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetReliefToFlat

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetReliefToRidge

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetReliefToSolid

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetReliefToGroove

(

)

[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::SetCanvasBinding	(	const char *	tag,
		const char *	event,
		vtkObject *	object,
		const char *	method
	)			[virtual]

Set/add/remove a binding to all items matching a tag in the canvas widget; that command is invoked whenever the 'event' is triggered on the tag. SetBinding will replace any old bindings, whereas AddBinding will add the binding to the list of bindings already defined for that event. RemoveBinding can remove a specific binding or all bindings for an event. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWCanvas::SetCanvasBinding	(	const char *	tag,
		const char *	event,
		const char *	command
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual const char* vtkKWCanvas::GetCanvasBinding	(	const char *	tag,
		const char *	event
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::AddCanvasBinding	(	const char *	tag,
		const char *	event,
		vtkObject *	object,
		const char *	method
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::AddCanvasBinding	(	const char *	tag,
		const char *	event,
		const char *	command
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::RemoveCanvasBinding	(	const char *	tag,
		const char *	event
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::RemoveCanvasBinding	(	const char *	tag,
		const char *	event,
		vtkObject *	object,
		const char *	method
	)			[virtual]

Set the width and height of the canvas. No effect before Create() is called.

virtual void vtkKWCanvas::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 vtkKWCanvas::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCoreWidget.

virtual int vtkKWCanvas::AddGradient	(	vtkColorTransferFunction *	ctf,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		const char *	tag,
		int	horizontal
	)			[protected, virtual]

Add gradient.

---

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

• vtkKWCanvas.h