Unravel Engine C++ Reference
Loading...
Searching...
No Matches
ImBox Namespace Reference

Classes

class  MsgBox
 Individual message box instance. More...
 
struct  MsgBoxConfig
 Configuration for message box appearance and behavior. More...
 
class  MsgBoxManager
 Message box manager for handling multiple popups. More...
 

Enumerations

enum  ModalResult {
  None = 0x0 , Ok = 1 << 0 , Cancel = 1 << 1 , Yes = 1 << 2 ,
  No = 1 << 3 , Abort = 1 << 4 , Retry = 1 << 5 , Ignore = 1 << 6 ,
  YesToAll = 1 << 7 , NoToAll = 1 << 8 , Apply = 1 << 9 , Discard = 1 << 10 ,
  Help = 1 << 11 , Reset = 1 << 12 , Close = 1 << 13 , Save = 1 << 14 ,
  Delete = 1 << 15 , DontSave = 1 << 16 , CancelDelete = 1 << 17
}
 Modal result flags for message box buttons. More...
 
enum class  MessageType {
  Info , Warning , Error , Success ,
  Question , Custom
}
 Message box types that determine appearance and icon. More...
 
enum class  AnimationState { Opening , Open , Closing , Closed }
 Animation state for smooth transitions. More...
 

Functions

auto ShowInfo (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show an information message box.
 
auto ShowWarning (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show a warning message box.
 
auto ShowError (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show an error message box.
 
auto ShowSuccess (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show a success message box.
 
auto ShowQuestion (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show a question message box with Yes/No buttons.
 
auto ShowConfirmation (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr, MessageType type=MessageType::Question) -> std::shared_ptr< MsgBox >
 Show a confirmation dialog with OK/Cancel buttons.
 
auto ShowSaveConfirmation (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show a save confirmation dialog with Save/Don't Save/Cancel buttons.
 
auto ShowDeleteConfirmation (const std::string &title, const std::string &message, std::function< void(ModalResult)> callback=nullptr) -> std::shared_ptr< MsgBox >
 Show a delete confirmation dialog with Delete/Cancel buttons.
 
auto RenderMessageBoxes () -> void
 Render all message boxes (call this in your main render loop)
 
auto IsConfirmation (ModalResult result) -> bool
 

Enumeration Type Documentation

◆ AnimationState

enum class ImBox::AnimationState
strong

Animation state for smooth transitions.

Enumerator
Opening 
Open 
Closing 
Closed 

Definition at line 53 of file imgui_messagebox.h.

◆ MessageType

enum class ImBox::MessageType
strong

Message box types that determine appearance and icon.

Enumerator
Info 
Warning 
Error 
Success 
Question 
Custom 

Definition at line 42 of file imgui_messagebox.h.

◆ ModalResult

Modal result flags for message box buttons.

Enumerator
None 
Ok 
Cancel 
Yes 
No 
Abort 
Retry 
Ignore 
YesToAll 
NoToAll 
Apply 
Discard 
Help 
Reset 
Close 
Save 
Delete 
DontSave 
CancelDelete 

Definition at line 13 of file imgui_messagebox.h.

Function Documentation

◆ IsConfirmation()

auto ImBox::IsConfirmation ( ModalResult result) -> bool
inline

Definition at line 36 of file imgui_messagebox.h.

◆ RenderMessageBoxes()

auto ImBox::RenderMessageBoxes ( ) -> void

Render all message boxes (call this in your main render loop)

Definition at line 501 of file imgui_messagebox.cpp.

◆ ShowConfirmation()

auto ImBox::ShowConfirmation ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback,
MessageType type ) -> std::shared_ptr< MsgBox >

Show a confirmation dialog with OK/Cancel buttons.

Definition at line 472 of file imgui_messagebox.cpp.

◆ ShowDeleteConfirmation()

auto ImBox::ShowDeleteConfirmation ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show a delete confirmation dialog with Delete/Cancel buttons.

Definition at line 492 of file imgui_messagebox.cpp.

◆ ShowError()

auto ImBox::ShowError ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show an error message box.

Definition at line 447 of file imgui_messagebox.cpp.

◆ ShowInfo()

auto ImBox::ShowInfo ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show an information message box.

Definition at line 431 of file imgui_messagebox.cpp.

◆ ShowQuestion()

auto ImBox::ShowQuestion ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show a question message box with Yes/No buttons.

Definition at line 463 of file imgui_messagebox.cpp.

◆ ShowSaveConfirmation()

auto ImBox::ShowSaveConfirmation ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show a save confirmation dialog with Save/Don't Save/Cancel buttons.

Definition at line 482 of file imgui_messagebox.cpp.

◆ ShowSuccess()

auto ImBox::ShowSuccess ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show a success message box.

Definition at line 455 of file imgui_messagebox.cpp.

◆ ShowWarning()

auto ImBox::ShowWarning ( const std::string & title,
const std::string & message,
std::function< void(ModalResult)> callback ) -> std::shared_ptr< MsgBox >

Show a warning message box.

Definition at line 439 of file imgui_messagebox.cpp.