PCL
Public Types | Public Member Functions | List of all members
pcl::FileDialog Class Referenceabstract

Abstract base class of PCL file dialogs. More...

#include <FileDialog.h>

+ Inheritance diagram for pcl::FileDialog:

Public Types

using filter_list = Array< FileFilter >
 

Public Member Functions

 FileDialog ()
 
virtual ~FileDialog ()
 
void AddFilter (const FileFilter &filter)
 
void AddFilters (const filter_list &filters)
 
String Caption () const
 
virtual bool Execute ()=0
 
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 &)
 

Detailed Description

TODO: Write a detailed description for FileDialog.

See also
GetDirectoryDialog, OpenFileDialog, SaveFileDialog, FileFilter

Definition at line 193 of file FileDialog.h.

Member Typedef Documentation

◆ filter_list

using pcl::FileDialog::filter_list = Array<FileFilter>

A list of file filters describing file types and their associated file extensions.

Definition at line 201 of file FileDialog.h.

Constructor & Destructor Documentation

◆ FileDialog()

pcl::FileDialog::FileDialog ( )

Constructs a FileDialog object.

◆ ~FileDialog()

virtual pcl::FileDialog::~FileDialog ( )
virtual

Virtual destructor.

Member Function Documentation

◆ AddFilter()

void pcl::FileDialog::AddFilter ( const FileFilter &  filter)
inline

Adds a file filter to the list of filters used by this file dialog.

Definition at line 268 of file FileDialog.h.

◆ AddFilters()

void pcl::FileDialog::AddFilters ( const filter_list &  filters)

Adds a set of file filters to the list of filters used by this file dialog.

◆ Caption()

String pcl::FileDialog::Caption ( ) const

Returns the caption of this file dialog.

◆ Execute()

virtual bool pcl::FileDialog::Execute ( )
pure virtual

Modal dialog execution.

Returns true if the dialog has been accepted; false if the dialog has been cancelled.

Implemented in pcl::GetDirectoryDialog, pcl::SaveFileDialog, and pcl::OpenFileDialog.

◆ Filters() [1/2]

filter_list& pcl::FileDialog::Filters ( )

Returns a reference to the mutable list of file filters in this file dialog.

Deprecated:
This member function has been deprecated. It is kept just to support existing code and must not be used in newly produced code. Use SetFilters() instead of this function.

◆ Filters() [2/2]

const filter_list& pcl::FileDialog::Filters ( ) const

Returns a reference to the immutable list of file filters in this file dialog.

◆ InitialPath()

String pcl::FileDialog::InitialPath ( ) const

Returns the initial path for this file dialog.

If not empty, the initial directory is selected upon dialog execution. If the initial path points to a file, that file is set as the initial dialog selection, if appropriate.

◆ SelectedFileExtension()

String pcl::FileDialog::SelectedFileExtension ( ) const

Returns the selected file extension in this file dialog.

If not empty, a file filter containing the specified file extension will be selected upon dialog execution. After an accepted call to Execute(), this property will store the extension of the first selected file.

◆ SetCaption()

void pcl::FileDialog::SetCaption ( const String &  caption)

Sets a new caption for this file dialog. If an empty caption is specified, the platform will assign a default caption depending on the type of dialog: "Open File", "Save File As", and so on.

◆ SetFilter()

void pcl::FileDialog::SetFilter ( const FileFilter &  filter)
inline

Defines a unique file filter to be used by this file dialog.

Definition at line 254 of file FileDialog.h.

◆ SetFilters()

void pcl::FileDialog::SetFilters ( const filter_list &  filters)

Defines the list of file filters to be used by this file dialog.

◆ SetInitialPath()

void pcl::FileDialog::SetInitialPath ( const String &  path)

Sets the initial path for this file dialog. See InitialPath() for a full description.

◆ SetSelectedFileExtension()

void pcl::FileDialog::SetSelectedFileExtension ( const String &  )

Sets the selected file extension for this file dialog. See SelectedFileExtension() for a full description.

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