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

Base class for creating processor editors. More...

#include <GenericEditor.h>

Inheritance diagram for GenericEditor:
AccessClass ArduinoOutputEditor EventNodeEditor FilterEditor FPGAOutputEditor MergerEditor RecordControlEditor ReferenceNodeEditor ResamplingNodeEditor SignalGeneratorEditor SourceNodeEditor SpikeDetectorEditor SplitterEditor VisualizerEditor WiFiOutputEditor

List of all members.

Public Member Functions

 GenericEditor (GenericProcessor *owner)
virtual ~GenericEditor ()
void paint (Graphics &g)
bool keyPressed (const KeyPress &key)
void switchSelectedState ()
void select ()
void highlight ()
void deselect ()
bool getSelectionState ()
void enable ()
void disable ()
bool getEnabledState ()
void setEnabledState (bool)
void startAcquisition ()
void stopAcquisition ()
String getName ()
virtual void tabNumber (int t)
int tabNumber ()
virtual void switchSource (int)
virtual void switchSource ()
GenericProcessorgetProcessor () const
void fadeIn ()
virtual void switchDest ()
virtual void switchIO (int)
virtual void buttonClicked (Button *button)
virtual void buttonEvent (Button *button)
virtual void sliderValueChanged (Slider *slider)
virtual void sliderEvent (Slider *slider)
virtual void editorWasClicked ()
bool checkDrawerButton (Button *button)
bool getRecordStatus (int chan)
bool getAudioStatus (int chan)
void selectChannels (Array< int >)
void refreshColors ()
virtual void update ()
virtual void updateSettings ()
virtual void updateVisualizer ()
virtual void channelChanged (int chan)
Array< int > getActiveChannels ()
ChannelgetChannel (int chan)
ChannelgetEventChannel (int chan)
int getStartChannel ()
- Public Member Functions inherited from AccessClass
 AccessClass ()
 ~AccessClass ()
void setUIComponent (UIComponent *)
 Sets the object's UIComponent and copies all the necessary pointers from the UIComponent.
virtual void updateChildComponents ()
 Called within setUIComponent() to enable subclasses to update their members' pointers.
EditorViewportgetEditorViewport ()
 Returns a pointer to the application's EditorViewport.
DataViewportgetDataViewport ()
 Returns a pointer to the application's DataViewport.
ProcessorListgetProcessorList ()
 Returns a pointer to the application's ProcessorList.
ProcessorGraphgetProcessorGraph ()
 Returns a pointer to the application's ProcessorGraph.
ControlPanelgetControlPanel ()
 Returns a pointer to the application's DataViewport.
MessageCentergetMessageCenter ()
 Returns a pointer to the application's MessageCenter.
UIComponentgetUIComponent ()
 Returns a pointer to the application's UIComponent.
AudioComponentgetAudioComponent ()
 Returns a pointer to the application's AudioComponent.

Public Attributes

int desiredWidth
int nodeId
bool isFading
float accumulator
Array< ParameterEditor * > parameterEditors
Font titleFont

Protected Member Functions

virtual void addParameterEditors ()

Protected Attributes

DrawerButtondrawerButton
int drawerWidth
ChannelSelectorchannelSelector

Detailed Description

Base class for creating processor editors.

If a processor doesn't havesign an editor defined, a GenericEditor will be used.

Classes derived from this class must place their controls as child components. They shouldn't try to re-draw any aspects of their background.

See also:
GenericProcessor, EditorViewport

Constructor & Destructor Documentation

GenericEditor::GenericEditor ( GenericProcessor owner)
virtual GenericEditor::~GenericEditor ( )
virtual

Member Function Documentation

void GenericEditor::paint ( Graphics &  g)
bool GenericEditor::keyPressed ( const KeyPress &  key)
void GenericEditor::switchSelectedState ( )
void GenericEditor::select ( )
void GenericEditor::highlight ( )
void GenericEditor::deselect ( )
bool GenericEditor::getSelectionState ( )
void GenericEditor::enable ( )

Reimplemented in VisualizerEditor.

void GenericEditor::disable ( )

Reimplemented in VisualizerEditor.

bool GenericEditor::getEnabledState ( )
void GenericEditor::setEnabledState ( bool  )
void GenericEditor::startAcquisition ( )

Reimplemented in ResamplingNodeEditor.

void GenericEditor::stopAcquisition ( )

Reimplemented in ResamplingNodeEditor.

String GenericEditor::getName ( )
virtual void GenericEditor::tabNumber ( int  t)
virtual
int GenericEditor::tabNumber ( )
virtual void GenericEditor::switchSource ( int  )
virtual

Reimplemented in MergerEditor.

virtual void GenericEditor::switchSource ( )
virtual

Reimplemented in MergerEditor.

GenericProcessor* GenericEditor::getProcessor ( ) const
void GenericEditor::fadeIn ( )
virtual void GenericEditor::switchDest ( )
virtual

Reimplemented in SplitterEditor.

virtual void GenericEditor::switchIO ( int  )
virtual

Reimplemented in MergerEditor, and SplitterEditor.

virtual void GenericEditor::buttonClicked ( Button *  button)
virtual
virtual void GenericEditor::buttonEvent ( Button *  button)
virtual
virtual void GenericEditor::sliderValueChanged ( Slider *  slider)
virtual
virtual void GenericEditor::sliderEvent ( Slider *  slider)
virtual
virtual void GenericEditor::editorWasClicked ( )
virtual

Reimplemented in VisualizerEditor.

bool GenericEditor::checkDrawerButton ( Button *  button)
bool GenericEditor::getRecordStatus ( int  chan)
bool GenericEditor::getAudioStatus ( int  chan)
void GenericEditor::selectChannels ( Array< int >  )
void GenericEditor::refreshColors ( )
virtual void GenericEditor::update ( )
virtual
virtual void GenericEditor::updateSettings ( )
virtual

Reimplemented in RecordControlEditor.

virtual void GenericEditor::updateVisualizer ( )
virtual

Reimplemented in VisualizerEditor.

virtual void GenericEditor::channelChanged ( int  chan)
virtual

Reimplemented in SpikeDetectorEditor.

Array<int> GenericEditor::getActiveChannels ( )
Channel* GenericEditor::getChannel ( int  chan)
Channel* GenericEditor::getEventChannel ( int  chan)
int GenericEditor::getStartChannel ( )
virtual void GenericEditor::addParameterEditors ( )
protectedvirtual

Reimplemented in SignalGeneratorEditor.


Member Data Documentation

int GenericEditor::desiredWidth
int GenericEditor::nodeId
bool GenericEditor::isFading
float GenericEditor::accumulator
Array<ParameterEditor*> GenericEditor::parameterEditors
Font GenericEditor::titleFont
DrawerButton* GenericEditor::drawerButton
protected
int GenericEditor::drawerWidth
protected
ChannelSelector* GenericEditor::channelSelector
protected

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