A modal dialog box to select one or more existing files. More...
#include <FileDialog.h>
Inheritance diagram for pcl::OpenFileDialog:
Public Member Functions | |
| OpenFileDialog () | |
| ~OpenFileDialog () override | |
| bool | AllowsMultipleSelections () const |
| void | DisableMultipleSelections (bool disable=true) |
| void | EnableMultipleSelections (bool enable=true) |
| bool | Execute () override |
| String | FileName () const |
| const StringList & | FileNames () const |
| void | LoadImageFilters () |
| Public Member Functions inherited from pcl::FileDialog | |
| FileDialog () | |
| virtual | ~FileDialog () |
| void | AddFilter (const FileFilter &filter) |
| void | AddFilters (const filter_list &filters) |
| String | Caption () const |
| filter_list & | Filters () |
| const filter_list & | Filters () const |
| String | InitialPath () const |
| String | SelectedFileExtension () const |
| void | SetCaption (const String &caption) |
| void | SetFilter (const FileFilter &filter) |
| void | SetFilters (const filter_list &filters) |
| void | SetInitialPath (const String &path) |
| void | SetSelectedFileExtension (const String &) |
Additional Inherited Members | |
| Public Types inherited from pcl::FileDialog | |
| using | filter_list = Array< FileFilter > |
Detailed Description
TODO: Write a detailed description for FileDialog.
- See also
- GetDirectoryDialog, FileDialog, SaveFileDialog, FileFilter
Definition at line 321 of file FileDialog.h.
Constructor & Destructor Documentation
◆ OpenFileDialog()
| pcl::OpenFileDialog::OpenFileDialog | ( | ) |
Constructs an OpenFileDialog object.
◆ ~OpenFileDialog()
|
override |
Destroys an OpenFileDialog object.
Member Function Documentation
◆ AllowsMultipleSelections()
| bool pcl::OpenFileDialog::AllowsMultipleSelections | ( | ) | const |
Returns true iff this dialog accepts multiple selections.
When multiple selections are enabled, the user can select a list of one or more existing files. When this mode is disabled, only a single existing file can be selected.
◆ DisableMultipleSelections()
|
inline |
Disables or enables multiple file selections for this dialog.
This is a convenience member function, equivalent to EnableMultipleSelections( !disable ).
Definition at line 377 of file FileDialog.h.
◆ EnableMultipleSelections()
| void pcl::OpenFileDialog::EnableMultipleSelections | ( | bool | enable = true | ) |
Enables or disables multiple file selections for this dialog.
◆ Execute()
|
overridevirtual |
Modal dialog execution.
Returns true if the dialog has been accepted; false if the dialog has been cancelled.
Implements pcl::FileDialog.
◆ FileName()
| String pcl::OpenFileDialog::FileName | ( | ) | const |
Returns the first selected file path.
Use this member function to access a single file name, when multiple selections are disabled, or to the first file name of a multiple selection.
◆ FileNames()
| const StringList& pcl::OpenFileDialog::FileNames | ( | ) | const |
Returns a reference to the list of selected files.
Each element in the returned list is a full path to a selected file.
When multiple selections are enabled, the returned list may contain one or more file paths.
◆ LoadImageFilters()
| void pcl::OpenFileDialog::LoadImageFilters | ( | ) |
Loads a set of file filters corresponding to all installed file formats that are able to read image files.
The set of file filters loaded by this function will depend on the file format modules currently installed on the PixInsight platform. Typically it will include formats like FITS, TIFF, JPEG, JPEG2000, and DSLR RAW. In the unlikely event that no file format able to read files is installed on the platform, the filter set will be empty.
Before the set of format-specific file filters, an additional filter is always included that comprises the whole set of reading-capable formats, i.e. a first "All known formats" filter is always present.
The documentation for this class was generated from the following file:
