lecui 1.0.0-alpha.20
lecui C++ user interface library
Public Member Functions | List of all members
liblec::lecui::open_file_params Class Reference

Open 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...
 
open_file_paramstitle (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 open, as defined in file_type. More...
 
const std::vector< file_type > & get_file_types () const
 Get the file types to open, as defined in file_type. More...
 
open_file_paramsfile_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...
 
open_file_paramsdefault_type (const std::string &default_type)
 Set the file type to open by default. More...
 
bool & include_all_supported_types ()
 Get or set whether to include an entry for "all supported file types". More...
 
const bool & get_include_all_supported_types () const
 Get whether to include an entry for "all supported file types". More...
 
open_file_paramsinclude_all_supported_types (const bool &include_all_supported_types)
 Set whether to include an entry for "all supported file types". More...
 
bool & allow_multi_select ()
 Get or set whether to allow the selection of multiple files. More...
 
const bool & get_allow_multi_select () const
 Get whether to allow the selection of multiple files. More...
 
open_file_paramsallow_multi_select (const bool &allow_multi_select)
 Set whether to allow the selection of multiple files. More...
 

Detailed Description

Open file parameters.

Member Function Documentation

◆ allow_multi_select() [1/2]

bool & liblec::lecui::open_file_params::allow_multi_select ( )

Get or set whether to allow the selection of multiple files.

Returns
A reference to the property.

◆ allow_multi_select() [2/2]

open_file_params & liblec::lecui::open_file_params::allow_multi_select ( const bool &  allow_multi_select)

Set whether to allow the selection of multiple files.

Parameters
allow_multi_selectWhether to allow the selection of multiple files.
Returns
A reference to the modified object.

◆ default_type() [1/2]

std::string & liblec::lecui::open_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]

open_file_params & liblec::lecui::open_file_params::default_type ( const std::string &  default_type)

Set the file type to open by default.

Parameters
default_typeThe 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::open_file_params::file_types ( )

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

Returns
A reference to the property.

◆ file_types() [2/2]

open_file_params & liblec::lecui::open_file_params::file_types ( const std::vector< file_type > &  file_types)

Set the file types to open.

Parameters
file_typesThe list of file types to open, as defined in file_type.
Returns
A reference to the modified object.

◆ get_allow_multi_select()

const bool & liblec::lecui::open_file_params::get_allow_multi_select ( ) const

Get whether to allow the selection of multiple files.

Returns
A constant reference to the property.

◆ get_default_type()

const std::string & liblec::lecui::open_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::open_file_params::get_file_types ( ) const

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

Returns
A constant reference to the property.

◆ get_include_all_supported_types()

const bool & liblec::lecui::open_file_params::get_include_all_supported_types ( ) const

Get whether to include an entry for "all supported file types".

Returns
A constant reference to the property.

◆ get_title()

const std::string & liblec::lecui::open_file_params::get_title ( ) const

Get the title of the modal form.

Returns
A constant reference to the property.

◆ include_all_supported_types() [1/2]

bool & liblec::lecui::open_file_params::include_all_supported_types ( )

Get or set whether to include an entry for "all supported file types".

Returns
A reference to the property.

◆ include_all_supported_types() [2/2]

open_file_params & liblec::lecui::open_file_params::include_all_supported_types ( const bool &  include_all_supported_types)

Set whether to include an entry for "all supported file types".

Parameters
include_all_supported_typesWhether to include the entry.
Returns
A reference to the modified object.

◆ title() [1/2]

std::string & liblec::lecui::open_file_params::title ( )

Get or set the title of the modal form.

Returns
A reference to the property.

◆ title() [2/2]

open_file_params & liblec::lecui::open_file_params::title ( const std::string &  title)

Set the title of the modal form.

Parameters
titleThe title of the modal form, e.g. "Open Image".
Returns
A reference to the modified object.

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