Programming Reference:SpellerCommand Class

From BCI2000 Wiki

Contents 1 Location 2 Synopsis 3 Methods 3.1 SpellerCommand(string) 3.2 ReadFromStream(istream), WriteToStream(ostream) 4 Properties 4.1 string Code (rw) 4.2 string Value (rw) 5 See also

Location

src/shared/modules/application/speller

Synopsis

A SpellerCommand object represents a speller command in parsed form. Speller commands are either plain text, or command keywords and arguments enclosed in angle brackets:

a
Alpha
<UNDO>
<GOTO 3>

Methods

SpellerCommand(string)

Parses the argument string, and initializes the object's properties from there.

ReadFromStream(istream), WriteToStream(ostream)

Reads/writes the object from/into the specified stream objects.

Properties

string Code (rw)

For plain text entry commands, this property is empty. For keyword commands, it contains the keyword, e.g. "GOTO".

string Value (rw)

For plain text entry commands, this property contains the text to enter. For keyword commands, it contains arguments, if any, e.g. "3" for "<GOTO 3>".

See also

Programming Reference:Speller Class, Programming Reference:Target Class, User Reference:P3SpellerTask