mcr::StringKey Class Reference

#include <string_key.h>

Inheritance diagram for mcr::StringKey:

Public Member Functions
	StringKey (bool cryptic=false)
	StringKey (const StringKey &copytron)
StringKey &	operator= (const StringKey &copytron)
virtual bool	cryptic () const override
virtual void	setCryptic (bool val) override
virtual int	seconds () const override
virtual void	setSeconds (int val) override
virtual int	milliseconds () const override
virtual void	setMilliseconds (int val) override
virtual String	text () const override
virtual void	setText (const String &val) override
virtual int	compare (const IDataMember &rhs) const override
virtual int	compare (const StringKey &rhs) const
virtual void	copy (const IDataMember *copytron) override
virtual const char *	name () const override
virtual size_t	addNameCount () const override
virtual void	addNames (const char **bufferOut, size_t bufferLength) const override
virtual void	send (mcr_Signal *signalPt) override
Public Member Functions inherited from mcr::ISignalMember
bool	operator== (const ISignalMember &rhs)
bool	operator< (const ISignalMember &rhs)
bool	operator> (const ISignalMember &rhs)
void	operator() (mcr_Signal *signalPt=nullptr)
Public Member Functions inherited from mcr::IDataMember
bool	operator== (const IDataMember &rhs)
bool	operator< (const IDataMember &rhs)
bool	operator> (const IDataMember &rhs)

Static Public Member Functions
static void	setKeyProvider (IKeyProvider *provider)

Public Attributes
mcr_NoOp	interval
SafeString	string

Detailed Description

Turn a text string into a set of signals, such as a key press

Definition at line 48 of file string_key.h.

Member Function Documentation

addNameCount()

virtual size_t mcr::StringKey::addNameCount ( ) const

inlineoverridevirtual

opt mcr_Interface_add_names

Reimplemented from mcr::IDataMember.

Definition at line 135 of file string_key.h.

addNames()

virtual void mcr::StringKey::addNames ( const char **  , size_t    ) const

inlineoverridevirtual

opt mcr_Interface_add_names

Reimplemented from mcr::IDataMember.

Definition at line 139 of file string_key.h.

compare() [1/2]

virtual int mcr::StringKey::compare ( const IDataMember &  rhs ) const

inlineoverridevirtual

mcr_Signal_compare

Implements mcr::IDataMember.

Definition at line 120 of file string_key.h.

compare() [2/2]

virtual int mcr::StringKey::compare ( const StringKey &  rhs ) const

virtual

mcr_Signal_compare

copy()

virtual void mcr::StringKey::copy ( const IDataMember *  copytron )

overridevirtual

mcr_Signal_copy

Parameters

copytron

opt

Implements mcr::IDataMember.

name()

virtual const char* mcr::StringKey::name ( ) const

inlineoverridevirtual

mcr_ISignal_set_name

Implements mcr::IDataMember.

Definition at line 131 of file string_key.h.

send()

virtual void mcr::StringKey::send ( mcr_Signal *  signalPt )

overridevirtual

mcr_send

Implements mcr::ISignalMember.

setText()

virtual void mcr::StringKey::setText ( const String &  val )

inlineoverridevirtual

Set the string to turn into signals

Implements mcr::IStringKey.

Definition at line 114 of file string_key.h.

text()

virtual String mcr::StringKey::text ( ) const

inlineoverridevirtual

Set of characters to turn into signals

Implements mcr::IStringKey.

Definition at line 109 of file string_key.h.

Member Data Documentation

interval

mcr_NoOp mcr::StringKey::interval

Pause in-between characters

Definition at line 52 of file string_key.h.

string

SafeString mcr::StringKey::string

Set of characters to turn into signals

Definition at line 54 of file string_key.h.

---

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

• mcr/extras/signals/string_key.h