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

Sends a text string via BLE keyboard. More...

#include <send_action.h>

Inheritance diagram for SendStringAction:
SendAction Action

Public Member Functions

Action::Type getType () const override
 Gets the type of this action.
 
const std::string & getText () const
 Gets the text string to be sent.
 
void send () override
 Executes the string send action.
 
 SendStringAction (IBleKeyboard *bleKeyboard, std::string t)
 Constructs a SendStringAction.
 
- Public Member Functions inherited from SendAction
void execute () override
 Executes the send action.
 
bool isSendAction () const override
 Checks if this action is a 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 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
 

Additional Inherited Members

- Public Types inherited from Action
enum class  Type : uint8_t {
  Unknown , SendString , SendChar , SendKey ,
  SendMediaKey , SerialOutput , Delayed
}
 
- Protected Member Functions inherited from SendAction
 SendAction (IBleKeyboard *bleKeyboard)
 Constructs a SendAction.
 
- Protected Attributes inherited from SendAction
IBleKeyboardbleKeyboard
 Pointer to BLE keyboard interface.
 

Detailed Description

Sends a text string via BLE keyboard.

Definition at line 103 of file send_action.h.

Constructor & Destructor Documentation

◆ SendStringAction()

SendStringAction::SendStringAction ( IBleKeyboard bleKeyboard,
std::string  t 
)

Constructs a SendStringAction.

Parameters
bleKeyboardPointer to BLE keyboard interface
tText string to send

Definition at line 70 of file send_action.cpp.

Member Function Documentation

◆ getText()

const std::string & SendStringAction::getText ( ) const
inline

Gets the text string to be sent.

Returns
The text string

Definition at line 125 of file send_action.h.

◆ getType()

Action::Type SendStringAction::getType ( ) const
inlineoverridevirtual

Gets the type of this action.

Returns
Action type

Reimplemented from Action.

Definition at line 114 of file send_action.h.

◆ send()

void SendStringAction::send ( )
overridevirtual

Executes the string send action.

Sends the configured text string to the BLE keyboard.

Implements SendAction.

Definition at line 80 of file send_action.cpp.


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