vtkKWChangeColorButton Class Reference

a button for selecting colors More...

#include <vtkKWChangeColorButton.h>

Inheritance diagram for vtkKWChangeColorButton:

[legend]

Collaboration diagram for vtkKWChangeColorButton:

[legend]

List of all members.

Public Types
typedef vtkKWWidgetWithLabel	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetCommand (vtkObject object, const char method)
virtual void	SetBalloonHelpString (const char *str)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWChangeColorButton *	New ()
static int	IsTypeOf (const char *type)
static vtkKWChangeColorButton *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWChangeColorButton ()
	~vtkKWChangeColorButton ()
virtual void	CreateWidget ()
virtual void	InvokeCommand (double r, double g, double b)
virtual void	UpdateColorButton ()
virtual void	QueryUserForColor ()
virtual void	Pack ()
virtual void	CreateLabel ()
virtual void	CreateButtonFrame ()
Protected Attributes
vtkKWLabel *	ColorButton
vtkKWFrame *	ButtonFrame
char *	Command
char *	DialogTitle
double	Color [3]
int	LabelOutsideButton

enum	{ ColorChangedEvent = 1000 }
virtual void	SetColor (double c[3])
virtual void	SetColor (double r, double g, double b)
virtual double *	GetColor ()
virtual void	SetDialogTitle (const char *)
virtual char *	GetDialogTitle ()
virtual void	SetLabelOutsideButton (int)
virtual int	GetLabelOutsideButton ()
virtual void	LabelOutsideButtonOn ()
virtual void	LabelOutsideButtonOff ()
virtual void	ButtonPressCallback ()
virtual void	ButtonReleaseCallback ()
virtual void	Bind ()
virtual void	UnBind ()

Detailed Description

a button for selecting colors

A button that can be pressed to select a color. Note: As a subclass of vtkKWWidgetWithLabel, it inherits a label and methods to set its position and visibility. Note that the default label position implemented in this class is on the left of the color label. Only a subset of the specific positions listed in vtkKWWidgetWithLabel is supported: on Left, and on Right of the color label.

See also:: vtkKWWidgetWithLabel

Events:: vtkKWChangeColorButton::ColorChangedEvent

Definition at line 37 of file vtkKWChangeColorButton.h.

Member Typedef Documentation

typedef vtkKWWidgetWithLabel vtkKWChangeColorButton::Superclass

Reimplemented from vtkKWWidgetWithLabel.

Definition at line 42 of file vtkKWChangeColorButton.h.

Member Enumeration Documentation

anonymous enum

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

Enumerator:

ColorChangedEvent

Definition at line 74 of file vtkKWChangeColorButton.h.

Constructor & Destructor Documentation

vtkKWChangeColorButton::vtkKWChangeColorButton ( ) [protected]

vtkKWChangeColorButton::~vtkKWChangeColorButton ( ) [protected]

Member Function Documentation

static vtkKWChangeColorButton* vtkKWChangeColorButton::New ( ) [static]

Reimplemented from vtkKWWidgetWithLabel.

virtual const char* vtkKWChangeColorButton::GetClassName ( ) [virtual]

Reimplemented from vtkKWWidgetWithLabel.

static int vtkKWChangeColorButton::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWWidgetWithLabel.

virtual int vtkKWChangeColorButton::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWWidgetWithLabel.

static vtkKWChangeColorButton* vtkKWChangeColorButton::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWWidgetWithLabel.

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

Reimplemented from vtkKWWidgetWithLabel.

virtual void vtkKWChangeColorButton::SetColor ( double c[3] ) [inline, virtual]

Set/Get the current color (RGB space)

Definition at line 47 of file vtkKWChangeColorButton.h.

virtual void vtkKWChangeColorButton::SetColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual double* vtkKWChangeColorButton::GetColor ( ) [inline, virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

Definition at line 49 of file vtkKWChangeColorButton.h.

virtual void vtkKWChangeColorButton::SetDialogTitle ( const char * ) [virtual]

Set the text that will be used on the title of the color selection dialog.

virtual char* vtkKWChangeColorButton::GetDialogTitle ( ) [virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual void vtkKWChangeColorButton::SetCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

Set the command that is called when the color is changed. 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: - selected RGB color: double, double, double

virtual void vtkKWChangeColorButton::SetBalloonHelpString ( const char * str ) [virtual]

Set the string that enables balloon help for this widget. Override to pass down to children.

Reimplemented from vtkKWWidgetWithLabel.

virtual void vtkKWChangeColorButton::SetLabelOutsideButton ( int ) [virtual]

Set the label to be outside the color button. Default is inside.

virtual int vtkKWChangeColorButton::GetLabelOutsideButton ( ) [virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual void vtkKWChangeColorButton::LabelOutsideButtonOn ( ) [virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual void vtkKWChangeColorButton::LabelOutsideButtonOff ( ) [virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual void vtkKWChangeColorButton::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 vtkKWWidgetWithLabel.

virtual void vtkKWChangeColorButton::ButtonPressCallback ( ) [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWChangeColorButton::ButtonReleaseCallback ( ) [virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual void vtkKWChangeColorButton::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWWidgetWithLabel.

virtual void vtkKWChangeColorButton::InvokeCommand	(	double	r,
		double	g,
		double	b
	)			`[protected, virtual]`

virtual void vtkKWChangeColorButton::Bind ( ) [protected, virtual]

Add/Remove interaction bindings

virtual void vtkKWChangeColorButton::UnBind ( ) [protected, virtual]

Events. The ColorChangedEvent is triggered when the color of the button is changed. It is similar in concept to the 'Command' callback but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current RGB color value: double[3] BTX

virtual void vtkKWChangeColorButton::UpdateColorButton ( ) [protected, virtual]

Update the color of the button given the current color, or use a 'disabled' color if the object is disabled.

virtual void vtkKWChangeColorButton::QueryUserForColor ( ) [protected, virtual]

Query user for color

virtual void vtkKWChangeColorButton::Pack ( ) [protected, virtual]

Pack or repack the widget

Reimplemented from vtkKWWidgetWithLabel.

virtual void vtkKWChangeColorButton::CreateLabel ( ) [protected, virtual]

Create the label (override the superclass)

Reimplemented from vtkKWWidgetWithLabel.

virtual void vtkKWChangeColorButton::CreateButtonFrame ( ) [protected, virtual]

Create the button frame