x::w::file_dialog_config Struct Reference

The configuration of a file dialog. More...

#include <file_dialog_config.H>

Public Member Functions
	file_dialog_config (const functionref< void(THREAD_CALLBACK, const file_dialog &d, const std::string &, const busy &)> &ok_action, const ok_cancel_dialog_callback_t &cancel_action, file_dialog_type type=file_dialog_type::existing_file)
	Constructor.
	~file_dialog_config ()
	Destructor.
	file_dialog_config (const file_dialog_config &)
	Copy constructor.
file_dialog_config &	operator= (const file_dialog_config &)
	Assignment operator.

Public Attributes
functionref< void(THREAD_CALLBACK, const file_dialog &, const std::string &, const busy &)>	ok_action
	A particular file was selected by the dialog.
ok_cancel_dialog_callback_t	cancel_action
	The dialog was canceled.
file_dialog_type	type =file_dialog_type::existing_file
	File dialog's semantics.
std::string	initial_directory
	Initial directory displayed in the file dialog.
std::vector< std::tuple< text_param, std::string > >	filename_filters
	Filename filters.
size_t	initial_filename_filter =0
	Initial filename filter index.
std::string	access_denied_message
	Message shown when access to the file is denied.
std::string	access_denied_title
	Title of the access denied dialog.
const_file_dialog_appearance	appearance
	Apperance of this dialog.

Detailed Description

The configuration of a file dialog.

Parameter to the x::w::main_window's create_fialog_dialog() method.

Constructor & Destructor Documentation

file_dialog_config() [1/2]

x::w::file_dialog_config::file_dialog_config	(	const functionref< void(THREAD_CALLBACK, const file_dialog &d, const std::string &, const busy &)> &	ok_action,
		const ok_cancel_dialog_callback_t &	cancel_action,
		file_dialog_type	type = file_dialog_type::existing_file
	)

Constructor.

~file_dialog_config()

x::w::file_dialog_config::~file_dialog_config

(

)

Destructor.

file_dialog_config() [2/2]

x::w::file_dialog_config::file_dialog_config

(

const file_dialog_config &

)

Copy constructor.

Member Function Documentation

operator=()

file_dialog_config & x::w::file_dialog_config::operator=

(

const file_dialog_config &

)

Assignment operator.

Member Data Documentation

access_denied_message

std::string x::w::file_dialog_config::access_denied_message

Message shown when access to the file is denied.

access_denied_title

std::string x::w::file_dialog_config::access_denied_title

Title of the access denied dialog.

appearance

const_file_dialog_appearance x::w::file_dialog_config::appearance

Apperance of this dialog.

cancel_action

ok_cancel_dialog_callback_t x::w::file_dialog_config::cancel_action

The dialog was canceled.

The cancel button takes care of hiding the dialog, before executing this callback.

filename_filters

std::vector<std::tuple<text_param, std::string> > x::w::file_dialog_config::filename_filters

Filename filters.

A vector of tuples: the label for the filename filter, and the filename filter itself. The filename filter is a regular expression.

initial_directory

std::string x::w::file_dialog_config::initial_directory

Initial directory displayed in the file dialog.

initial_filename_filter

size_t x::w::file_dialog_config::initial_filename_filter =0

Initial filename filter index.

ok_action

functionref<void (THREAD_CALLBACK, const file_dialog &, const std::string &, const busy &)> x::w::file_dialog_config::ok_action

A particular file was selected by the dialog.

The file dialog remains open. It's up to the callback to hide() it.

type

file_dialog_type x::w::file_dialog_config::type =file_dialog_type::existing_file

File dialog's semantics.

---

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

• includes/x/w/file_dialog_config.H