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

Holds tabs containing the application's visualizers. More...

#include <DataViewport.h>

Inheritance diagram for DataViewport:
AccessClass

List of all members.

Public Member Functions

 DataViewport ()
 ~DataViewport ()
int addTabToDataViewport (String tabName, Component *componentToAdd, GenericEditor *editor)
 Adds a new visualizer within a tab and returns the tab index.
void destroyTab (int)
 Removes a tab with a specified index.
void selectTab (int)
 Selects a tab with a specified index.
void currentTabChanged (int newIndex, const String &newTabName)
 Informs the component within the current tab that it's now active.
void disableConnectionToEditorViewport ()
 Prevents the DataViewport from signaling EditorViewport when changing tabs.
- 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.

Detailed Description

Holds tabs containing the application's visualizers.

The DataViewport sits in the center of the MainWindow and is always visible. Editors that create data visualizations can place them in the DataViewport for easy access on small monitors, or in a separate window for maximum flexibility.

This class is a subclass of juce_TabbedComponent.h

See also:
GenericEditor, InfoLabel, LfpDisplayCanvas

Constructor & Destructor Documentation

DataViewport::DataViewport ( )
DataViewport::~DataViewport ( )

Member Function Documentation

int DataViewport::addTabToDataViewport ( String  tabName,
Component *  componentToAdd,
GenericEditor editor 
)

Adds a new visualizer within a tab and returns the tab index.

void DataViewport::destroyTab ( int  )

Removes a tab with a specified index.

void DataViewport::selectTab ( int  )

Selects a tab with a specified index.

void DataViewport::currentTabChanged ( int  newIndex,
const String &  newTabName 
)

Informs the component within the current tab that it's now active.

void DataViewport::disableConnectionToEditorViewport ( )

Prevents the DataViewport from signaling EditorViewport when changing tabs.


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