SDL::MessageBox Struct Reference

MessageBox structure containing title, text, window, etc. More...

Inheritance diagram for SDL::MessageBox:

Collaboration diagram for SDL::MessageBox:

Public Member Functions
constexpr	MessageBox (const MessageBoxRaw &messageBox={}) noexcept
	Wraps MessageBox. More...
constexpr	MessageBox (MessageBoxFlags flags, WindowParam window, const char *title, const char *message, std::span< const MessageBoxButtonData > buttons, OptionalRef< const MessageBoxColorScheme > colorScheme) noexcept
	Constructs from its fields. More...
constexpr MessageBoxFlags	GetFlags () const noexcept
	Get the flags. More...
constexpr MessageBox &	SetFlags (MessageBoxFlags newFlags) noexcept
	Set the flags. More...
constexpr WindowRef	GetWindow () const noexcept
	Get the window. More...
constexpr MessageBox &	SetWindow (WindowParam newWindow) noexcept
	Set the window. More...
constexpr const char *	GetTitle () const noexcept
	Get the title. More...
constexpr MessageBox &	SetTitle (const char *newTitle) noexcept
	Set the title. More...
constexpr const char *	GetMessage () const noexcept
	Get the message. More...
constexpr MessageBox &	SetMessage (const char *newMessage) noexcept
	Set the message. More...
constexpr int	GetNumbuttons () const noexcept
	Get the numbuttons. More...
constexpr MessageBox &	SetNumbuttons (int newNumbuttons) noexcept
	Set the numbuttons. More...
constexpr std::span< const MessageBoxButtonData >	GetButtons () const noexcept
	Get the buttons. More...
constexpr MessageBox &	SetButtons (std::span< const MessageBoxButtonData > newButtons) noexcept
	Set the buttons. More...
constexpr const MessageBoxColorScheme *	GetColorScheme () const noexcept
	Get the colorScheme. More...
constexpr MessageBox &	SetColorScheme (OptionalRef< const MessageBoxColorScheme > newColorScheme) noexcept
	Set the colorScheme. More...
void	Show (int *buttonid) const
	Create a modal message box. More...

Detailed Description

Since

This struct is available since SDL 3.2.0.

Constructor & Destructor Documentation

MessageBox() [1/2]

constexpr SDL::MessageBox::MessageBox ( const MessageBoxRaw &  messageBox = {} )

inlineconstexprnoexcept

Parameters

messageBox

the value to be wrapped

MessageBox() [2/2]

constexpr SDL::MessageBox::MessageBox ( MessageBoxFlags  flags, WindowParam  window, const char *  title, const char *  message, std::span< const MessageBoxButtonData >  buttons, OptionalRef< const MessageBoxColorScheme >  colorScheme  )

inlineconstexprnoexcept

Parameters

flags	the value for flags.
window	the value for window.
title	the value for title.
message	the value for message.
buttons	the value for buttons.
colorScheme	the value for colorScheme.

Member Function Documentation

GetButtons()

constexpr std::span< const MessageBoxButtonData > SDL::MessageBox::GetButtons ( ) const

inlineconstexprnoexcept

Returns

current buttons.

GetColorScheme()

constexpr const MessageBoxColorScheme * SDL::MessageBox::GetColorScheme ( ) const

inlineconstexprnoexcept

Returns

current colorScheme value.

GetFlags()

constexpr MessageBoxFlags SDL::MessageBox::GetFlags ( ) const

inlineconstexprnoexcept

Returns

current flags value.

GetMessage()

constexpr const char * SDL::MessageBox::GetMessage ( ) const

inlineconstexprnoexcept

Returns

current message value.

GetNumbuttons()

constexpr int SDL::MessageBox::GetNumbuttons ( ) const

inlineconstexprnoexcept

Returns

current numbuttons value.

GetTitle()

constexpr const char * SDL::MessageBox::GetTitle ( ) const

inlineconstexprnoexcept

Returns

current title value.

GetWindow()

constexpr WindowRef SDL::MessageBox::GetWindow ( ) const

inlineconstexprnoexcept

Returns

current window value.

SetButtons()

constexpr MessageBox & SDL::MessageBox::SetButtons ( std::span< const MessageBoxButtonData >  newButtons )

inlineconstexprnoexcept

Parameters

newButtons

the new buttons value.

Returns

Reference to self.

SetColorScheme()

constexpr MessageBox & SDL::MessageBox::SetColorScheme ( OptionalRef< const MessageBoxColorScheme >  newColorScheme )

inlineconstexprnoexcept

Parameters

newColorScheme

the new colorScheme value.

Returns

Reference to self.

SetFlags()

constexpr MessageBox & SDL::MessageBox::SetFlags ( MessageBoxFlags  newFlags )

inlineconstexprnoexcept

Parameters

newFlags

the new flags value.

Returns

Reference to self.

SetMessage()

constexpr MessageBox & SDL::MessageBox::SetMessage ( const char *  newMessage )

inlineconstexprnoexcept

Parameters

newMessage

the new message value.

Returns

Reference to self.

SetNumbuttons()

constexpr MessageBox & SDL::MessageBox::SetNumbuttons ( int  newNumbuttons )

inlineconstexprnoexcept

Parameters

newNumbuttons

the new numbuttons value.

Returns

Reference to self.

SetTitle()

constexpr MessageBox & SDL::MessageBox::SetTitle ( const char *  newTitle )

inlineconstexprnoexcept

Parameters

newTitle

the new title value.

Returns

Reference to self.

SetWindow()

constexpr MessageBox & SDL::MessageBox::SetWindow ( WindowParam  newWindow )

inlineconstexprnoexcept

Parameters

newWindow

the new window value.

Returns

Reference to self.

---

The documentation for this struct was generated from the following file:

• SDL3pp/SDL3pp_messagebox.h