vtkKWRadioButton Class Reference

a radio button widget More...

#include <vtkKWRadioButton.h>

Inheritance diagram for vtkKWRadioButton:

[legend]

Collaboration diagram for vtkKWRadioButton:

[legend]

List of all members.

Public Types
typedef vtkKWCheckButton	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	CommandCallback ()
Static Public Member Functions
static vtkKWRadioButton *	New ()
static int	IsTypeOf (const char *type)
static vtkKWRadioButton *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWRadioButton ()
	~vtkKWRadioButton ()
virtual void	CreateWidget ()
virtual void	InvokeCommand (int state)
enum	{ SelectedStateChangedEvent = 10000 }
virtual void	SelectedStateOn ()
virtual void	SelectedStateOff ()
virtual int	GetSelectedState ()
virtual void	SetValue (const char *v)
virtual void	SetValueAsInt (int v)
virtual const char *	GetValue ()
virtual int	GetValueAsInt ()
virtual void	SetVariableValue (const char *v)
virtual void	SetVariableValueAsInt (int v)
virtual const char *	GetVariableValue ()
virtual int	GetVariableValueAsInt ()

---

Detailed Description

a radio button widget

A simple widget representing a radio button. The state can be set or queried.

Events:

vtkKWRadioButton::SelectedStateChangedEvent

Definition at line 29 of file vtkKWRadioButton.h.

---

Member Typedef Documentation

typedef vtkKWCheckButton vtkKWRadioButton::Superclass

Reimplemented from vtkKWCheckButton.

Definition at line 34 of file vtkKWRadioButton.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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

Enumerator:

SelectedStateChangedEvent

Definition at line 70 of file vtkKWRadioButton.h.

---

Constructor & Destructor Documentation

vtkKWRadioButton::vtkKWRadioButton

(

)

[inline, protected]

Definition at line 92 of file vtkKWRadioButton.h.

vtkKWRadioButton::~vtkKWRadioButton

(

)

[inline, protected]

Definition at line 93 of file vtkKWRadioButton.h.

---

Member Function Documentation

static vtkKWRadioButton* vtkKWRadioButton::New

(

)

[static]

Reimplemented from vtkKWCheckButton.

virtual const char* vtkKWRadioButton::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCheckButton.

static int vtkKWRadioButton::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCheckButton.

virtual int vtkKWRadioButton::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCheckButton.

static vtkKWRadioButton* vtkKWRadioButton::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCheckButton.

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

Reimplemented from vtkKWCheckButton.

virtual void vtkKWRadioButton::SelectedStateOn

(

)

[virtual]

Set/Get the state of the Radio button 0 = off 1 = on

Reimplemented from vtkKWCheckButton.

virtual void vtkKWRadioButton::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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

Reimplemented from vtkKWCheckButton.

virtual int vtkKWRadioButton::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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

Reimplemented from vtkKWCheckButton.

virtual void vtkKWRadioButton::SetValue

(

const char *

v

)

[virtual]

Set/Get the value to store in the button's associated variable whenever this button is selected.

virtual void vtkKWRadioButton::SetValueAsInt

(

int

v

)

[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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

virtual const char* vtkKWRadioButton::GetValue

(

)

[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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

virtual int vtkKWRadioButton::GetValueAsInt

(

)

[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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

virtual void vtkKWRadioButton::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. Note that the selected state is not* passed as parameter, which is the case for vtkKWCheckButton for example. In most cases, since the selected state is shared among many radiobuttons, this command will likely to perform a task related to the meaning of the button itself.

Reimplemented from vtkKWCheckButton.

virtual void vtkKWRadioButton::SetVariableValue

(

const char *

v

)

[virtual]

Set/Get the button's associated variable directly to a specific value.

virtual void vtkKWRadioButton::SetVariableValueAsInt

(

int

v

)

[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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

virtual const char* vtkKWRadioButton::GetVariableValue

(

)

[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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

virtual int vtkKWRadioButton::GetVariableValueAsInt

(

)

[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 Yes, this is duplicated from vtkKWCheckButton, so that code does not break when vtkKWRadioButton is not a subclass of vtkKWCheckButton anymore. BTX

virtual void vtkKWRadioButton::CommandCallback

(

)

[virtual]

Callbacks. Internal, do not use.

Reimplemented from vtkKWCheckButton.

virtual void vtkKWRadioButton::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCheckButton.

virtual void vtkKWRadioButton::InvokeCommand

(

int

state

)

[protected, virtual]

Reimplemented from vtkKWCheckButton.

---

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

• vtkKWRadioButton.h