ImageSelectorWidget Class Reference

Description

This widget is used to select data from the DataManager.

Different methods are provided to select data using this widget: single index, list of index or a string.

See also VQ getWidget() to obtain this object.

Public Member Functions
bool	selectAll ()
	Selects all loaded data sets.
bool	setSelectedList (Array< Index > indices, bool selected=true)
	Selects or unselects a list of data indices.
bool	setSelectedIndex (Index idx, bool selected=true)
	Selects or unselects a single data index.
bool	setSelectionString (string selection)
	Sets selected indices based on a given string.

Member Function Documentation

selectAll()

bool selectAll

(

)

Selects all loaded data sets.

Returns

True if the selection is valid, false otherwise

setSelectedIndex()

bool setSelectedIndex	(	Index	idx,
		bool	selected = true )

Selects or unselects a single data index.

Parameters

idx	The index (see VQ.index())
selected	Use true to select and false to unselect

Returns

True if the selection is valid, false otherwise

Note

Adds or removes from current selection; does not overwrite it.

setSelectedList()

bool setSelectedList	(	Array< Index >	indices,
		bool	selected = true )

Selects or unselects a list of data indices.

Parameters

indices	The list of indices (see VQ.index())
selected	Use true to select and false to unselect

Returns

True if the selection is valid, false otherwise

Note

Adds or removes from current selection; does not overwrite it.

setSelectionString()

bool setSelectionString

(

string

selection

)

Sets selected indices based on a given string.

Parameters

selection

The text selection separated by commas. Use '.' for a dynamic data child index. (ie. '0,1.1,1.2,2')

Returns

True if the selection is valid, false otherwise

Note

Overwrites the current selection.