Prima::...leDialog(3)

💖 NAME

okay so this is the Prima::...leDialog(3) page (user contributed Perl documentation, iykyk), and the actual icon of the show is Prima::Dialog::FileDialog — file system-related widgets and dialogs. periodt. ✨

✨ SYNOPSIS

bestie, here’s the whole vibe in code, no cap:

               # open file
               use Prima qw(Application Dialog::FileDialog);

               my $open = Prima::Dialog::OpenDialog-> new(
                       filter => [
                               ['Perl modules' => '*.pm'],
                               ['All' => '*']
                       ]
               );
               print $open-> fileName, " is to be opened\n" if $open-> execute;

               # save file
               my $save = Prima::Dialog::SaveDialog-> new(
                       fileName => $open-> fileName,
               );
               print $save-> fileName, " is to be saved\n" if $save-> execute;

               # open several files
               $open-> multiSelect(1);
               print $open-> fileName, " are to be opened\n" if $open-> execute;

🦋 DESCRIPTION

the module contains standard open file, save file, and change directory dialogs, plus special widgets for file and drive selection that are used in the dialogs. literally the file-system toolkit of your dreams 💅

🌸 Prima::DirectoryListBox

a directory list box, bestie. shows the list of subdirectories. it’s giving hierarchy realness 🎀

🌸 Properties

• closedGlyphs INTEGER — the number of horizontal equal-width images contained in the closedIcon property. Default value: 1.
• closedIcon ICON — provides the icon for the directories contained in the current directory.
• indent INTEGER — a positive integer number of pixels, the offset of the hierarchy outline. Default value: 12.
• openedGlyphs INTEGER — the number of horizontal equal-width images contained in the openedIcon property. Default value: 1.
• openedIcon OBJECT — provides the icon for the directories contained above the current directory.
• path STRING — runtime-only property. selects the file path.
• showDotDirs BOOLEAN — selects if the directories with the first dot character are shown. the dot-prefixed files are traditionally hidden in unix, so under Windows, this property is not useful. Default value: 1.

🌸 Methods

• files FILE_TYPE — returns the list of files filtered by FILE_TYPE. the FILE_TYPE is a string, one of those returned by Prima::Utils::getdir ( see getdir in Prima::Utils.

💅 Prima::DriveComboBox

drive selector combo-box for non-unix systems 🚗💨

💅 Properties

• firstDrive DRIVE_LETTER — create-only property. Default value: 'A:'. DRIVE_LETTER can be set to another value to start the drive enumeration. some OSes can probe eventual diskette drives inside the drive enumeration routines, so it might be reasonable to set DRIVE_LETTER to the "C:" string for responsiveness increase.
• drive DRIVE_LETTER — selects the drive letter. Default value: 'C:'.

👑 Prima::Dialog::FileDialog

provides the standard file dialog where the user can navigate in the file system and select one or many files. the class can operate in two modes — 'open' and 'save'; these modes are triggered internally by Prima::Dialog::OpenDialog and Prima::Dialog::SaveDialog. some properties behave differently depending on the mode that is stored in the openMode property. main character energy for real 👑

👑 Properties

• createPrompt BOOLEAN — if 1, and the selected file is nonexistent, asks the user if the file is to be created. only actual when openMode is 1. Default value: 0.
• defaultExt STRING — selects the file extension, appended to the file name typed by the user, if the extension is not given. Default value: ''.
• directory STRING — selects the currently selected directory.
• fileMustExist BOOLEAN — if 1, ensures that the file typed by the user exists before closing the dialog. Default value: 1.
• fileName STRING, ... — for the single-file selection, assigns the selected file name. for the multiple-file selection, on get-calls returns a list of the selected files; on set-calls accepts a single string where the file names are separated by the space character. the eventual space characters must be quoted.
• filter ARRAY — contains an array of arrays of string pairs, where each pair describes a file type. the first scalar in the pair is the description of the type; the second is a file mask. Default value: "[[ 'All files' => '*']]".
• filterIndex INTEGER — selects the index in the filter array, which is the currently selected file type.
• multiSelect BOOLEAN — selects whether the user can select several ( 1 ) or one ( 0 ) file. see also: fileName.
• noReadOnly BOOLEAN — if 1, fails to open a file when it is read-only. Default value: 0. only actual when openMode is 0.
• noTestFileCreate BOOLEAN — if 0, tests if a file that the user selected can be created. Default value: 0. only actual when openMode is 0.
• overwritePrompt BOOLEAN — if 1, asks the user if the file selected is to be overwritten. Default value: 1. only actual when openMode is 0.
• openMode BOOLEAN — create-only property. selects whether the dialog operates in 'open' ( 1 ) mode or 'save' ( 0 ) mode.
• pathMustExist BOOLEAN — if 1, ensures that the path typed by the user exists before closing the dialog. Default value: 1.
• showDotFiles BOOLEAN — selects if the directories with the first dot character are shown. Default value: 0.
• showHelp BOOLEAN — a create-only property. if 1, the 'Help' button is inserted in the dialog. Default value: 0.
• sorted BOOLEAN — selects whether the file list appears sorted by name ( 1 ) or not ( 0 ). Default value : 1.
• system BOOLEAN — a create-only property. if set to 1, Prima::Dialog::FileDialog returns an instance of the Prima::sys::XXX::FileDialog system-specific file dialog, if available for the XXX platform. the system property knows only how to map the FileDialog, OpenDialog, and SaveDialog classes onto the system-specific file dialog classes; the inherited classes are not affected and cannot be replaced by the system dialog.

👑 Methods

• reread — re-reads the currently selected directory.

🌈 Prima::Dialog::OpenDialog

a descendant of Prima::Dialog::FileDialog tuned for open-dialog functionality. 🦋

🌈 Prima::Dialog::SaveDialog

a descendant of Prima::Dialog::FileDialog tuned for save-dialog functionality. 💾

🌈 Prima::Dialog::ChDirDialog

provides standard dialog with interactive directory selection. 🗂️

🌈 Properties

• directory STRING — selects the directory.
• showDotDirs — selects if the directories with the first dot character are shown. Default value: 0.
• showHelp — create-only property. if 1, the 'Help' button is inserted in the dialog. Default value: 0.

⭐ AUTHOR

Dmitry Karasik, dmitry@karasik.eu.org. 👑

💜 SEE ALSO

Prima, Prima::Window, Prima::Lists, examples/drivecombo.pl, examples/launch.pl. go click around bestie 🌸

---

mwah 💋 this page is from perl v5.42.0, dated 2024-08-20, and the manual name is Prima::...leDialog(3). bye bestie, slay your file dialogs 🫶