selection Class Reference

With the Selection functions, you can retrieve information about the modules or columns you have selected within a view. These functions work best if run from an icon in the Views Toolbar. More...

#include <selinterface.h>

Inheritance diagram for selection:

Collaboration diagram for selection:

Public Slots
int	numberOfNodesSelected ()
	returns the number of modules that are selected.
String	selectedNode (int i)
	returns the path of the selected node
int	numberOfColumnsSelected ()
	returns a value for the number of columns selected in the xsheet.
String	selectedColumn (int i)
	returns the ith column selected in the xsheet.
bool	clearSelection ()
	Clear the selection.
bool	addNodeToSelection (String node)
	Add a node to the selection.
bool	removeNodeFromSelection (String node)
	Remove a node from the selection.
bool	addColumnToSelection (String column)
	Add a column to the selection.
bool	addDrawingColumnToSelection (String columnName)
	Adds the drawing column and it's associated read node to the selection.
bool	extendSelectionWithColumn (String columnName)
	Adds the column to the selection. If the column is a drawing column, also adds the associated read node to the selection.
void	setSelectionFrameRange (int start, int length)
	Sets the selection frame range.
bool	isSelectionRange ()
	Return true if the selection has a range.
int	startFrame ()
	Return the selected start frame.
int	numberOfFrames ()
	Return the number of selected frame.
void	selectAll ()
	selects all nodes and all columns in the scene

Public Member Functions
	selection (QObject *parent, char *name)

Detailed Description

With the Selection functions, you can retrieve information about the modules or columns you have selected within a view. These functions work best if run from an icon in the Views Toolbar.

You can use it in Script Editor only.

function dumpSelectedColumn()
{
 // The numberOfCellColumnsSelected function loops to check all of the selected columns and determine their frame values.
 //The selectedCellColumn function prints the name of the selected column to the shell and 
 // then loops through the values in the column to print them as well. 

  var ncol = selection.numberOfCellColumnsSelected();
  var nframe = frame.numberOf();
  var i;

  for (i = 0; i < ncol; ++i)
  {
    var f;
    var c = selection.selectedCellColumn(i);
    System.println("Column " + c);
    for (f = 1; f <= nframe; ++f)
    {
      var value = column.getEntry(c, 1, f);
      var keyframe = column.isKeyFrame(c, 1, f);
      if (keyframe) value += " (keyframe)";
      System.println(" " + f + ": " + value);
    }
  }
}

Constructor & Destructor Documentation

selection::selection	(	QObject *	parent,
		char *	name
	)

Member Function Documentation

bool selection::addColumnToSelection ( String  column )

slot

Add a column to the selection.

returns whether columns was located and successfully added to the selection

Parameters

column

name of column

bool selection::addDrawingColumnToSelection ( String  columnName )

slot

Adds the drawing column and it's associated read node to the selection.

Parameters

columnsname

displayed name of column

bool selection::addNodeToSelection ( String  node )

slot

Add a node to the selection.

returns whether node was located and successfully added to the selection

Parameters

node	name of node

bool selection::clearSelection ( )

slot

Clear the selection.

bool selection::extendSelectionWithColumn ( String  columnName )

slot

Adds the column to the selection. If the column is a drawing column, also adds the associated read node to the selection.

Parameters

columnsname

displayed name of column

bool selection::isSelectionRange ( )

slot

Return true if the selection has a range.

int selection::numberOfColumnsSelected ( )

slot

returns a value for the number of columns selected in the xsheet.

int selection::numberOfFrames ( )

slot

Return the number of selected frame.

int selection::numberOfNodesSelected ( )

slot

returns the number of modules that are selected.

bool selection::removeNodeFromSelection ( String  node )

slot

Remove a node from the selection.

returns whether node was located and successfully removed from the selection

Parameters

node	name of node

void selection::selectAll ( )

slot

selects all nodes and all columns in the scene

String selection::selectedColumn ( int  i )

slot

returns the ith column selected in the xsheet.

String selection::selectedNode ( int  i )

slot

returns the path of the selected node

void selection::setSelectionFrameRange ( int  start, int  length  )

slot

Sets the selection frame range.

Parameters

start	beginning frame
length	nb of frames selected

int selection::startFrame ( )

slot

Return the selected start frame.

---

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

• dox_files/variableScript/selinterface.h