FindFileFunction

Represents a request for the user to locate a missing file needed by an IOFactory operation. More...

Collaboration diagram for FindFileFunction:

Public Member Functions
	FindFileFunction (const TranslatedString &title, const TranslatedString &message, const std::function< void(const File &f)> &file)
	Constructs a FindFileFunction with a title, message, and callback for when the file is found.

Public Attributes
std::function< void(const File &f)>	callback
	The callback invoked when the user provides the file.
File	default_file
	The default file path suggestion for the user.
Buffer< FileFormat >	formats
	The acceptable file formats for the missing file.
TranslatedString	message
	The descriptive message explaining which file is needed.
TranslatedString	title
	The title shown to the user when requesting the file.

Detailed Description

Represents a request for the user to locate a missing file needed by an IOFactory operation.

---

When an IOFactory operation encounters a file dependency it cannot resolve, a FindFileFunction is created to prompt the user to locate the missing file. The callback is invoked once the user provides the file.

Definition at line 80 of file IOFactory.h.

Constructor & Destructor Documentation

FindFileFunction()

FindFileFunction::FindFileFunction	(	const TranslatedString &	title,
		const TranslatedString &	message,
		const std::function< void(const File &f)> &	file )

Constructs a FindFileFunction with a title, message, and callback for when the file is found.

---

Parameters

[in]	title	The title or heading shown to the user when requesting the file.
[in]	message	The descriptive message explaining which file is needed and why.
[in]	file	The callback function invoked with the located file.

References message, and title.

---

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

• IOFactory/Headers/IOFactory.h