Abstract base for objects (usually filters) which provide a series of actions a user can perform. More...
#include <ActionProvider.h>
Public Member Functions | |
| virtual std::vector< std::string > | EnumActions ()=0 |
| Return a list of all actions which may be performed on the object. More... | |
| virtual bool | PerformAction (const std::string &id)=0 |
| Perform a specific action. More... | |
Detailed Description
Abstract base for objects (usually filters) which provide a series of actions a user can perform.
Actions are identified by ASCII text names, which must be unique within a given object.
Most objects provide only one or two actions, so a reasonable user interface is one button per action.
Member Function Documentation
◆ EnumActions()
|
pure virtual |
Return a list of all actions which may be performed on the object.
Implemented in PausableFilter, ConstellationFilter, ExportFilter, MemoryFilter, PAMEdgeDetectorFilter, and ScalarStairstepFilter.
◆ PerformAction()
|
pure virtual |
Perform a specific action.
- Returns
- True if the action should be treated as reconfiguring the filter (clear and re-evaluate), false if not
Implemented in PausableFilter, ConstellationFilter, ExportFilter, MemoryFilter, PAMEdgeDetectorFilter, and ScalarStairstepFilter.
The documentation for this class was generated from the following files:
- lib/scopehal/ActionProvider.h
- lib/scopehal/ActionProvider.cpp
