vtkKWListBox Class Reference

List Box. More...

#include <vtkKWListBox.h>

Inheritance diagram for vtkKWListBox:

[legend]

Collaboration diagram for vtkKWListBox:

[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	InsertEntry (int index, const char *name)
virtual int	AppendUnique (const char *name)
virtual int	Append (const char *name)
virtual void	SetSelectionCommand (vtkObject *object, const char *method)
virtual int	GetNumberOfItems ()
virtual const char *	GetItem (int index)
virtual int	GetItemIndex (const char *item)
virtual void	DeleteRange (int start, int end)
virtual void	DeleteAll ()
virtual void	UpdateEnableState ()
virtual void	SelectionCallback ()
Static Public Member Functions
static vtkKWListBox *	New ()
static int	IsTypeOf (const char *type)
static vtkKWListBox *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWListBox ()
	~vtkKWListBox ()
virtual void	CreateWidget ()
virtual void	InvokeSelectionCommand ()
Protected Attributes
char *	CurrentSelection
char *	Item
char *	SelectionCommand
enum	{ ListBoxSelectionChangedEvent = 10000 }
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	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	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	SetFont (const char *font)
virtual const char *	GetFont ()
virtual void	SetSelectionMode (int)
virtual int	GetSelectionMode ()
virtual void	SetSelectionModeToSingle ()
virtual void	SetSelectionModeToBrowse ()
virtual void	SetSelectionModeToMultiple ()
virtual void	SetSelectionModeToExtended ()
virtual void	SetExportSelection (int)
virtual int	GetExportSelection ()
virtual void	ExportSelectionOn ()
virtual void	ExportSelectionOff ()
virtual const char *	GetSelection ()
virtual int	GetSelectionIndex ()
virtual void	SetSelectionIndex (int)
virtual void	SetSelectState (int idx, int state)
virtual int	GetSelectState (int idx)
virtual void	SetDoubleClickCommand (vtkObject *obj, const char *method)
virtual void	SetSingleClickCommand (vtkObject *obj, const char *method)
virtual void	SetWidth (int)
virtual int	GetWidth ()
virtual void	SetHeight (int)
virtual int	GetHeight ()

---

Detailed Description

List Box.

A widget that can have a list of items. Use vtkKWListBoxWithScrollbars if you need scrollbars.

See also:

vtkKWListBoxWithScrollbars

Events:

vtkKWListBox::ListBoxSelectionChangedEvent

Definition at line 31 of file vtkKWListBox.h.

---

Member Typedef Documentation

typedef vtkKWCoreWidget vtkKWListBox::Superclass

Reimplemented from vtkKWCoreWidget.

Definition at line 36 of file vtkKWListBox.h.

---

Member Enumeration Documentation

anonymous enum

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

Enumerator:

ListBoxSelectionChangedEvent

Definition at line 187 of file vtkKWListBox.h.

---

Constructor & Destructor Documentation

vtkKWListBox::vtkKWListBox

(

)

[protected]

vtkKWListBox::~vtkKWListBox

(

)

[protected]

---

Member Function Documentation

static vtkKWListBox* vtkKWListBox::New

(

)

[static]

Reimplemented from vtkKWCoreWidget.

virtual const char* vtkKWListBox::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCoreWidget.

static int vtkKWListBox::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCoreWidget.

virtual int vtkKWListBox::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCoreWidget.

static vtkKWListBox* vtkKWListBox::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCoreWidget.

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

Reimplemented from vtkKWCoreWidget.

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

Set/Get the background color of the widget.

virtual double* vtkKWListBox::GetBackgroundColor

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

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

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetBackgroundColor

(

double

rgb[3]

)

[inline, virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

Definition at line 44 of file vtkKWListBox.h.

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

Set/Get the foreground color of the widget.

virtual double* vtkKWListBox::GetForegroundColor

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

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

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetForegroundColor

(

double

rgb[3]

)

[inline, virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

Definition at line 53 of file vtkKWListBox.h.

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

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

virtual double* vtkKWListBox::GetDisabledForegroundColor

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

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

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetDisabledForegroundColor

(

double

rgb[3]

)

[inline, virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

Definition at line 62 of file vtkKWListBox.h.

virtual void vtkKWListBox::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 vtkKWListBox::GetHighlightThickness

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::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 vtkKWListBox::GetBorderWidth

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::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 vtkKWListBox::GetRelief

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetReliefToRaised

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetReliefToSunken

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetReliefToFlat

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetReliefToRidge

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetReliefToSolid

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetReliefToGroove

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::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* vtkKWListBox::GetFont

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectionMode

(

int

)

[virtual]

Set/Get the one of several styles for manipulating the selection. Valid constants can be found in vtkKWOptions::SelectionModeType.

virtual int vtkKWListBox::GetSelectionMode

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectionModeToSingle

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectionModeToBrowse

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectionModeToMultiple

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectionModeToExtended

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetExportSelection

(

int

)

[virtual]

Specifies whether or not a selection in the widget should also be the X selection. If the selection is exported, then selecting in the widget deselects the current X selection, selecting outside the widget deselects any widget selection, and the widget will respond to selection retrieval requests when it has a selection.

virtual int vtkKWListBox::GetExportSelection

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::ExportSelectionOn

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::ExportSelectionOff

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual const char* vtkKWListBox::GetSelection

(

)

[virtual]

Get the current selected string in the list. This is used when Select mode is single or browse.

virtual int vtkKWListBox::GetSelectionIndex

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectionIndex

(

int

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetSelectState	(	int	idx,
		int	state
	)			[virtual]

When selectmode is multiple or extended, then these methods can be used to set and query the selection.

virtual int vtkKWListBox::GetSelectState

(

int

idx

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::InsertEntry	(	int	index,
		const char *	name
	)			[virtual]

Add an entry.

virtual int vtkKWListBox::AppendUnique

(

const char *

name

)

[virtual]

Append a unique string to the list. If the string exists, it will not be appended

virtual int vtkKWListBox::Append

(

const char *

name

)

[virtual]

Append a string to the list. This call does not check if the string is unique.

virtual void vtkKWListBox::SetSelectionCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Specifies a command to be invoked when an element is selected/deselected in the widget. Re-selecting an element will trigger this command too. 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 vtkKWListBox::SetDoubleClickCommand	(	vtkObject *	obj,
		const char *	method
	)			[virtual]

Specifies a command to be invoked when the user single-click or double-click in the listbox. This does *not* imply the selection changed though (use SetSelectionCommand instead). 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. Set callback for single and double click on a list item.

virtual void vtkKWListBox::SetSingleClickCommand	(	vtkObject *	obj,
		const char *	method
	)			[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual int vtkKWListBox::GetNumberOfItems

(

)

[virtual]

Get number of items in the list.

virtual const char* vtkKWListBox::GetItem

(

int

index

)

[virtual]

Get the item at the given index.

virtual int vtkKWListBox::GetItemIndex

(

const char *

item

)

[virtual]

Returns the index of the first given item.

virtual void vtkKWListBox::DeleteRange	(	int	start,
		int	end
	)			[virtual]

Delete a range of items in the list.

virtual void vtkKWListBox::DeleteAll

(

)

[virtual]

Delete all items from the list.

virtual void vtkKWListBox::SetWidth

(

int

)

[virtual]

Set the width of the list box. If the width is less than or equal to 0, then the width is set to the size of the largest string.

virtual int vtkKWListBox::GetWidth

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::SetHeight

(

int

)

[virtual]

Set the height of the list box. If the height is less than or equal to 0, then the height is set to the size of the number of items in the listbox.

virtual int vtkKWListBox::GetHeight

(

)

[virtual]

Events. The ListBoxSelectionChangedEvent is triggered when an element is selected/deselected in the widget. Re-selecting an element will trigger this event too. It is similar in concept as the 'SelectionCommand' / callback but can be used by multiple listeners/observers at a time. BTX

virtual void vtkKWListBox::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 vtkKWListBox::SelectionCallback

(

)

[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWListBox::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCoreWidget.

virtual void vtkKWListBox::InvokeSelectionCommand

(

)

[protected, virtual]

---

Member Data Documentation

char* vtkKWListBox::CurrentSelection [protected]

Definition at line 244 of file vtkKWListBox.h.

char* vtkKWListBox::Item [protected]

Definition at line 245 of file vtkKWListBox.h.

char* vtkKWListBox::SelectionCommand [protected]

Definition at line 247 of file vtkKWListBox.h.

---

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

• vtkKWListBox.h