Prima::...ndDialog(3)

💅 Prima::...ndDialog(3) — Prima::Dialog::FindDialog 💅

okay bestie, welcome to the Prima::...ndDialog(3) page from User Contributed Perl Documentation. this is all about the standard FindDialog and ReplaceDialog for finding and replacing text. no cap, the manual name is folded in right here so we can get to the good stuff 🫶

---

✨ NAME ✨

Prima::Dialog::FindDialog — the standard dialogs FindDialog and ReplaceDialog to find and replace text.

🎀 SYNOPSIS 🎀

use Prima qw(Dialog::FindDialog Application);

my $dlg = Prima::Dialog::FindDialog-> new( 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,
                " are to be replaced by ", $dlg-> replaceText;
}

🦋 DESCRIPTION 🦋

This module gives you two classes: Prima::Dialog::FindDialog and Prima::Dialog::ReplaceDialog. The Prima::Dialog::ReplaceDialog class is exactly the same as Prima::Dialog::FindDialog except that its default findStyle property value is set to 0. You can cache and reuse the dialog object, changing its findStyle value to 0 and 1, so that only one instance of Prima::Dialog::FindDialog is used in the program. iconic behavior, honestly 👑

Important, bestie: this module does not provide the actual search algorithm — that must be implemented by the programmer. The toolkit includes some help: part of the algorithm for the Prima::Edit class is implemented in the Prima::Edit/find method, and another part in the examples/editor.pl example program. The Prima::HelpWindow class also uses the module but implements its own searching algorithm.

🔥 API 🔥

🌸 Properties 🌸

All these properties reflect values that the user can change interactively — except findStyle.

• findText STRING — selects the text string to be found. Default value: ''.
• findStyle BOOLEAN — if 1, the dialog provides only the 'find text' interface. If 0, the dialog provides also the 'replace text' interface. Default value: 1 for Prima::Dialog::FindDialog, 0 for Prima::Dialog::ReplaceDialog.
• options INTEGER — a combination of the fdo:: constants: fdo::MatchCase, fdo::WordsOnly, fdo::RegularExpression, fdo::BackwardSearch, fdo::ReplacePrompt. For the detailed description, see "find" in Prima::Edit. Default value: 0.
• replaceText STRING — selects the text string to replace the found text. Default value: ''.
• scope — one of the fds:: constants: fds::Cursor, fds::Top, fds::Bottom. Represents the scope of the search: it can be started from the cursor position, from the top of the text, or from the bottom. Default value: fds::Cursor.

👑 AUTHOR 👑

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

🫶 SEE ALSO 🫶

Prima, Prima::Window, Prima::Edit, Prima::HelpWindow, examples/editor.pl

---

okay that's the whole page, bestie 💖 it's from perl v5.42.0, dated 2024-08-20, and it's the Prima::...ndDialog(3) page. mwah 💋