AwesomeStudioPedal
A programmable, multi-profile foot controller for DAWs, score readers, and studio automation
Loading...
Searching...
No Matches
SendAction Class Referenceabstract

Base class for all sendable actions. More...

#include <send_action.h>

Inheritance diagram for SendAction:
Action SendCharAction SendKeyAction SendMediaKeyAction SendStringAction

Public Member Functions

void execute () override
 Executes the send action.
 
bool isSendAction () const override
 Checks if this action is a send action.
 
virtual void send ()=0
 Executes the send action.
 
 ~SendAction () override=default
 
- Public Member Functions inherited from Action
void setName (const std::string &n)
 
const std::string & getName () const
 
bool hasName () const
 
virtual Type getType () const
 
virtual uint32_t getDelay () const
 
virtual bool isInProgress () const
 Returns true if the action is currently in progress (e.g.
 
virtual void getJsonProperties (JsonObject &json) const
 
virtual ~Action ()=default
 

Protected Member Functions

 SendAction (IBleKeyboard *bleKeyboard)
 Constructs a SendAction.
 

Protected Attributes

IBleKeyboardbleKeyboard
 Pointer to BLE keyboard interface.
 

Additional Inherited Members

- Public Types inherited from Action
enum class  Type : uint8_t {
  Unknown , SendString , SendChar , SendKey ,
  SendMediaKey , SerialOutput , Delayed
}
 

Detailed Description

Base class for all sendable actions.

Abstract base class that defines the interface for actions that can be sent via BLE keyboard. Inherits from Action.

Definition at line 13 of file send_action.h.

Constructor & Destructor Documentation

◆ ~SendAction()

SendAction::~SendAction ( )
overridedefault

◆ SendAction()

SendAction::SendAction ( IBleKeyboard bleKeyboard)
protected

Constructs a SendAction.

Parameters
bleKeyboardPointer to BLE keyboard interface

Definition at line 8 of file send_action.cpp.

Member Function Documentation

◆ execute()

void SendAction::execute ( )
inlineoverridevirtual

Executes the send action.

Sends the configured input to the BLE keyboard.

Implements Action.

Definition at line 21 of file send_action.h.

◆ isSendAction()

bool SendAction::isSendAction ( ) const
inlineoverridevirtual

Checks if this action is a send action.

Returns
true since this is a send action

Reimplemented from Action.

Definition at line 28 of file send_action.h.

◆ send()

virtual void SendAction::send ( )
pure virtual

Executes the send action.

Sends the configured input to the BLE keyboard.

Implemented in SendCharAction, SendStringAction, SendKeyAction, and SendMediaKeyAction.

Member Data Documentation

◆ bleKeyboard

IBleKeyboard* SendAction::bleKeyboard
protected

Pointer to BLE keyboard interface.

Definition at line 39 of file send_action.h.


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