FormIt::Files API

Description

Classes
class	FormIt::Files::FileOptionsList
	FormIt::Files::FileOptionsList class. More...

Functions
FORMIT_CORE_EXPORT FormIt::Files::FileOptionsList	FormIt::Files::GetSupportedFilesList (const FormIt::Files::Action &action, const FormIt::Files::ContentType &type, bool useDevFormat=false, const FormIt::UI::FormItDialogBox &dialog=FormIt::UI::FormItDialogBox::Local)
	Get Platform's supported files.
FORMIT_CORE_EXPORT bool	FormIt::Files::IsFileSupported (const 1::string &extension, const FormIt::Files::Action &action, const FormIt::Files::ContentType &type, const FormIt::UI::FormItDialogBox &dialog=FormIt::UI::FormItDialogBox::Local)
	Check if a file extension is supported.
	FormIt::Files::DECL (Json, Types::JSON, "Solid-def file (*.json)", "json")
	xBaseOption class declaration These string are duplicated in the cpp with a TR() for localization.
	FormIt::Files::DECL (Atfx, Types::ATFX, "ATF XML file (*.atfx)", "atfx")
	FormIt::Files::DECL (Wmv, Types::WMV, "WMV Video file (*.wmv)", "wmv")
	FormIt::Files::DECL (Mp4, Types::MP4, "MP4 Video file (*.mp4)", "mp4")

Variables
int	FormIt::Files::m_width
	xImportsOptions classes declaration
int	FormIt::Files::m_height
bool	FormIt::Files::m_doubleSided = false
bool	FormIt::Files::m_isAscii = false
::string	FormIt::Files::m_version = ""
	blank indicates latest version
bool	FormIt::Files::m_withHistory = false

Function Documentation

DECL() [1/4]

FormIt::Files::DECL	(	Atfx	,
		Types::ATFX	,
		"ATF XML file (*.atfx)"	,
		"atfx"
	)

DECL() [2/4]

FormIt::Files::DECL	(	Json	,
		Types::JSON	,
		"Solid-def file (*.json)"	,
		"json"
	)

xBaseOption class declaration These string are duplicated in the cpp with a TR() for localization.

If you add a new file type you need to add it to the cpp file as well. < PngBaseOption

DECL() [3/4]

FormIt::Files::DECL	(	Mp4	,
		Types::MP4	,
		"MP4 Video file (*.mp4)"	,
		"mp4"
	)

DECL() [4/4]

FormIt::Files::DECL	(	Wmv	,
		Types::WMV	,
		"WMV Video file (*.wmv)"	,
		"wmv"
	)

GetSupportedFilesList()

FORMIT_CORE_EXPORT FormIt::Files::FileOptionsList FormIt::Files::GetSupportedFilesList	(	const FormIt::Files::Action &	action,
		const FormIt::Files::ContentType &	type,
		bool	useDevFormat = false,
		const FormIt::UI::FormItDialogBox &	dialog = FormIt::UI::FormItDialogBox::Local
	)

Get Platform's supported files.

Parameters

	action	File action (eg: Load or Save file)
	type	File's content type (eg: 3D Model or Image)
	type	dev format or not
	type	Dialogbox in which we have to show the supported file formats
[in]	useDevFormat
[in]	dialog

IsFileSupported()

FORMIT_CORE_EXPORT bool FormIt::Files::IsFileSupported	(	const 1::string &	extension,
		const FormIt::Files::Action &	action,
		const FormIt::Files::ContentType &	type,
		const FormIt::UI::FormItDialogBox &	dialog = FormIt::UI::FormItDialogBox::Local
	)

Check if a file extension is supported.

Parameters

	extension	File extension to check if is supported
	action	File action (eg: Load or Save file)
	type	File's content type (eg: 3D Model or Image)
[in]	dialog

Variable Documentation

m_doubleSided

bool FormIt::Files::m_doubleSided = false

m_height

int FormIt::Files::m_height

m_isAscii

bool FormIt::Files::m_isAscii = false

m_version

::string FormIt::Files::m_version = ""

blank indicates latest version

m_width

int FormIt::Files::m_width

xImportsOptions classes declaration

< PngImportOptions xExportOptions classes declaration < PngExportOptions

m_withHistory

bool FormIt::Files::m_withHistory = false