Mellinger: /* Properties */

2008-09-11T17:28:57Z

Properties

← Older revision		Revision as of 17:28, 11 September 2008
Line 32:		Line 32:
	Will enter the text contained in the <tt>EntryText</tt> property into the speller specified when creating the object.		Will enter the text contained in the <tt>EntryText</tt> property into the speller specified when creating the object.
	===Properties===		===Properties===
	~~====string EntryText (rw)====~~		{{SpellerTargetProperties}}
	~~The text entered into the speller object when the target is selected.~~

	==See also==		==See also==

Mellinger at 17:19, 11 September 2008

2008-09-11T17:19:08Z

New page

==Location==
<tt>src/shared/modules/application/speller</tt>

==Synopsis==
The <tt>Speller</tt> class provides an abstract interface for "Spellers". A "Speller" is an object that responds to an ''OnEnter'' event, and holds a set of <tt>SpellerTarget</tt> objects. Holding a set of <tt>SpellerTarget</tt> objects allows to suggest a "next target" based on a desired text output, and an existing text output.

A <tt>SpellerTarget</tt> is a [[Programming Reference:Target Class|<tt>Target</tt>]] that is linked to a <tt>Speller</tt> such that selecting the target results in entering text into the speller.

==Speller Class==
===Methods===
====Enter(string)====
Prompts the speller to react to the information provided in the argument string. The <tt>Speller</tt> class interface makes no assumption about the encoding used, i.e. it does not interpret the argument string in any way.
====Add(SpellerTarget pointer)====
Adds the specified <tt>SpellerTarget</tt> to the speller's set of targets.
====Remove(SpellerTarget pointer)====
Removes the specified <tt>SpellerTarget</tt> from the speller's set of targets.
====DeleteObjects()====
Deletes all <tt>SpellerTarget</tt> objects that are part of the speller's set of targets.
====SpellerTarget pointer SuggestTarget(string from, string to)====
Returns a pointer to a target from the speller object's set of targets. The suggested target is chosen such that it minimizes the string distance between the modified "from" argument to the "to" argument after application of the target's entry text.
This is a virtual function, and should be overridden by spellers that use encoded commands in targets' entry texts.

===Events===
====OnEnter(string)====
In its <tt>OnEnter</tt> event handler, a <tt>Speller</tt> descendant should perform actions that correspond to entering the text given as an argument.

==SpellerTarget Class==
===Methods===
====SpellerTarget(Speller)====
When constructing a speller target, specify the <tt>Speller</tt> object it is associated with. The <tt>SpellerTarget</tt> object will add itself to the <tt>Speller</tt> object's set of targets, and may be deleted using <tt>Speller::DeleteObjects()</tt> when appropriate.
====Select()====
Will enter the text contained in the <tt>EntryText</tt> property into the speller specified when creating the object.
===Properties===
====string EntryText (rw)====
The text entered into the speller object when the target is selected.

==See also==
[[Programming Reference:Target Class]], [[Programming Reference:SpellerCommand Class]]

[[Category:Framework API]][[Category:Development]]

Programming Reference:Speller Class - Revision history

Mellinger: /* Properties */

Mellinger at 17:19, 11 September 2008