FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::UI API

Description

Classes

struct  FormIt::UI::ShowNotificationData
 

Functions

FORMIT_CORE_EXPORT FormIt::NotificationHandle FormIt::UI::ShowNotification (const 1::string &message, NotificationType type, int nTimeout=FormIt::UI::sDefaultNotificationTimeoutMs, LinkCallback linkCallback={})
 Display a notification message to the user. More...
 

Function Documentation

FORMIT_CORE_EXPORT FormIt::NotificationHandle FormIt::UI::ShowNotification ( const 1::string &  message,
NotificationType  type,
int  nTimeout = FormIt::UI::sDefaultNotificationTimeoutMs,
LinkCallback  linkCallback = {} 
)

Display a notification message to the user.

The nTimeout parameter is the time in ms that the notification should be displayed. Use a value of FormIt::UI::sDefaultNotificationTimeoutMs for a default timeout or FormIt::UI::sInfinitNotificationTimeout timeout which requires user to dismiss.

Returns
A handle to the notifiction dialog that can be used to control the dialog via other FormIt APIs
Parameters
[in]message
[in]type
[in]nTimeout
[in]linkCallback