pcl::SaveFileDialog Class Reference

A modal dialog box to select a single file name for output. More...

#include <FileDialog.h>

Inheritance diagram for pcl::SaveFileDialog:

Public Member Functions
	SaveFileDialog ()
	~SaveFileDialog () override
void	DisableOverwritePrompt (bool disable=true)
void	EnableOverwritePrompt (bool enable=true)
bool	Execute () override
String	FileName () const
bool	IsOverwritePromptEnabled () 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 SaveFileDialog.

See also

GetDirectoryDialog, OpenFileDialog, FileDialog, FileFilter

Definition at line 420 of file FileDialog.h.

Constructor & Destructor Documentation

SaveFileDialog()

pcl::SaveFileDialog::SaveFileDialog

(

)

Constructs a SaveFileDialog object

~SaveFileDialog()

pcl::SaveFileDialog::~SaveFileDialog ( )

override

Destroys a SaveFileDialog object

Member Function Documentation

DisableOverwritePrompt()

void pcl::SaveFileDialog::DisableOverwritePrompt ( bool  disable = true )

inline

Disables or enables overwrite prompts for this dialog.

This is a convenience member function, equivalent to EnableOverwritePrompt( !disable )

See also

EnableOverwritePrompt(), IsOverwritePromptEnabled()

Definition at line 471 of file FileDialog.h.

EnableOverwritePrompt()

void pcl::SaveFileDialog::EnableOverwritePrompt

(

bool

enable = true

)

Enables or disables overwrite prompts for this dialog.

See also

DisableOverwritePrompt(), IsOverwritePromptEnabled()

Execute()

bool pcl::SaveFileDialog::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::SaveFileDialog::FileName

(

)

const

Returns the selected file path. A full file path is always returned.

IsOverwritePromptEnabled()

bool pcl::SaveFileDialog::IsOverwritePromptEnabled

(

)

const

Returns true iff overwrite prompts are enabled for this dialog.

When overwrite prompts are enabled, the dialog will request confirmation if an existing file is selected.

See also

EnableOverwritePrompt(), DisableOverwritePrompt()

LoadImageFilters()

void pcl::SaveFileDialog::LoadImageFilters

(

)

Loads a set of file filters corresponding to all installed file formats that are able to write 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, and JPEG2000. In the (improbable) event that no file format able to write files is installed on the platform, the filter set will be empty.

---

The documentation for this class was generated from the following file:

• FileDialog.h