SDL::MessageBox Struct Reference

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

Inheritance diagram for SDL::MessageBox:

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

Detailed Description

MessageBox structure containing title, text, window, etc.

Since

This struct is available since SDL 3.2.0.

Constructor & Destructor Documentation

MessageBox() [1/2]

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

inlineconstexprnoexcept

Wraps MessageBox.

Parameters

messageBox

the value to be wrapped

MessageBox() [2/2]

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

inlinenoexcept

Constructs from its fields.

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()

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

inlineconstexprnoexcept

Get the buttons.

Returns

current buttons.

GetColorScheme()

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

inlineconstexprnoexcept

Get the colorScheme.

Returns

current colorScheme value.

GetFlags()

MessageBoxFlags SDL::MessageBox::GetFlags ( ) const

inlineconstexprnoexcept

Get the flags.

Returns

current flags value.

GetMessage()

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

inlineconstexprnoexcept

Get the message.

Returns

current message value.

GetNumbuttons()

int SDL::MessageBox::GetNumbuttons ( ) const

inlineconstexprnoexcept

Get the numbuttons.

Returns

current numbuttons value.

GetTitle()

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

inlineconstexprnoexcept

Get the title.

Returns

current title value.

GetWindow()

WindowRef SDL::MessageBox::GetWindow ( ) const

inlinenoexcept

Get the window.

Returns

current window value.

SetButtons()

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

inlineconstexprnoexcept

Set the buttons.

Parameters

newButtons

the new buttons value.

Returns

Reference to self.

SetColorScheme()

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

inlineconstexprnoexcept

Set the colorScheme.

Parameters

newColorScheme

the new colorScheme value.

Returns

Reference to self.

SetFlags()

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

inlineconstexprnoexcept

Set the flags.

Parameters

newFlags

the new flags value.

Returns

Reference to self.

SetMessage()

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

inlineconstexprnoexcept

Set the message.

Parameters

newMessage

the new message value.

Returns

Reference to self.

SetNumbuttons()

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

inlineconstexprnoexcept

Set the numbuttons.

Parameters

newNumbuttons

the new numbuttons value.

Returns

Reference to self.

SetTitle()

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

inlineconstexprnoexcept

Set the title.

Parameters

newTitle

the new title value.

Returns

Reference to self.

SetWindow()

MessageBox & SDL::MessageBox::SetWindow ( WindowRef newWindow )

inlinenoexcept

Set the window.

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