Mellinger at 16:54, 11 September 2008

2008-09-11T16:54:00Z

New page

==Target Class==
===Location===
<tt>src/shared/modules/application/stimuli</tt>

===Synopsis===
The <tt>Target</tt> class is a virtual base class which defines an event handling interface for targets.
There, a "Target" is defined as "an object that performs an action when selected."

A <tt>Target</tt> descendant class will typically override its empty <tt>OnSelect()</tt> event handlers with a function that performs an action.
An application uses the public <tt>Target::Select()</tt> function to control its behavior; this function, in turn, calls the virtual event handler.

The <tt>SetOfTargets</tt> class allows to define sets of targets, and to select all of the targets it contains.

===Properties===
====int Tag (rw)====
An arbitrary integer that may be used to encode information about a given target (e.g., its corresponding row in a configuration matrix).

===Methods===
====Select()====
Prompts a target to perform its selection action by calling its <tt>OnSelect()</tt> event handler.

===Events===
====OnSelect()====
In its <tt>OnSelect</tt> event handler, a target performs an action, e.g. entering a letter into a speller.

===Descendants===
The <tt>Target</tt> class is parent to the [[Programming Reference:Speller Class#SpellerTarget Class|SpellerTarget]] and [[Programming Reference:AudioSpellerTarget Class|AudioSpellerTarget]] classes.

==SetOfTargets Class==
===Location===
<tt>SetOfTargets</tt> is declared in the <tt>Target</tt> class header file.
===Synopsis===
<tt>SetOfTargets</tt> is a helper class that provides selection and destruction of a group of stimuli.
===Methods===
====Add(Target pointer)====
Adds a target object to the set.
====Remove(Target pointer)====
Removes a given target object from the set; nothing happens when the specified target is not a member of the set.
====Clear()====
Clears the set. Targets that were represented in the set in form of pointers are unaffected.
====DeleteObjects()====
Deletes all target objects that are in the set, and clears the set. To avoid dangling pointers, and multiple deletion, you should make sure that the set's members are not part of any other <tt>SetOfTargets</tt> by the time you call <tt>SetOfTargets::DeleteObjects()</tt>.
====bool Contains(Target pointer)====
Returns ''true'' if the specified target object is part of the set, and ''false'' otherwise.
====bool Intersects(SetOfTargets)====
Returns ''true'' if any of the elements of the specified set is part of the set on which <tt>Intersects</tt> is called, and ''false'' otherwise.
====Select()====
Calls each element's <tt>Select()</tt> method.

==See also==
[[Programming Reference:AssociationMap Class]], [[Programming Reference:Stimulus Class]], [[Programming Reference:StimulusTask Class]]

[[Programming Reference:Speller Class]], [[Programming Reference:AudioSpellerTarget Class]]

[[Category:Development]][[Category:Framework API]] [[Category:User Application]]

Programming Reference:Target Class - Revision history

Mellinger at 16:54, 11 September 2008