FormIt C++ API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
FormIt::UI Namespace Reference

Classes

struct  ShowNotificationData
 

Functions

FORMIT_CORE_EXPORT FormIt::NotificationHandle ShowNotification (const 1::string &message, NotificationType type, int nTimeout=FormIt::UI::sDefaultNotificationTimeoutMs, LinkCallback linkCallback={})
 Display a notification message to the user.
 
FORMIT_CORE_EXPORT void HandleConfirmationResult (size_t dialogId, bool isConfirming)
 Method to report the result of a confirmation dialog box.
 
enum class  FormItDialogBox { Local = 0 , BIM360Gallery = 1 , BIM360ContentLibrary = 2 , LocalContentLibrary = 3 }
 Choose Dialog where you want the messages to be displayed. More...
 
enum  CursorType {
  kPickArrow = 0 , kPickArrowPlusMinus = 1 , kForbidden = 2 , kCameraOrbit = 3 ,
  kCameraPan = 4 , kCameraSwivel = 5 , kCameraZoom = 6 , kGrip = 7 ,
  kTextEdit = 8 , kNumCursorTypes = 9
}
 Commonly used cursor types. More...
 
using LinkCallback = 1::function< void(1::string, FormIt::NotificationHandle)>
 Callback invoked when a hyperlink is clicked on in a notification dialog.
 

Typedef Documentation

◆ LinkCallback

using FormIt::UI::LinkCallback = typedef 1::function<void(1::string, FormIt::NotificationHandle)>

Callback invoked when a hyperlink is clicked on in a notification dialog.

Currently only works on desktop.

Parameters
arg0Hyperlink target
arg1Handle to the notification containing the hyperlink

Enumeration Type Documentation

◆ CursorType

Commonly used cursor types.

Enumerator
kPickArrow 
kPickArrowPlusMinus 
kForbidden 
kCameraOrbit 
kCameraPan 
kCameraSwivel 
kCameraZoom 
kGrip 
kTextEdit 
kNumCursorTypes 

Keep at end.

◆ FormItDialogBox

enum class FormIt::UI::FormItDialogBox
strong

Choose Dialog where you want the messages to be displayed.

Enumerator
Local 

Refered to Local Open, Save, Export, Import dialogs.

BIM360Gallery 

Refered to BIM 360 Docs Open, Save, Export, Import dialogs.

BIM360ContentLibrary 

Refered to BIM 360 Docs Content Library.

LocalContentLibrary 

Refered to Local Content Library.