Windows Virtual Shields for Arduino
Public Member Functions | List of all members
Text Class Reference

#include <Text.h>

Inherits Sensor.

Inherited by Graphics.

Public Member Functions

 Text (const VirtualShield &shield)
 Initializes a new instance of the Screen class. More...
 
int clear (ARGB argb=0)
 Clears the screen of all elements. More...
 
int clearLine (UINT line)
 Clears the line. More...
 
int clearId (UINT id)
 Clears the element associated with the id. More...
 
int print (String text, ARGB argb=0)
 Prints the specified text. More...
 
int printAt (UINT line, String text, Attr extraAttributes[]=0, int extraAttributeCount=0)
 Prints the specified text at the specified line. More...
 
int printAt (UINT line, EPtr text, Attr extraAttributes[]=0, int extraAttributeCount=0)
 Prints the specified text at the specified line. More...
 
int printAt (UINT line, double value, ARGB argb=0)
 Prints the specified double at the specified line. More...
 
void onJsonReceived (JsonObject &root, ShieldEvent *shieldEvent) override
 Event called when a valid json message was received. Consumes the proper values for this sensor. More...
 
- Public Member Functions inherited from Sensor
 Sensor (const VirtualShield &shield, const char sensorType)
 Initializes a new instance of the Sensor class. More...
 
int start (double delta=0, long interval=0)
 Starts the sensor, triggered when longer than the interval and larger than the delta. More...
 
virtual int stop ()
 Stops this sensor. More...
 
int get ()
 Gets a single, current sensor reading. More...
 
int getOnChange (double delta=0)
 Requests a single reading when more than the delta beyond the current reading. More...
 
bool isUpdated ()
 Determines whether this sensor has an updated value. Resets to false after this call. More...
 
int writeAll (const char *serviceName, EPtr values[], int count, Attr extraAttributes[]=0, int extraAttributeCount=0)
 Writes all EPtr values to the communication channel. More...
 
int sensorAction (SensorAction sensorAction, double delta=0, long interval=0) const
 Sends the specific action to start/stop/get/onChange the sensor using a delta and interval. More...
 
virtual bool isEvent (const char *tag, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the tag and action. More...
 
virtual bool isEvent (int id, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the id and action. More...
 
void setOnEvent (void(*onEvent)(ShieldEvent *shieldEvent))
 
int sendStop (const char *serviceName)
 

Additional Inherited Members

- Public Attributes inherited from Sensor
void(* onEvent )(ShieldEvent *shieldEvent)
 
VirtualShieldshield
 
ShieldEvent recentEvent
 
const char sensorType
 
bool isRunning = false
 
- Protected Attributes inherited from Sensor
bool _isUpdated = false
 

Constructor & Destructor Documentation

Text::Text ( const VirtualShield shield)

Initializes a new instance of the Screen class.

Parameters
shieldThe shield.

Member Function Documentation

int Text::clear ( ARGB  argb = 0)

Clears the screen of all elements.

Returns
The id of the message. Negative if an error.
int Text::clearId ( UINT  id)

Clears the element associated with the id.

Parameters
idThe id.
Returns
The id of the message. Negative if an error.
int Text::clearLine ( UINT  line)

Clears the line.

Parameters
lineThe line.
Returns
The id of the message. Negative if an error.
void Text::onJsonReceived ( JsonObject &  root,
ShieldEvent shieldEvent 
)
overridevirtual

Event called when a valid json message was received. Consumes the proper values for this sensor.

Parameters
rootThe root json object.
shieldEventThe shield event.

Reimplemented from Sensor.

int Text::print ( String  text,
ARGB  argb = 0 
)

Prints the specified text.

Parameters
textThe text.
Returns
The id of the message. Negative if an error.
int Text::printAt ( UINT  line,
String  text,
Attr  extraAttributes[] = 0,
int  extraAttributeCount = 0 
)

Prints the specified text at the specified line.

Parameters
lineThe line.
textThe text.
Returns
The id of the message. Negative if an error.
int Text::printAt ( UINT  line,
EPtr  text,
Attr  extraAttributes[] = 0,
int  extraAttributeCount = 0 
)

Prints the specified text at the specified line.

Parameters
lineThe line.
textThe text.
Returns
The id of the message. Negative if an error.
int Text::printAt ( UINT  line,
double  value,
ARGB  argb = 0 
)

Prints the specified double at the specified line.

Parameters
lineThe line.
valueThe value.
Returns
The id of the message. Negative if an error.

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