Prima::EditDialog(3)

NAME

Prima::FindDialog, Prima::ReplaceDialog - standard interface dialogs to find and replace options selection.

SYNOPSIS

use Prima::StdDlg;

my $dlg = Prima::FindDialog-> create( findStyle => 0);
my $res = $dlg-> execute;
if ( $res == mb::Ok) {
        print $dlg-> findText, " is to be found\n";
} elsif ( $res == mb::ChangeAll) {
        print "all occurences of ", $dlg-> findText,
                " is to be replaced by ", $dlg-> replaceText;
}

The "mb::ChangeAll" constant, one of possible results of "execute"
method, is defined in Prima::StdDlg module. Therefore it is recommended
to include this module instead.

DESCRIPTION

The module provides two classes - Prima::FindDialog and
Prima::ReplaceDialog; Prima::ReplaceDialog is exactly same as
Prima::FindDialog except that its default findStyle property value is
set to 0. One can use a dialog-caching technique, arbitrating between
findStyle value 0 and 1, and use only one instance of
Prima::FindDialog.

The module does not provide the actual search algorithm; this must be
implemented by the programmer. The toolkit currently include some
facilitation to the problem - the part of algorithm for "Prima::Edit"
class is found in "find" in Prima::Edit, and the another part - in
examples/editor.pl example program. Prima::HelpWindow also uses the module, and realizes its own searching algorithm.

API

Properties
All the properties select the user-assigned values, except findStyle.
findText STRING
Selects the text string to be found.
Default value: ''
findStyle BOOLEAN
If 1, the dialog provides only 'find text' interface. If 0, the
dialog provides also 'replace text' interface.
Default value: 1 for "Prima::FindDialog", 0 for
"Prima::ReplaceDialog".
options INTEGER
Combination of "fdo::" constants. For the detailed description see "find" in Prima::Edit.

fdo::MatchCase
fdo::WordsOnly
fdo::RegularExpression
fdo::BackwardSearch
fdo::ReplacePrompt
Default value: 0
replaceText STRING
Selects the text string that is to replace the found text.
Default value: ''
scope
One of "fds::" constants. Represents the scope of the search: it
can be started from the cursor position, of from the top or of the bottom of the text.

fds::Cursor
fds::Top
fds::Bottom
Default value: "fds::Cursor"

AUTHOR

Dmitry Karasik, <dmitry@karasik.eu.org>.

SEE ALSO

Prima, Prima::Window, Prima::StdDlg, Prima::Edit, Prima::HelpWindow,
examples/editor.pl
Copyright © 2010-2025 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout