A function of one argument (the
). It is called when the user presses
, makes a selection from the menu, or clicks the
is not supplied,
is called instead.
A string specifying the initial text of the filter, or
Controls whether the
contains a display-pane (the "matches pane") showing the number of matches. If
is a string, it provides the title of the matches pane, otherwise the title is
. Note that the actual text in the matches pane must be set by the caller by
The main part of a filtering layout is a text-input-pane which allows the user to enter a string. The string is used for filtering. The user can control how it is used by a menu that allows her to specify whether:
To actually do the filtering, the using code needs to call filtering-layout-match-object-and-exclude-p, which returns as multiple values a precompiled regexp and a flag specifying whether to exclude matches. The regexp should be used to perform the filtering, typically by using
. Note that filtering-layout-match-object-and-exclude-p returns
when there is no string in the text-input-pane, and that even when the filter is set to plain match it is returns a regexp (which matches a plain string).
You supply a
of your interface definition (not its
). The description of a
is set by the
method of the class, and therefore the description cannot be passed as an initarg and should not be manipulated.
returns a "state" object which can be used later to set the state of any
. When setting the state, the value can also be a string or
. A string means setting the filter string to it and making the filtering state be plain string, includes matches, and case-insensitive.
means the same as the empty string.