Base Framework
Public Types | Public Member Functions | List of all members
OpenFileDialog Class Reference

Open file dialog. More...

#include <base/ui/OpenFileDialog.h>

Inherits Dialog.

Public Types

enum  Flag { ALLOW_MULTIPLE = 1, MUST_EXIST = 2 }
 

Public Member Functions

 OpenFileDialog () noexcept
 
unsigned int getFlags () const noexcept
 
void setFlags (unsigned int flags) noexcept
 
const StringgetTitle () const noexcept
 
void setTitle (const String &title) noexcept
 
const StringgetFilename () const noexcept
 
void setFilename (const String &filename) noexcept
 
const Array< String > & getFilenames () const noexcept
 
const StringgetFolder () const noexcept
 
void setFolder (const String &folder) noexcept
 
void setFilter (const String &description, const String &filter) noexcept
 
const Map< String, String > & getFilters () const noexcept
 
void setFilters (const Map< String, String > &filters) noexcept
 
bool execute ()
 
- Public Member Functions inherited from Dialog
virtual ~Dialog () noexcept
 

Detailed Description

Open file dialog.

Open file dialog.

Version
1.0

Member Enumeration Documentation

◆ Flag

Enumerator
ALLOW_MULTIPLE 

Specifies that multi files may be selected.

MUST_EXIST 

Specifies that the selected file(s) must exist.

Constructor & Destructor Documentation

◆ OpenFileDialog()

OpenFileDialog::OpenFileDialog ( )
noexcept

Initializes the open file dialog window.

Member Function Documentation

◆ execute()

bool OpenFileDialog::execute ( )
virtual

Executes the dialog.

Implements Dialog.

◆ getFilename()

const String& OpenFileDialog::getFilename ( ) const
inlinenoexcept

Returns the file name.

◆ getFilenames()

const Array<String>& OpenFileDialog::getFilenames ( ) const
inlinenoexcept

Returns the file names.

◆ getFilters()

const Map<String, String>& OpenFileDialog::getFilters ( ) const
inlinenoexcept

Returns the filters.

◆ getFlags()

unsigned int OpenFileDialog::getFlags ( ) const
inlinenoexcept

Returns the flags.

◆ getFolder()

const String& OpenFileDialog::getFolder ( ) const
inlinenoexcept

Returns the initial folder.

◆ getTitle()

const String& OpenFileDialog::getTitle ( ) const
inlinenoexcept

Returns the title of the dialog window.

◆ setFilename()

void OpenFileDialog::setFilename ( const String filename)
inlinenoexcept

Sets the current file name.

◆ setFilter()

void OpenFileDialog::setFilter ( const String description,
const String filter 
)
noexcept

Sets the filter.

Parameters
descriptionThe filter description.
filterThe filter.

◆ setFilters()

void OpenFileDialog::setFilters ( const Map< String, String > &  filters)
inlinenoexcept

Sets the filters.

◆ setFlags()

void OpenFileDialog::setFlags ( unsigned int  flags)
inlinenoexcept

Sets the flags.

◆ setFolder()

void OpenFileDialog::setFolder ( const String folder)
inlinenoexcept

Sets the initial folder.

◆ setTitle()

void OpenFileDialog::setTitle ( const String title)
inlinenoexcept

Sets the title of the dialog window.