C H A P T E R 1 6
Find
Using the Find Service
16-13
Note
The
ROM_SoupFinder
and
ROM_CompatibleFinder
methods
MakeFoundItem
and
AddFoundItem
are internal
methods, which should not be called or overridden under any
circumstances.
circumstances.
Table 16-1
Overview of
ROM_SoupFinder
methods
Method
Description
Override?
Reset
Resets cursor to first found entry. In
general you should use
general you should use
ReSync
to reset
a finder.
No
ZeroOneOrMore
Returns 0 if no found entries, 1 for one
found entry, or other number for more.
found entry, or other number for more.
No
ShowEntry
Causes the finding application to display
entry, which is passed to it as an argument.
Does not close the Find overview.
entry, which is passed to it as an argument.
Does not close the Find overview.
No
SelectItem
Marks the item, passed in as an argument,
as selected. If this method is set to
as selected. If this method is set to
nil
a
checkbox does not appear in front of
the item.
the item.
No
IsSelected
Returns
true
if the item, passed in as an
argument, is selected.
No
ForEachSelected
Calls the callback function, passed in as an
argument, with each selected item. The
function has one argument: the entry from
the cursor.
argument, with each selected item. The
function has one argument: the entry from
the cursor.
No
FileAndMove
File and/or move the selected items. Has
four arguments: labelsChanged, newLabel,
storeChanged, newStore. If labelsChanged
or storeChanged, is
four arguments: labelsChanged, newLabel,
storeChanged, newStore. If labelsChanged
or storeChanged, is
true
newLabel and
newStore indicate the new label and store.
If overridden you must check for selected
items as in
If overridden you must check for selected
items as in
if selected then // do work;
Yes, but
should call
inherited
method to
do work.
should call
inherited
method to
do work.
Delete
Deletes all selected items from
writeable stores.
writeable stores.
Yes, but
crumple
effect still
occurs.
crumple
effect still
occurs.
GetTarget
Returns cursor for routing.
Yes