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={})
	Wraps MessageBox. More...
constexpr	MessageBox (MessageBoxFlags flags, WindowRef window, const char *title, const char *message, std::span< const MessageBoxButtonData > buttons, OptionalRef< const MessageBoxColorScheme > colorScheme)
	Constructs from its fields. More...
constexpr SDL_MessageBoxFlags	GetFlags () const
	Get the flags. More...
constexpr MessageBox &	SetFlags (SDL_MessageBoxFlags newFlags)
	Set the flags. More...
constexpr SDL_Window *	GetWindow () const
	Get the window. More...
constexpr MessageBox &	SetWindow (SDL_Window *newWindow)
	Set the window. More...
constexpr const char *	GetTitle () const
	Get the title. More...
constexpr MessageBox &	SetTitle (const char *newTitle)
	Set the title. More...
constexpr const char *	GetMessage () const
	Get the message. More...
constexpr MessageBox &	SetMessage (const char *newMessage)
	Set the message. More...
constexpr int	GetNumbuttons () const
	Get the numbuttons. More...
constexpr MessageBox &	SetNumbuttons (int newNumbuttons)
	Set the numbuttons. More...
constexpr std::span< const MessageBoxButtonData >	GetButtons () const
	Get the buttons. More...
constexpr MessageBox &	SetButtons (std::span< const MessageBoxButtonData > newButtons)
	Set the buttons. More...
constexpr const MessageBoxColorScheme *	GetColorScheme () const
	Get the colorScheme. More...
constexpr MessageBox &	SetColorScheme (OptionalRef< const MessageBoxColorScheme > newColorScheme)
	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 = {} )

inlineconstexpr

Parameters

messageBox

the value to be wrapped

MessageBox() [2/2]

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

inlineconstexpr

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

inlineconstexpr

Returns

current buttons.

GetColorScheme()

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

inlineconstexpr

Returns

current colorScheme value.

GetFlags()

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

inlineconstexpr

Returns

current flags value.

GetMessage()

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

inlineconstexpr

Returns

current message value.

GetNumbuttons()

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

inlineconstexpr

Returns

current numbuttons value.

GetTitle()

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

inlineconstexpr

Returns

current title value.

GetWindow()

constexpr SDL_Window * SDL::MessageBox::GetWindow ( ) const

inlineconstexpr

Returns

current window value.

SetButtons()

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

inlineconstexpr

Parameters

newButtons

the new buttons value.

Returns

Reference to self.

SetColorScheme()

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

inlineconstexpr

Parameters

newColorScheme

the new colorScheme value.

Returns

Reference to self.

SetFlags()

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

inlineconstexpr

Parameters

newFlags

the new flags value.

Returns

Reference to self.

SetMessage()

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

inlineconstexpr

Parameters

newMessage

the new message value.

Returns

Reference to self.

SetNumbuttons()

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

inlineconstexpr

Parameters

newNumbuttons

the new numbuttons value.

Returns

Reference to self.

SetTitle()

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

inlineconstexpr

Parameters

newTitle

the new title value.

Returns

Reference to self.

SetWindow()

constexpr MessageBox & SDL::MessageBox::SetWindow ( SDL_Window *  newWindow )

inlineconstexpr

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