FormIt::Forge::UI API

Description

Classes
struct	FormIt::Forge::UI::Message
	More...

Functions
FORMIT_CORE_EXPORT FormIt::Forge::UI::Message	FormIt::Forge::UI::ErrorCodeToUIMessage (const FormIt::Forge::ErrorCode &code)
	Forge ErrorCode to UI Message. More...
FORMIT_CORE_EXPORT const FormIt::Forge::UI::Message	FormIt::Forge::UI::ConstructMessageWithReason (const FormIt::Forge::ErrorCode &topic, const FormIt::Forge::ErrorCode &reason)
	Constructs message compound by a main topic (at the top) and a reason (at the bottom). More...
FORMIT_CORE_EXPORT const FormIt::Forge::UI::Message	FormIt::Forge::UI::ConstructMessage (const FormIt::Forge::ErrorCode &code)
	Constructs message. More...
FORMIT_CORE_EXPORT::string	FormIt::Forge::UI::ConstructMessageWithHyperlink (const FormIt::Forge::UI::Message &msg)
	Constructs message, concatenating the "label" (sentence that has an hyperlink) at the end of the message. More...
FORMIT_CORE_EXPORT void	FormIt::Forge::UI::AddSupportedFilesInMessage (FormIt::Forge::UI::Message &msg)
	Adds into the message with code = ReceiveEmptyFileList the supported file types. More...

Function Documentation

FORMIT_CORE_EXPORT void FormIt::Forge::UI::AddSupportedFilesInMessage

(

FormIt::Forge::UI::Message &

msg

)

Adds into the message with code = ReceiveEmptyFileList the supported file types.

Parameters

msg	Message where to add the supported files

FORMIT_CORE_EXPORT const FormIt::Forge::UI::Message FormIt::Forge::UI::ConstructMessage

(

const FormIt::Forge::ErrorCode &

code

)

Constructs message.

Parameters

code	Topic of the message to construct

FORMIT_CORE_EXPORT ::string FormIt::Forge::UI::ConstructMessageWithHyperlink

(

const FormIt::Forge::UI::Message &

msg

)

Constructs message, concatenating the "label" (sentence that has an hyperlink) at the end of the message.

Parameters

msg	Message to construct

FORMIT_CORE_EXPORT const FormIt::Forge::UI::Message FormIt::Forge::UI::ConstructMessageWithReason	(	const FormIt::Forge::ErrorCode &	topic,
		const FormIt::Forge::ErrorCode &	reason
	)

Constructs message compound by a main topic (at the top) and a reason (at the bottom).

Parameters

topic	Main topic of the message (Eg: FormIt::Forge::ErrorCode::FileSaveFailed).
reason	Reason related to message's topic (Eg: FormIt::Forge::ErrorCode::ConnectionError).

FORMIT_CORE_EXPORT FormIt::Forge::UI::Message FormIt::Forge::UI::ErrorCodeToUIMessage

(

const FormIt::Forge::ErrorCode &

code

)

Forge ErrorCode to UI Message.

Converts FormIt::Forge::ErrorCode to a FormIt::Forge::UI::Message

Parameters

code	Error code to convert