vtkKWCheckButton Class Reference

check button widget More...

#include <vtkKWCheckButton.h>

Inheritance diagram for vtkKWCheckButton:

[legend]

Collaboration diagram for vtkKWCheckButton:

[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 void	SetCommand (vtkObject object, const char method)
virtual void	UpdateEnableState ()
virtual void	CommandCallback ()
Static Public Member Functions
static vtkKWCheckButton *	New ()
static int	IsTypeOf (const char *type)
static vtkKWCheckButton *	SafeDownCast (vtkObject *o)
Protected Member Functions
virtual void	CreateWidget ()
virtual void	SetInternalText (const char *)
	vtkKWCheckButton ()
	~vtkKWCheckButton ()
virtual void	Configure ()
virtual void	InvokeCommand (int state)
Protected Attributes
int	IndicatorVisibility
char *	InternalText
char *	VariableName
char *	Command

enum	{ SelectedStateChangedEvent = 10000 }
virtual void	SetSelectedState (int)
virtual int	GetSelectedState ()
virtual void	SelectedStateOn ()
virtual void	SelectedStateOff ()
virtual void	ToggleSelectedState ()
virtual void	Select ()
virtual void	Deselect ()
virtual void	SetIndicatorVisibility (int ind)
virtual int	GetIndicatorVisibility ()
virtual void	IndicatorVisibilityOn ()
virtual void	IndicatorVisibilityOff ()
virtual void	SetText (const char *txt)
virtual const char *	GetText ()
virtual char *	GetVariableName ()
virtual void	SetVariableName (const char *)
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	GetForegroundColor (double r, double g, double *b)
virtual double *	GetForegroundColor ()
virtual void	SetForegroundColor (double r, double g, double b)
virtual void	SetForegroundColor (double rgb[3])
virtual void	SetHighlightThickness (int)
virtual int	GetHighlightThickness ()
virtual void	GetActiveBackgroundColor (double r, double g, double *b)
virtual double *	GetActiveBackgroundColor ()
virtual void	SetActiveBackgroundColor (double r, double g, double b)
virtual void	SetActiveBackgroundColor (double rgb[3])
virtual void	GetActiveForegroundColor (double r, double g, double *b)
virtual double *	GetActiveForegroundColor ()
virtual void	SetActiveForegroundColor (double r, double g, double b)
virtual void	SetActiveForegroundColor (double rgb[3])
virtual void	GetDisabledForegroundColor (double r, double g, double *b)
virtual double *	GetDisabledForegroundColor ()
virtual void	SetDisabledForegroundColor (double r, double g, double b)
virtual void	SetDisabledForegroundColor (double rgb[3])
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	SetPadX (int)
virtual int	GetPadX ()
virtual void	SetPadY (int)
virtual int	GetPadY ()
virtual void	SetAnchor (int)
virtual int	GetAnchor ()
virtual void	SetAnchorToNorth ()
virtual void	SetAnchorToNorthEast ()
virtual void	SetAnchorToEast ()
virtual void	SetAnchorToSouthEast ()
virtual void	SetAnchorToSouth ()
virtual void	SetAnchorToSouthWest ()
virtual void	SetAnchorToWest ()
virtual void	SetAnchorToNorthWest ()
virtual void	SetAnchorToCenter ()
virtual void	SetOffRelief (int)
virtual int	GetOffRelief ()
virtual void	SetOffReliefToRaised ()
virtual void	SetOffReliefToSunken ()
virtual void	SetOffReliefToFlat ()
virtual void	SetOffReliefToRidge ()
virtual void	SetOffReliefToSolid ()
virtual void	SetOffReliefToGroove ()
virtual void	SetOverRelief (int)
virtual int	GetOverRelief ()
virtual void	SetOverReliefToRaised ()
virtual void	SetOverReliefToSunken ()
virtual void	SetOverReliefToFlat ()
virtual void	SetOverReliefToRidge ()
virtual void	SetOverReliefToSolid ()
virtual void	SetOverReliefToGroove ()
virtual void	SetOverReliefToNone ()
virtual void	SetFont (const char *font)
virtual const char *	GetFont ()
virtual void	SetImageToIcon (vtkKWIcon *icon)
virtual void	SetImageToPredefinedIcon (int icon_index)
virtual void	SetImageToPixels (const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)
virtual void	SetSelectImageToIcon (vtkKWIcon *icon)
virtual void	SetSelectImageToPredefinedIcon (int icon_index)
virtual void	SetSelectImageToPixels (const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)
virtual void	SetCompoundMode (int)
virtual int	GetCompoundMode ()
virtual void	SetCompoundModeToNone ()
virtual void	SetCompoundModeToLeft ()
virtual void	SetCompoundModeToCenter ()
virtual void	SetCompoundModeToRight ()
virtual void	SetCompoundModeToTop ()
virtual void	SetCompoundModeToBottom ()
virtual void	GetSelectColor (double r, double g, double *b)
virtual double *	GetSelectColor ()
virtual void	SetSelectColor (double r, double g, double b)
virtual void	SetSelectColor (double rgb[3])

Detailed Description

check button widget

A simple widget that represents a check button. It can be modified and queried using the GetSelectedState and SetSelectedState methods.

Events:: vtkKWCheckButton::SelectedStateChangedEvent

Definition at line 31 of file vtkKWCheckButton.h.

Member Typedef Documentation

typedef vtkKWCoreWidget vtkKWCheckButton::Superclass

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

Definition at line 36 of file vtkKWCheckButton.h.

Member Enumeration Documentation

anonymous enum

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Enumerator:

SelectedStateChangedEvent

Definition at line 82 of file vtkKWCheckButton.h.

Constructor & Destructor Documentation

vtkKWCheckButton::vtkKWCheckButton ( ) [protected]

vtkKWCheckButton::~vtkKWCheckButton ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SetSelectedState ( int ) [virtual]

Set/Get/Toggle the selected state of the check button 0 = off 1 = on

virtual int vtkKWCheckButton::GetSelectedState ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SelectedStateOn ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SelectedStateOff ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::ToggleSelectedState ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::Select ( ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 45 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::Deselect ( ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 46 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetIndicatorVisibility ( int ind ) [virtual]

Tell the widget whether it should use an indicator (check box)

virtual int vtkKWCheckButton::GetIndicatorVisibility ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::IndicatorVisibilityOn ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::IndicatorVisibilityOff ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetText ( const char * txt ) [virtual]

Set the text.

virtual const char* vtkKWCheckButton::GetText ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual char* vtkKWCheckButton::GetVariableName ( ) [virtual]

Set the variable name. Important: note that this will *not* copy over the previous variable value to the new one.

virtual void vtkKWCheckButton::SetVariableName ( const char * ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

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

Specifies a command to associate with the widget. This command is typically invoked when the button is selected or deselected. 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: - current selected state: int

Reimplemented in vtkKWRadioButton.

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

Set/Get the background color of the widget.

virtual double* vtkKWCheckButton::GetBackgroundColor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

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

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetBackgroundColor ( double rgb[3] ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 94 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::GetForegroundColor	(	double *	r,
		double *	g,
		double *	b
	)			`[virtual]`

Set/Get the foreground color of the widget.

virtual double* vtkKWCheckButton::GetForegroundColor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetForegroundColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetForegroundColor ( double rgb[3] ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 103 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::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 vtkKWCheckButton::GetHighlightThickness ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::GetActiveBackgroundColor	(	double *	r,
		double *	g,
		double *	b
	)			`[virtual]`

Set/Get the active background color of the widget. An element (a widget or portion of a widget) is active if the mouse cursor is positioned over the element and pressing a mouse button will cause some action to occur.

virtual double* vtkKWCheckButton::GetActiveBackgroundColor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetActiveBackgroundColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetActiveBackgroundColor ( double rgb[3] ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 123 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::GetActiveForegroundColor	(	double *	r,
		double *	g,
		double *	b
	)			`[virtual]`

Set/Get the active foreground color of the widget. An element (a widget or portion of a widget) is active if the mouse cursor is positioned over the element and pressing a mouse button will cause some action to occur.

virtual double* vtkKWCheckButton::GetActiveForegroundColor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetActiveForegroundColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetActiveForegroundColor ( double rgb[3] ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 135 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::GetDisabledForegroundColor	(	double *	r,
		double *	g,
		double *	b
	)			`[virtual]`

Set/Get the foreground color of the widget when it is disabled.

virtual double* vtkKWCheckButton::GetDisabledForegroundColor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetDisabledForegroundColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetDisabledForegroundColor ( double rgb[3] ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 144 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::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 vtkKWCheckButton::GetBorderWidth ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::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 vtkKWCheckButton::GetRelief ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetReliefToRaised ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetReliefToSunken ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetReliefToFlat ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetReliefToRidge ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetReliefToSolid ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetReliefToGroove ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetPadX ( int ) [virtual]

Set/Get the padding that will be applied around each widget (in pixels). Specifies a non-negative value indicating how much extra space to request for the widget in the X and Y-direction. When computing how large a window it needs, the widget will add this amount to the width it would normally need (as determined by the width of the things displayed in the widget); if the geometry manager can satisfy this request, the widget will end up with extra internal space around what it displays inside.

virtual int vtkKWCheckButton::GetPadX ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetPadY ( int ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual int vtkKWCheckButton::GetPadY ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchor ( int ) [virtual]

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWOptions::AnchorType.

virtual int vtkKWCheckButton::GetAnchor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToNorth ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToNorthEast ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToEast ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToSouthEast ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToSouth ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToSouthWest ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToWest ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToNorthWest ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetAnchorToCenter ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffRelief ( int ) [virtual]

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWOptions::ReliefType.

virtual int vtkKWCheckButton::GetOffRelief ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffReliefToRaised ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffReliefToSunken ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffReliefToFlat ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffReliefToRidge ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffReliefToSolid ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOffReliefToGroove ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverRelief ( int ) [virtual]

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

virtual int vtkKWCheckButton::GetOverRelief ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToRaised ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToSunken ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToFlat ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToRidge ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToSolid ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToGroove ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetOverReliefToNone ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetFont ( const char * font ) [virtual]

Specifies the font to use when drawing text inside the widget. You can use predefined font names (e.g. 'system'), or you can specify a set of font attributes with a platform-independent name, for example, 'times 12 bold'. In this example, the font is specified with a three element list: the first element is the font family, the second is the size, the third is a list of style parameters (normal, bold, roman, italic, underline, overstrike). Example: 'times 12 {bold italic}'. The Times, Courier and Helvetica font families are guaranteed to exist and will be matched to the corresponding (closest) font on your system. If you are familiar with the X font names specification, you can also describe the font that way (say, '*times-medium-r-*-*-12*').

virtual const char* vtkKWCheckButton::GetFont ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetImageToIcon ( vtkKWIcon * icon ) [virtual]

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions: The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget. Check the SetCompoundMode method if you want to display both the image and the label at the same time.

virtual void vtkKWCheckButton::SetImageToPredefinedIcon ( int icon_index ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetImageToPixels	(	const unsigned char *	pixels,
		int	width,
		int	height,
		int	pixel_size,
		unsigned long	buffer_length = `0`
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetSelectImageToIcon ( vtkKWIcon * icon ) [virtual]

Specifies an image to display in the widget when the button is selected. This option is ignored unless an image has been set for the unselected state of the button already (see SetImageToIcon). Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-selectimage", imagename) to use a specific pre-existing Tk image, or call one of the following functions: The SetSelectImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetSelectImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget. Check the SetCompoundMode method if you want to display both the image and the label at the same time.

virtual void vtkKWCheckButton::SetSelectImageToPredefinedIcon ( int icon_index ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetSelectImageToPixels	(	const unsigned char *	pixels,
		int	width,
		int	height,
		int	pixel_size,
		unsigned long	buffer_length = `0`
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundMode ( int ) [virtual]

Specifies if the widget should display text and bitmaps/images at the same time, and if so, where the bitmap/image should be placed relative to the text. Valid constants can be found in vtkKWOptions::CompoundModeType. The (default) value CompoundModeNone specifies that the bitmap or image should (if defined) be displayed instead of the text.

virtual int vtkKWCheckButton::GetCompoundMode ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundModeToNone ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundModeToLeft ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundModeToCenter ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundModeToRight ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundModeToTop ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetCompoundModeToBottom ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::GetSelectColor	(	double *	r,
		double *	g,
		double *	b
	)			`[virtual]`

Set/Get the background color to use when the widget is selected.

virtual double* vtkKWCheckButton::GetSelectColor ( ) [virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetSelectColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

virtual void vtkKWCheckButton::SetSelectColor ( double rgb[3] ) [inline, virtual]

Events. The SelectedStateChangedEvent is triggered when the button is selected or deselected. The following parameters are also passed as client data: - the current selected state: int BTX

Definition at line 330 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::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 vtkKWCheckButton::CommandCallback ( ) [virtual]

Callbacks. Internal, do not use.

Reimplemented in vtkKWRadioButton.

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

Create the widget.

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SetInternalText ( const char * ) [protected, virtual]