VivoQuant
Public Member Functions | List of all members
ImageSelectorWidget Class Reference

This widget is used to select data from the DataManager. More...

Public Member Functions

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

Detailed 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 ScriptMaster getWidget() to obtain this object.

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
idxThe index (see ScriptMaster::index())
selectedUse true to select and false to unslect
Returns
True if the selection is valid, false otherwise
Note
It adds or remove to the current existing selection, it does not overwrite it.

◆ setSelectedList()

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

Selects or unselects a list of data indices.

Parameters
indicesThe list of indices (see ScriptMaster::index())
selectedUse true to select and false to unslect
Returns
True if the selection is valid, false otherwise
Note
It adds or remove to the current existing selection, it does not overwrite it.

◆ setSelectionString()

bool setSelectionString ( string  selection)

Sets selected indices based on a given string.

Parameters
selectionThe 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
It overwrites the current selection.