vtkKWColorSwatchesWidget Class Reference

a color swatches widget. More...

#include <vtkKWColorSwatchesWidget.h>

Inheritance diagram for vtkKWColorSwatchesWidget:

[legend]

Collaboration diagram for vtkKWColorSwatchesWidget:

[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	AddCollection (const char *name)
virtual int	GetCollectionId (const char *name)
virtual vtkKWColorPresetSelector *	GetSwatchesColorPresetSelector ()
virtual void	AddDefaultCollections ()
virtual void	SetSwatchSelectedCommand (vtkObject *object, const char *method)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWColorSwatchesWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkKWColorSwatchesWidget *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWColorSwatchesWidget ()
	~vtkKWColorSwatchesWidget ()
virtual void	CreateWidget ()
virtual void	Pack ()
Protected Attributes
int	SwatchSize
int	SwatchesRepresentation
vtkKWColorSwatchesWidgetInternals *	Internals
enum	{ RepresentationFrames = 0, RepresentationList = 1 }
char *	SwatchSelectedCommand
virtual int	RemoveCollection (int collection_id)
virtual void	RemoveAllCollections ()
virtual int	AddRGBSwatch (int collection_id, const char *name, double rgb[3])
virtual int	AddRGBSwatch (int collection_id, const char *name, double r, double g, double b)
virtual void	SetSwatchesRepresentation (int)
virtual int	GetSwatchesRepresentation ()
virtual void	SetSwatchesRepresentationToFrames ()
virtual void	SetSwatchesRepresentationToList ()
virtual int	GetSwatchSize ()
virtual void	SetSwatchSize (int)
virtual void	SetMaximumNumberOfSwatchesPerRow (int)
virtual int	GetMaximumNumberOfSwatchesPerRow ()
virtual void	SetSwatchesPadding (int)
virtual int	GetSwatchesPadding ()
virtual void	SwatchSelectedCallback (double r, double g, double b)
virtual void	CollectionSelectedCallback (const char *)
virtual void	PopulateCollectionsCallback ()
virtual void	PopulateSwatchesCallback ()
virtual void	SwatchesColorPresetApplyCallback (int id)
virtual void	InvokeSwatchSelectedCommand (double r, double g, double b)
virtual void	PopulateCollections ()
virtual void	PopulateSwatches ()
virtual void	PopulateSwatchesAsFrames ()
virtual void	PopulateSwatchesAsList ()
virtual void	SchedulePopulateCollections ()
virtual void	SchedulePopulateSwatches ()

---

Detailed Description

a color swatches widget.

This class displays a list of color swatches. Different color swatches collections can be created independently.

See also:

vtkKWColorPickerWidget

Definition at line 32 of file vtkKWColorSwatchesWidget.h.

---

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWColorSwatchesWidget::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 37 of file vtkKWColorSwatchesWidget.h.

---

Member Enumeration Documentation

anonymous enum

Set/Get the swatches representation. BTX

Enumerator:

RepresentationFrames
RepresentationList

Definition at line 67 of file vtkKWColorSwatchesWidget.h.

---

Constructor & Destructor Documentation

vtkKWColorSwatchesWidget::vtkKWColorSwatchesWidget

(

)

[protected]

vtkKWColorSwatchesWidget::~vtkKWColorSwatchesWidget

(

)

[protected]

---

Member Function Documentation

static vtkKWColorSwatchesWidget* vtkKWColorSwatchesWidget::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWColorSwatchesWidget::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWColorSwatchesWidget::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWColorSwatchesWidget::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWColorSwatchesWidget* vtkKWColorSwatchesWidget::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWColorSwatchesWidget::AddCollection

(

const char *

name

)

[virtual]

Add a swatches collection (the name can not be empty) Return unique ID (>= 0) of the collection, or -1 on error.

virtual int vtkKWColorSwatchesWidget::RemoveCollection

(

int

collection_id

)

[virtual]

Remove a swatches collection given its ID, or all collections Return 1 on success, 0 otherwise

virtual void vtkKWColorSwatchesWidget::RemoveAllCollections

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual int vtkKWColorSwatchesWidget::GetCollectionId

(

const char *

name

)

[virtual]

Get the unique ID of a swatches collection given its name Return -1 on error.

virtual int vtkKWColorSwatchesWidget::AddRGBSwatch	(	int	collection_id,
		const char *	name,
		double	rgb[3]
	)			[virtual]

Add a swatch to a collection, given the unique ID of the collection, the name of the swatch (can be empty) and its RGB value. Return 1 on success, 0 on error.

virtual int vtkKWColorSwatchesWidget::AddRGBSwatch	(	int	collection_id,
		const char *	name,
		double	r,
		double	g,
		double	b
	)			[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SetSwatchesRepresentation

(

int

)

[virtual]

Set/Get the swatches representation. BTX

virtual int vtkKWColorSwatchesWidget::GetSwatchesRepresentation

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SetSwatchesRepresentationToFrames

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SetSwatchesRepresentationToList

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual int vtkKWColorSwatchesWidget::GetSwatchSize

(

)

[virtual]

Set/Get the swatch size in pixels. Only relevant if SwatchesRepresentation is RepresentationFrames.

virtual void vtkKWColorSwatchesWidget::SetSwatchSize

(

int

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SetMaximumNumberOfSwatchesPerRow

(

int

)

[virtual]

Set/Get the maximum number of swatches packed horizontally (per row). Only relevant if SwatchesRepresentation is RepresentationFrames.

virtual int vtkKWColorSwatchesWidget::GetMaximumNumberOfSwatchesPerRow

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SetSwatchesPadding

(

int

)

[virtual]

Set/Get the padding between each swatch. Only relevant if SwatchesRepresentation is RepresentationFrames.

virtual int vtkKWColorSwatchesWidget::GetSwatchesPadding

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual vtkKWColorPresetSelector* vtkKWColorSwatchesWidget::GetSwatchesColorPresetSelector

(

)

[virtual]

Get the internal color swatches preset list

virtual void vtkKWColorSwatchesWidget::AddDefaultCollections

(

)

[virtual]

Create the default collections

virtual void vtkKWColorSwatchesWidget::SetSwatchSelectedCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Specifies a command to associate with the widget. This command is invoked when a swatch is selected. 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. The following parameters are also passed to the command: - swatch rgb value: double r, double g, double b

virtual void vtkKWColorSwatchesWidget::SwatchSelectedCallback	(	double	r,
		double	g,
		double	b
	)			[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWColorSwatchesWidget::CollectionSelectedCallback

(

const char *

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::PopulateCollectionsCallback

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::PopulateSwatchesCallback

(

)

[virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SwatchesColorPresetApplyCallback

(

int

id

)

[virtual]

Set/Get the swatches representation. BTX

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

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWColorSwatchesWidget::InvokeSwatchSelectedCommand	(	double	r,
		double	g,
		double	b
	)			[protected, virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::PopulateCollections

(

)

[protected, virtual]

Populate the swatches frame and collectio combo

virtual void vtkKWColorSwatchesWidget::PopulateSwatches

(

)

[protected, virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::PopulateSwatchesAsFrames

(

)

[protected, virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::PopulateSwatchesAsList

(

)

[protected, virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SchedulePopulateCollections

(

)

[protected, virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::SchedulePopulateSwatches

(

)

[protected, virtual]

Set/Get the swatches representation. BTX

virtual void vtkKWColorSwatchesWidget::Pack

(

)

[protected, virtual]

Pack

---

Member Data Documentation

char* vtkKWColorSwatchesWidget::SwatchSelectedCommand [protected]

Callbacks. Internal, do not use.

Definition at line 143 of file vtkKWColorSwatchesWidget.h.

int vtkKWColorSwatchesWidget::SwatchSize [protected]

Definition at line 160 of file vtkKWColorSwatchesWidget.h.

int vtkKWColorSwatchesWidget::SwatchesRepresentation [protected]

Definition at line 161 of file vtkKWColorSwatchesWidget.h.

vtkKWColorSwatchesWidgetInternals* vtkKWColorSwatchesWidget::Internals [protected]

PIMPL Encapsulation for STL containers

Reimplemented from vtkKWCoreWidget.

Definition at line 162 of file vtkKWColorSwatchesWidget.h.

---

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

• vtkKWColorSwatchesWidget.h