MLCSOListWrapper Class Reference

A class that wraps CSOList objects for use in Scripting. More...

List of all members.

Public Slots

bool addCSOToSelection (int id)
QVariant addGroup (QString label)
bool addGroupToSelection (int id)
void breakCSOandGroup (int csoId, int groupId)
void clearSelectedCSOs ()
void clearSelectedGroups ()
void combineCSOandGroup (int csoId, int groupId)
QVariantList getCenterOfSelectedCSOs () const
QVariantList getCenterOfSelectedGroups () const
QVariant getCSOAt (int idx)
QVariant getCSOById (int id)
unsigned int getCSOIndex (unsigned int id)
QVariant getGroupAt (int idx)
QVariant getGroupById (int id)
QVariant getGroupByLabel (QString label)
int getNumCSOGroups () const
int getNumCSOs () const
int getNumSelectedCSOs () const
int getNumSelectedGroups () const
QVariant getSelectedCSOAt (int index) const
QVariant getSelectedGroupAt (int index) const
void removeCSO (unsigned int id)
bool removeCSOFromSelection (int id)
void removeGroup (unsigned int id)
bool removeGroupFromSelection (int id)
void deregisterForNotification (unsigned int flags, MLABModule *module, QString methodName)
int getNumberOfRegisteredNotifiers (unsigned int flag)
void notifyObservers (int notificationFlag)
void registerForNotification (unsigned int flags, MLABModule *module, QString methodName)
bool loadFrom (QString filename, QString message)
bool saveTo (QString filename, bool binary) const

Properties

QVariantList centerOfSelectedCSOs
QVariantList centerOfSelectedGroups
int numCSOGroups
int numCSOs
int numSelectedCSOs
int numSelectedGroups


Detailed Description

A class that wraps CSOList objects for use in Scripting.

Member Function Documentation

bool MLCSOListWrapper::addCSOToSelection ( int  id  )  [slot]

Adds the CSO with the given id to the list of selected CSOs (no double entry).

Returns if the selcetion has been changed by this action

QVariant MLCSOListWrapper::addGroup ( QString  label  )  [slot]

Adds a new Group with given label to the list and returns its wrapper.

bool MLCSOListWrapper::addGroupToSelection ( int  id  )  [slot]

Adds the Group with the given id to the list of selected CSOs (no double entry).

Returns if the selcetion has been changed by this action

void MLCSOListWrapper::breakCSOandGroup ( int  csoId,
int  groupId 
) [slot]

Breaks the combination of the given CSO and the given Group.

void MLCSOListWrapper::clearSelectedCSOs (  )  [inline, slot]

Clears all selected CSOs.

void MLCSOListWrapper::clearSelectedGroups (  )  [inline, slot]

Clears all selected Groups.

void MLCSOListWrapper::combineCSOandGroup ( int  csoId,
int  groupId 
) [slot]

Combines the given CSO with the given Group.

void MLCSOListWrapper::deregisterForNotification ( unsigned int  flags,
MLABModule module,
QString  methodName 
) [slot]

Remove notification callback: deregister the method determined by methodName of the given module for the CSO notifications defined by flags.

QVariantList MLCSOListWrapper::getCenterOfSelectedCSOs (  )  const [slot]

Returns the center position of all bounding boxes of all selected CSOs.

'resultIsValid' is false if there are no selected CSOs available.

QVariantList MLCSOListWrapper::getCenterOfSelectedGroups (  )  const [slot]

Returns the center position of all bounding boxes of all CSOs of all selected CSOGroups.

'resultIsValid' is false if there are no selected groups available.

QVariant MLCSOListWrapper::getCSOAt ( int  idx  )  [slot]

Returns the CSO at the given position in the internal list.

QVariant MLCSOListWrapper::getCSOById ( int  id  )  [slot]

Returns the CSO with the given unique id.

Returns NULL if no such CSO is stored in the list.

unsigned int MLCSOListWrapper::getCSOIndex ( unsigned int  id  )  [slot]

Returns the index of the CSO with the given id in its list.

QVariant MLCSOListWrapper::getGroupAt ( int  idx  )  [slot]

Returns Group at the given index position.

QVariant MLCSOListWrapper::getGroupById ( int  id  )  [slot]

Returns the Group with the given id.

QVariant MLCSOListWrapper::getGroupByLabel ( QString  label  )  [slot]

Returns the Group with the given label.

int MLCSOListWrapper::getNumberOfRegisteredNotifiers ( unsigned int  flag  )  [slot]

Returns number of registered notification callbacks for given flag.

int MLCSOListWrapper::getNumCSOGroups (  )  const [slot]

Returns the number of Groups.

int MLCSOListWrapper::getNumCSOs (  )  const [slot]

Returns the number of CSOs.

int MLCSOListWrapper::getNumSelectedCSOs (  )  const [slot]

Returns the number of selected CSOs.

int MLCSOListWrapper::getNumSelectedGroups (  )  const [slot]

Returns the number of selectedGroups.

QVariant MLCSOListWrapper::getSelectedCSOAt ( int  index  )  const [slot]

Returns the selected CSO at the given index; no checking!

QVariant MLCSOListWrapper::getSelectedGroupAt ( int  index  )  const [slot]

Returns the selected CSOGroup at the given index; no checking!

bool MLCSOListWrapper::loadFrom ( QString  filename,
QString  message 
) [slot]

Reads out the internal structure for this list (CSOs and Groups) from the given file.

Returns if the operation was successful. A given message string is filled.

void MLCSOListWrapper::notifyObservers ( int  notificationFlag  )  [inline, slot]

Notifies all observers with this flag.

void MLCSOListWrapper::registerForNotification ( unsigned int  flags,
MLABModule module,
QString  methodName 
) [slot]

Add notification callback: register the method determined by methodName of the given module for the CSO notifications defined by flags.

In addition to the common CSO notification flags The flags defined in this header file can be used.

void MLCSOListWrapper::removeCSO ( unsigned int  id  )  [inline, slot]

Removes a CSO by its id and removes it from all Groups.

bool MLCSOListWrapper::removeCSOFromSelection ( int  id  )  [slot]

Removes the CSO with the given id from the list of selected CSOs.

Returns if the selcetion has been changed by this action

void MLCSOListWrapper::removeGroup ( unsigned int  id  )  [inline, slot]

Removes a Group by its id and removes it from all CSOs.

bool MLCSOListWrapper::removeGroupFromSelection ( int  id  )  [slot]

Removes the Group with the given id from the list of selected CSOs.

Returns if the selcetion has been changed by this action

bool MLCSOListWrapper::saveTo ( QString  filename,
bool  binary 
) const [slot]

Pipes the internal structure of a this list (CSOs and Groups) into the given file.

Returns if the operation was successful.


Property Documentation

QVariantList MLCSOListWrapper::centerOfSelectedCSOs [read]

Property to read the centers of the selected CSOs.

QVariantList MLCSOListWrapper::centerOfSelectedGroups [read]

Property to read the centers of the selected Groups.

int MLCSOListWrapper::numCSOGroups [read]

Property to read number of Groups.

int MLCSOListWrapper::numCSOs [read]

Property to read number of CSOs.

int MLCSOListWrapper::numSelectedCSOs [read]

Property to read number of selected CSOs.

int MLCSOListWrapper::numSelectedGroups [read]

Property to read number of selected Groups.


Generated on Sat Sep 3 18:38:03 2011 for MeVisLab Scripting Reference by  doxygen 1.5.8