Open Ephys GUI
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes
ProcessorListItem Class Reference

An item within the ProcessorList. More...

#include <ProcessorList.h>

List of all members.

Public Member Functions

 ProcessorListItem (const String &name)
 ~ProcessorListItem ()
int getNumSubItems ()
 Returns the number of sub-items for a given ProcessorListItem.
ProcessorListItemgetSubItem (int index)
 Returns the sub-item for a given index.
void clearSubItems ()
 Clears all the sub-items owned by the ProcessorListItem.
void addSubItem (ProcessorListItem *newItem)
 Adds a sub-item.
void removeSubItem (int index)
 Removes a sub-item with a given index.
bool hasSubItems ()
 Returns true if a ProcessorListItem has sub-items, false otherwise.
bool isOpen ()
 Removes true if a ProcessorListItem with sub-items is open, false otherwise.
void setOpen (bool)
 Sets the open/closed state of a ProcessorListItem with sub-items.
void reverseOpenState ()
 Toggles the open/closed state of a ProcessorListItem with sub-items.
bool isSelected ()
 Returns true if a ProcessorListItem has been selected by the user, false otherwise.
void setSelected (bool b)
 Sets selection state of a ProcessorListItem.
const String & getName ()
 Returns the name of a ProcessorListItem.
const String & getParentName ()
 Returns the name of the parent of a ProcessorListItem.
void setParentName (const String &name)
 Sets the name of the parent of a ProcessorListItem.

Public Attributes

int colorId
 Determines the color of the ProcessorListItem (based on enumerator defined in setParentName() method).

Detailed Description

An item within the ProcessorList.

If a ProcessorListItem has sub-items, it acts as a button that can be used to show/hide segments of the ProcessorList. If it has no sub-items, then it holds the name of a processor which can be dragged onto the EditorViewport to construct the signal chain.

See also:
ProcessorList

Constructor & Destructor Documentation

ProcessorListItem::ProcessorListItem ( const String &  name)
ProcessorListItem::~ProcessorListItem ( )

Member Function Documentation

int ProcessorListItem::getNumSubItems ( )

Returns the number of sub-items for a given ProcessorListItem.

ProcessorListItem* ProcessorListItem::getSubItem ( int  index)

Returns the sub-item for a given index.

void ProcessorListItem::clearSubItems ( )

Clears all the sub-items owned by the ProcessorListItem.

void ProcessorListItem::addSubItem ( ProcessorListItem newItem)

Adds a sub-item.

void ProcessorListItem::removeSubItem ( int  index)

Removes a sub-item with a given index.

bool ProcessorListItem::hasSubItems ( )

Returns true if a ProcessorListItem has sub-items, false otherwise.

bool ProcessorListItem::isOpen ( )

Removes true if a ProcessorListItem with sub-items is open, false otherwise.

void ProcessorListItem::setOpen ( bool  )

Sets the open/closed state of a ProcessorListItem with sub-items.

void ProcessorListItem::reverseOpenState ( )

Toggles the open/closed state of a ProcessorListItem with sub-items.

bool ProcessorListItem::isSelected ( )

Returns true if a ProcessorListItem has been selected by the user, false otherwise.

void ProcessorListItem::setSelected ( bool  b)

Sets selection state of a ProcessorListItem.

const String& ProcessorListItem::getName ( )

Returns the name of a ProcessorListItem.

const String& ProcessorListItem::getParentName ( )

Returns the name of the parent of a ProcessorListItem.

void ProcessorListItem::setParentName ( const String &  name)

Sets the name of the parent of a ProcessorListItem.


Member Data Documentation

int ProcessorListItem::colorId

Determines the color of the ProcessorListItem (based on enumerator defined in setParentName() method).


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