1. Manuals
  2. Leap-15.6
  3. perl-Prima
  4. Prima::Dialog::FindDialog(3pm)

Scroll to navigation

Prima::Dialog::FindDialog(3) User Contributed Perl Documentation Prima::Dialog::FindDialog(3)

NAME

Prima::Dialog::FindDialog - wrapper module for Prima::Dialog::FindDialog and Prima::Dialog::ReplaceDialog to find and replace text.

SYNOPSIS

        use Prima qw(Dialog::FindDialog Application);
        my $dlg = Prima::Dialog::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 occurrences of ", $dlg-> findText,
                        " is to be replaced by ", $dlg-> replaceText;
        }

DESCRIPTION

The module provides two classes - Prima::Dialog::FindDialog and Prima::Dialog::ReplaceDialog; Prima::Dialog::ReplaceDialog is exactly same as Prima::Dialog::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::Dialog::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.

Selects the text string to be found.

Default value: ''

If 1, the dialog provides only 'find text' interface. If 0, the dialog provides also 'replace text' interface.

Default value: 1 for "Prima::Dialog::FindDialog", 0 for "Prima::Dialog::ReplaceDialog".

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

Selects the text string that is to replace the found text.

Default value: ''

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::Edit, Prima::HelpWindow, examples/editor.pl

2023-09-05 perl v5.26.1