OpenFileDialog component.
More...
#include <openfiledialog.h>
List of all members.
Detailed Description
OpenFileDialog component.
Constructor & Destructor Documentation
Constructs an open file dialog.
- Parameters:
-
| owner | = Owning GUIComponent |
virtual CL_OpenFileDialog::~CL_OpenFileDialog |
( |
|
) |
[virtual] |
Member Function Documentation
void CL_OpenFileDialog::add_filter |
( |
const CL_String & |
filter_description, |
|
|
const CL_String & |
filter_extension, |
|
|
bool |
is_default = false | |
|
) |
| | |
Add a filter that determines what types of files are displayed.
- Parameters:
-
| filter_description | = filter_description |
| filter_extension | = filter_extension |
| is_default | = is_default |
void CL_OpenFileDialog::clear_filters |
( |
|
) |
|
CL_String CL_OpenFileDialog::get_filename |
( |
|
) |
const |
Get the full path of the file selected.
If multiple files are selected, this returns the first file.
- Returns:
- CL_String
std::vector<CL_String> CL_OpenFileDialog::get_filenames |
( |
|
) |
const |
Gets an array that contains one file name for each selected file.
- Returns:
- std::vector<CL_String>
void CL_OpenFileDialog::set_filename |
( |
const CL_String & |
filename |
) |
|
Sets a string containing the full path of the file selected.
- Parameters:
-
void CL_OpenFileDialog::set_filter_index |
( |
int |
filter_index |
) |
|
Sets a default filter, on a 0-based index.
- Parameters:
-
| filter_index | = filter_index |
void CL_OpenFileDialog::set_initial_directory |
( |
const CL_String & |
path |
) |
|
Sets the initial directory that is displayed.
- Parameters:
-
void CL_OpenFileDialog::set_multi_select |
( |
bool |
multiselect |
) |
|
Sets if multiple files can be selected or not.
- Parameters:
-
| multiselect | = When true, multiple items can be selected. |
void CL_OpenFileDialog::set_title |
( |
const CL_String & |
title |
) |
|
Sets the text that appears in the title bar.
- Parameters:
-
bool CL_OpenFileDialog::show |
( |
|
) |
|
Shows the file dialog.
- Returns:
- true if the user clicks the OK button of the dialog that is displayed, false otherwise.
The documentation for this class was generated from the following file: