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

Creates objects for user interaction. More...

#include <UIComponent.h>

List of all members.

Public Member Functions

 UIComponent (MainWindow *mainWindow_, ProcessorGraph *pgraph, AudioComponent *audio)
 ~UIComponent ()
EditorViewportgetEditorViewport ()
 Returns a pointer to the EditorViewport.
ProcessorListgetProcessorList ()
 Returns a pointer to the ProcessorList.
DataViewportgetDataViewport ()
 Returns a pointer to the DataViewport.
ProcessorGraphgetProcessorGraph ()
 Returns a pointer to the ProcessorGraph.
ControlPanelgetControlPanel ()
 Returns a pointer to the ControlPanel.
MessageCentergetMessageCenter ()
 Returns a pointer to the MessageCenter.
UIComponentgetUIComponent ()
 Returns a pointer to the UIComponent.
AudioComponentgetAudioComponent ()
 Returns a pointer to the AudioComponent.
void disableCallbacks ()
 Stops the callbacks to the ProcessorGraph which drive data acquisition.
void disableDataViewport ()
 Disables the connection between the DataViewport and the EditorViewport.
void childComponentChanged ()
 Called whenever a major change takes place within a child component, in order to make sure the UIComponent's other children get resized appropriately.
const StringArray getMenuBarNames ()
 Returns the names of all the requested menubar drop-down lists (e.g., "File", "Edit", "Help", etc.).
const PopupMenu getMenuForIndex (int topLevelMenuIndex, const String &menuName)
 Adds the commands contained within a given drop-down menu from the menubar.
void menuItemSelected (int menuItemID, int topLevelMenuIndex)
 Called when a particular menu item is selected.
ApplicationCommandTarget * getNextCommandTarget ()
 Doesn't do anything yet.
void getAllCommands (Array< CommandID > &commands)
 Returns a list of commands the application can perform.
void getCommandInfo (CommandID commandID, ApplicationCommandInfo &result)
 Returns the info, default keypress, and activation state of all the application's commands.
bool perform (const InvocationInfo &info)
 Determines what takes place when a given command is executed by the user.

Detailed Description

Creates objects for user interaction.

The UIComponent is responsible for the layout of the user interface and for creating the application's menu bar.

See also:
ControlPanel, ProcessorList, EditorViewport, DataViewport, MessageCenter

Constructor & Destructor Documentation

UIComponent::UIComponent ( MainWindow mainWindow_,
ProcessorGraph pgraph,
AudioComponent audio 
)
UIComponent::~UIComponent ( )

Member Function Documentation

EditorViewport* UIComponent::getEditorViewport ( )

Returns a pointer to the EditorViewport.

ProcessorList* UIComponent::getProcessorList ( )

Returns a pointer to the ProcessorList.

DataViewport* UIComponent::getDataViewport ( )

Returns a pointer to the DataViewport.

ProcessorGraph* UIComponent::getProcessorGraph ( )

Returns a pointer to the ProcessorGraph.

ControlPanel* UIComponent::getControlPanel ( )

Returns a pointer to the ControlPanel.

MessageCenter* UIComponent::getMessageCenter ( )

Returns a pointer to the MessageCenter.

UIComponent* UIComponent::getUIComponent ( )

Returns a pointer to the UIComponent.

AudioComponent* UIComponent::getAudioComponent ( )

Returns a pointer to the AudioComponent.

void UIComponent::disableCallbacks ( )

Stops the callbacks to the ProcessorGraph which drive data acquisition.

void UIComponent::disableDataViewport ( )

Disables the connection between the DataViewport and the EditorViewport.

void UIComponent::childComponentChanged ( )

Called whenever a major change takes place within a child component, in order to make sure the UIComponent's other children get resized appropriately.

const StringArray UIComponent::getMenuBarNames ( )

Returns the names of all the requested menubar drop-down lists (e.g., "File", "Edit", "Help", etc.).

const PopupMenu UIComponent::getMenuForIndex ( int  topLevelMenuIndex,
const String &  menuName 
)

Adds the commands contained within a given drop-down menu from the menubar.

void UIComponent::menuItemSelected ( int  menuItemID,
int  topLevelMenuIndex 
)

Called when a particular menu item is selected.

Doesn't do anything yet.

ApplicationCommandTarget* UIComponent::getNextCommandTarget ( )

Doesn't do anything yet.

void UIComponent::getAllCommands ( Array< CommandID > &  commands)

Returns a list of commands the application can perform.

void UIComponent::getCommandInfo ( CommandID  commandID,
ApplicationCommandInfo &  result 
)

Returns the info, default keypress, and activation state of all the application's commands.

bool UIComponent::perform ( const InvocationInfo &  info)

Determines what takes place when a given command is executed by the user.


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