liblec::lecui::save_file_params Class Reference

Save file parameters. More...

#include <lecui.h>

Public Member Functions
std::string &	title ()
	Get or set the title of the modal form. More...
const std::string &	get_title () const
	Get the title of the modal form. More...
save_file_params &	title (const std::string &title)
	Set the title of the modal form. More...
std::vector< file_type > &	file_types ()
	Get or set the file types to save to, as defined in file_type. More...
const std::vector< file_type > &	get_file_types () const
	Get the file types to save to, as defined in file_type. More...
save_file_params &	file_types (const std::vector< file_type > &file_types)
	Set the file types to open. More...
std::string &	default_type ()
	Get or set the file type to open by default, e.g. "PNG Image". More...
const std::string &	get_default_type () const
	Get the file type to open by default, e.g. "PNG Image". More...
save_file_params &	default_type (const std::string &default_type)
	Set the file type to open by default. More...
bool &	include_all_files ()
	Get or set whether to include and "all files" entry to allow saving files with a custom extension (or none). More...
const bool &	get_include_all_files () const
	Get whether to include and "all files" entry to allow saving files with a custom extension (or none). More...
save_file_params &	include_all_files (const bool &include_all_files)
	Set whether to include and "all files" entry to allow saving files with a custom extension (or none). More...

Detailed Description

Save file parameters.

Member Function Documentation

default_type() [1/2]

std::string & liblec::lecui::save_file_params::default_type

(

)

Get or set the file type to open by default, e.g. "PNG Image".

Returns

A reference to the property.

The description of the file is used here not the extension, since various extensions can be grouped under one description, e.g. JPG Image can refer to BOTH .jpg and .jpeg.

default_type() [2/2]

save_file_params & liblec::lecui::save_file_params::default_type

(

const std::string &

default_type

)

Set the file type to open by default.

Parameters

default_type

The file type to open by default, e.g. "PNG Image".

Returns

A reference to the modified object.

The description of the file is used here not the extension, since various extensions can be grouped under one description, e.g. JPG Image can refer to BOTH .jpg and .jpeg.

file_types() [1/2]

std::vector< file_type > & liblec::lecui::save_file_params::file_types

(

)

Get or set the file types to save to, as defined in file_type.

Returns

A reference to the property.

file_types() [2/2]

save_file_params & liblec::lecui::save_file_params::file_types

(

const std::vector< file_type > &

file_types

)

Set the file types to open.

Parameters

file_types

The list of file types to save to, as defined in file_type.

Returns

A reference to the modified object.

get_default_type()

const std::string & liblec::lecui::save_file_params::get_default_type

(

)

const

Get the file type to open by default, e.g. "PNG Image".

Returns

A constant reference to the property.

The description of the file is used here not the extension, since various extensions can be grouped under one description, e.g. JPG Image can refer to BOTH .jpg and .jpeg.

get_file_types()

const std::vector< file_type > & liblec::lecui::save_file_params::get_file_types

(

)

const

Get the file types to save to, as defined in file_type.

Returns

A constant reference to the property.

get_include_all_files()

const bool & liblec::lecui::save_file_params::get_include_all_files

(

)

const

Get whether to include and "all files" entry to allow saving files with a custom extension (or none).

Returns

A constant reference to the property.

get_title()

const std::string & liblec::lecui::save_file_params::get_title

(

)

const

Get the title of the modal form.

Returns

A constant reference to the property.

include_all_files() [1/2]

bool & liblec::lecui::save_file_params::include_all_files

(

)

Get or set whether to include and "all files" entry to allow saving files with a custom extension (or none).

Returns

A reference to the property.

include_all_files() [2/2]

save_file_params & liblec::lecui::save_file_params::include_all_files

(

const bool &

include_all_files

)

Set whether to include and "all files" entry to allow saving files with a custom extension (or none).

Parameters

include_all_files

Whether to include the entry.

Returns

A reference to the modified object.

title() [1/2]

std::string & liblec::lecui::save_file_params::title

(

)

Get or set the title of the modal form.

Returns

A reference to the property.

title() [2/2]

save_file_params & liblec::lecui::save_file_params::title

(

const std::string &

title

)

Set the title of the modal form.

Parameters

title

The title of the modal form, e.g. "Save Document".

Returns

A reference to the modified object.

---

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

• lecui.h