WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::ShuffleboardRoot Class Referenceabstract

The root of the data placed in Shuffleboard. More...

#include <ShuffleboardRoot.h>

Inheritance diagram for frc::ShuffleboardRoot:
frc::detail::ShuffleboardInstance

Public Member Functions

virtual ShuffleboardTabGetTab (wpi::StringRef title)=0
 Gets the tab with the given title, creating it if it does not already exist. More...
 
virtual void Update ()=0
 Updates all tabs.
 
virtual void EnableActuatorWidgets ()=0
 Enables all widgets in Shuffleboard that offer user control over actuators.
 
virtual void DisableActuatorWidgets ()=0
 Disables all widgets in Shuffleboard that offer user control over actuators.
 
virtual void SelectTab (int index)=0
 Selects the tab in the dashboard with the given index in the range [0..n-1], where n is the number of tabs in the dashboard at the time this method is called. More...
 
virtual void SelectTab (wpi::StringRef title)=0
 Selects the tab in the dashboard with the given title. More...
 

Detailed Description

The root of the data placed in Shuffleboard.

It contains the tabs, but no data is placed directly in the root.

This class is package-private to minimize API surface area.

Member Function Documentation

virtual ShuffleboardTab& frc::ShuffleboardRoot::GetTab ( wpi::StringRef  title)
pure virtual

Gets the tab with the given title, creating it if it does not already exist.

Parameters
titlethe title of the tab
Returns
the tab with the given title

Implemented in frc::detail::ShuffleboardInstance.

virtual void frc::ShuffleboardRoot::SelectTab ( int  index)
pure virtual

Selects the tab in the dashboard with the given index in the range [0..n-1], where n is the number of tabs in the dashboard at the time this method is called.

Parameters
indexthe index of the tab to select

Implemented in frc::detail::ShuffleboardInstance.

virtual void frc::ShuffleboardRoot::SelectTab ( wpi::StringRef  title)
pure virtual

Selects the tab in the dashboard with the given title.

Parameters
titlethe title of the tab to select

Implemented in frc::detail::ShuffleboardInstance.


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