vtkKWListBoxToListBoxSelectionEditor Class Reference

a composite dual-listbox selection editor More...

#include <vtkKWListBoxToListBoxSelectionEditor.h>

Inheritance diagram for vtkKWListBoxToListBoxSelectionEditor:

[legend]

Collaboration diagram for vtkKWListBoxToListBoxSelectionEditor:

[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 void	SetEllipsisCommand (vtkObject obj, const char method)
virtual void	SetFinalListChangedCommand (vtkObject obj, const char method)
virtual void	SetAllowReordering (int)
virtual void	AllowReorderingOn ()
virtual void	AllowReorderingOff ()
virtual int	GetAllowReordering ()
Static Public Member Functions
static vtkKWListBoxToListBoxSelectionEditor *	New ()
static int	IsTypeOf (const char *type)
static vtkKWListBoxToListBoxSelectionEditor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWListBoxToListBoxSelectionEditor ()
	~vtkKWListBoxToListBoxSelectionEditor ()
virtual void	CreateWidget ()
virtual void	Pack ()
virtual void	MoveWholeList (vtkKWListBox l1, vtkKWListBox l2)
virtual void	MoveSelectedList (vtkKWListBox l1, vtkKWListBox l2)
virtual void	MoveList (vtkKWListBox l1, vtkKWListBox l2, const char *list)
virtual void	ShiftItems (vtkKWListBox *l1, int down)
virtual void	AddElement (vtkKWListBox l1, vtkKWListBox l2, const char *element, int force)
virtual void	InvokeEllipsisCommand ()
virtual void	InvokeFinalListChangedCommand ()
virtual void	DisplayEllipsis ()
virtual void	RemoveEllipsis ()
Protected Attributes
vtkKWListBoxWithScrollbarsWithLabel *	SourceList
vtkKWListBoxWithScrollbarsWithLabel *	FinalList
vtkKWPushButton *	AddButton
vtkKWPushButton *	AddAllButton
vtkKWPushButton *	RemoveButton
vtkKWPushButton *	RemoveAllButton
vtkKWPushButton *	UpButton
vtkKWPushButton *	DownButton
vtkKWFrame *	ButtonFrame
char *	EllipsisCommand
char *	FinalListChangedCommand
int	EllipsisDisplayed
int	AllowReordering

enum	{ FinalListChangedEvent = 10000 }
virtual void	AddSourceElement (const char *, int force=0)
virtual void	RemoveSourceElement (int indx)
virtual void	AddFinalElement (const char *, int force=0)
virtual void	RemoveFinalElement (int index)
virtual int	GetNumberOfElementsOnSourceList ()
virtual int	GetNumberOfElementsOnFinalList ()
virtual const char *	GetElementFromSourceList (int idx)
virtual const char *	GetElementFromFinalList (int idx)
virtual int	GetElementIndexFromSourceList (const char *element)
virtual int	GetElementIndexFromFinalList (const char *element)
virtual void	RemoveItemsFromSourceList ()
virtual void	RemoveItemsFromFinalList ()
virtual vtkKWListBoxWithScrollbarsWithLabel *	GetSourceList ()
virtual vtkKWListBoxWithScrollbarsWithLabel *	GetFinalList ()
virtual void	UpdateEnableState ()
virtual void	Update ()
virtual void	AddCallback ()
virtual void	AddAllCallback ()
virtual void	RemoveCallback ()
virtual void	RemoveAllCallback ()
virtual void	UpCallback ()
virtual void	DownCallback ()
virtual void	EllipsisCallback ()
virtual void	SourceSelectionChangedCallback ()
virtual void	FinalSelectionChangedCallback ()

Detailed Description

a composite dual-listbox selection editor

This composite widget is used to manage a selection of text entries between two listboxes. The source listbox lists the available elements that can be add/removed/sorted to form a selection inside a target/final listbox.

Events:: vtkCommand::WidgetModifiedEvent vtkKWListBoxToListBoxSelectionEditor::FinalListChangedEvent

Definition at line 35 of file vtkKWListBoxToListBoxSelectionEditor.h.

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWListBoxToListBoxSelectionEditor::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 40 of file vtkKWListBoxToListBoxSelectionEditor.h.

Member Enumeration Documentation

anonymous enum

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

Enumerator:

FinalListChangedEvent

Definition at line 110 of file vtkKWListBoxToListBoxSelectionEditor.h.

Constructor & Destructor Documentation

vtkKWListBoxToListBoxSelectionEditor::vtkKWListBoxToListBoxSelectionEditor ( ) [protected]

vtkKWListBoxToListBoxSelectionEditor::~vtkKWListBoxToListBoxSelectionEditor ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWListBoxToListBoxSelectionEditor::AddSourceElement	(	const char *	,
		int	force = `0`
	)			`[virtual]`

Add/Remove a string element to the source list if it is not already there or on the final list. The optional argument force will make sure the item is added to the source list and removed from final if it is already there.

virtual void vtkKWListBoxToListBoxSelectionEditor::RemoveSourceElement ( int indx ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::AddFinalElement	(	const char *	,
		int	force = `0`
	)			`[virtual]`

Add/remove a string element to the final list if it is not already there or on the final list. The optional argument force will make sure the item is added to the final list and removed from source if it is already there.

virtual void vtkKWListBoxToListBoxSelectionEditor::RemoveFinalElement ( int index ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual int vtkKWListBoxToListBoxSelectionEditor::GetNumberOfElementsOnSourceList ( ) [virtual]

Get the number of elements on the final list.

virtual int vtkKWListBoxToListBoxSelectionEditor::GetNumberOfElementsOnFinalList ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual const char* vtkKWListBoxToListBoxSelectionEditor::GetElementFromSourceList ( int idx ) [virtual]

Get the element from the list.

virtual const char* vtkKWListBoxToListBoxSelectionEditor::GetElementFromFinalList ( int idx ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual int vtkKWListBoxToListBoxSelectionEditor::GetElementIndexFromSourceList ( const char * element ) [virtual]

Get the index of the item.

virtual int vtkKWListBoxToListBoxSelectionEditor::GetElementIndexFromFinalList ( const char * element ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::RemoveItemsFromSourceList ( ) [virtual]

Remove items from the list.

virtual void vtkKWListBoxToListBoxSelectionEditor::RemoveItemsFromFinalList ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual vtkKWListBoxWithScrollbarsWithLabel* vtkKWListBoxToListBoxSelectionEditor::GetSourceList ( ) [virtual]

Get the listbox objects.

virtual vtkKWListBoxWithScrollbarsWithLabel* vtkKWListBoxToListBoxSelectionEditor::GetFinalList ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::SetEllipsisCommand	(	vtkObject *	obj,
		const char *	method
	)			`[virtual]`

Specifies a command to associate with the widget. This command is typically invoked when the ellipsis button is pressed. 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 vtkKWListBoxToListBoxSelectionEditor::SetFinalListChangedCommand	(	vtkObject *	obj,
		const char *	method
	)			`[virtual]`

Specifies a command to associate with the widget. This command is typically invoked when the values in the FinalList are 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.

virtual void vtkKWListBoxToListBoxSelectionEditor::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 vtkKWListBoxToListBoxSelectionEditor::Update ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::SetAllowReordering ( int ) [virtual]

virtual void vtkKWListBoxToListBoxSelectionEditor::AllowReorderingOn ( ) [virtual]

virtual void vtkKWListBoxToListBoxSelectionEditor::AllowReorderingOff ( ) [virtual]

virtual int vtkKWListBoxToListBoxSelectionEditor::GetAllowReordering ( ) [virtual]

virtual void vtkKWListBoxToListBoxSelectionEditor::AddCallback ( ) [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWListBoxToListBoxSelectionEditor::AddAllCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::RemoveCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::RemoveAllCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::UpCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::DownCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::EllipsisCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::SourceSelectionChangedCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

virtual void vtkKWListBoxToListBoxSelectionEditor::FinalSelectionChangedCallback ( ) [virtual]

Events. The FinalListChangedEvent is triggered when the values in the FinalList are changed. BTX

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

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

Pack the widget

virtual void vtkKWListBoxToListBoxSelectionEditor::MoveWholeList	(	vtkKWListBox *	l1,
		vtkKWListBox *	l2
	)			`[protected, virtual]`

virtual void vtkKWListBoxToListBoxSelectionEditor::MoveSelectedList	(	vtkKWListBox *	l1,
		vtkKWListBox *	l2
	)			`[protected, virtual]`

virtual void vtkKWListBoxToListBoxSelectionEditor::MoveList	(	vtkKWListBox *	l1,
		vtkKWListBox *	l2,
		const char *	list
	)			`[protected, virtual]`

virtual void vtkKWListBoxToListBoxSelectionEditor::ShiftItems	(	vtkKWListBox *	l1,
		int	down
	)			`[protected, virtual]`

virtual void vtkKWListBoxToListBoxSelectionEditor::AddElement	(	vtkKWListBox *	l1,
		vtkKWListBox *	l2,
		const char *	element,
		int	force
	)			`[protected, virtual]`