Overload  1.1
Game engine with editor
Public Types | Public Member Functions | List of all members
OvWindowing::Dialogs::MessageBox Class Reference

#include <MessageBox.h>

Public Types

enum  EMessageType { EMessageType::QUESTION = 0x00000020L, EMessageType::INFORMATION = 0x00000040L, EMessageType::WARNING = 0x00000030L, EMessageType::ERROR = 0x00000010L }
 
enum  EButtonLayout {
  EButtonLayout::OK = 0x00000000L, EButtonLayout::OK_CANCEL = 0x00000001L, EButtonLayout::YES_NO = 0x00000004L, EButtonLayout::YES_NO_CANCEL = 0x00000003L,
  EButtonLayout::RETRY_CANCEL = 0x00000005L, EButtonLayout::ABORT_RETRY_IGNORE = 0x00000002L, EButtonLayout::CANCEL_TRYAGAIN_CONTINUE = 0x00000006L, EButtonLayout::HELP = 0x00004000L
}
 
enum  EUserAction {
  EUserAction::OK = 1, EUserAction::CANCEL = 2, EUserAction::YES = 6, EUserAction::NO = 7,
  EUserAction::CONTINUE = 11, EUserAction::IGNORE = 5, EUserAction::RETRY = 4, EUserAction::TRYAGAIN = 10
}
 

Public Member Functions

 MessageBox (std::string p_title, std::string p_message, EMessageType p_messageType=EMessageType::INFORMATION, EButtonLayout p_buttonLayout=EButtonLayout::OK, bool p_autoSpawn=true)
 
void Spawn ()
 
const EUserActionGetUserAction () const
 

Detailed Description

Displays a modal dialog box that contains a system icon, a set of buttons, and a brief application-specific message, such as status or error information

Member Enumeration Documentation

◆ EButtonLayout

Defines some button layouts for MessageBox instances

Enumerator
OK 
OK_CANCEL 
YES_NO 
YES_NO_CANCEL 
RETRY_CANCEL 
ABORT_RETRY_IGNORE 
CANCEL_TRYAGAIN_CONTINUE 
HELP 

◆ EMessageType

Defines some severity levels for MessageBox instances

Enumerator
QUESTION 
INFORMATION 
WARNING 
ERROR 

◆ EUserAction

Defines some actions that the MessageBox should provide

Enumerator
OK 
CANCEL 
YES 
NO 
CONTINUE 
IGNORE 
RETRY 
TRYAGAIN 

Constructor & Destructor Documentation

◆ MessageBox()

OvWindowing::Dialogs::MessageBox::MessageBox ( std::string  p_title,
std::string  p_message,
EMessageType  p_messageType = EMessageType::INFORMATION,
EButtonLayout  p_buttonLayout = EButtonLayout::OK,
bool  p_autoSpawn = true 
)

Create the MessageBox

Parameters
p_title
p_message
p_messageType
p_buttonLayout
p_autoSpawn@project: Overload
Author
: Overload Tech. @restrictions: This software may not be resold, redistributed or otherwise conveyed to a third party.

Member Function Documentation

◆ GetUserAction()

const OvWindowing::Dialogs::MessageBox::EUserAction & OvWindowing::Dialogs::MessageBox::GetUserAction ( ) const

Return the user action

◆ Spawn()

void OvWindowing::Dialogs::MessageBox::Spawn ( )

Show the MessageBox on the screen


The documentation for this class was generated from the following files: