omni::kit::IAppMessageBox

Defined in omni/kit/IAppMessageBox.h

class IAppMessageBox

Interface for producing an OS-specific modal message box.

Public Functions

virtual MessageBoxResponse show(const char *message, const char *title, MessageBoxType type, MessageBoxButtons buttons) = 0

Shows an OS specific modal message box.

Note

This is a blocking call that will return user response to the message box. The thread that calls it will be blocked until the user presses a button.

Parameters

  • message – The message to display

  • title – The title of the message box

  • type – The MessageBoxType to display

  • buttons – The MessageBoxButtons to present

Returns

A MessageBoxResponse value based on the button that the user pressed, or MessageBoxResponse::eError if an error occurred.

Public Static Functions

static inline constexpr carb::InterfaceDesc getInterfaceDesc() noexcept

Returns information about this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns

The carb::InterfaceDesc struct with information about this interface.

static inline constexpr carb::InterfaceDesc getLatestInterfaceDesc() noexcept

Returns information about the latest version of this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns

The carb::InterfaceDesc struct with information about the latest version of this interface.