Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::NativeUI::NativeUIRequests Class Reference

Public Member Functions

 AZ_RTTI (NativeUIRequests, "{48361EE6-C1E7-4965-A13A-7425B2691817}")
 
virtual AZStd::string DisplayBlockingDialog (const AZStd::string &title, const AZStd::string &message, const AZStd::vector< AZStd::string > &options) const
 
virtual AZStd::string DisplayOkDialog (const AZStd::string &title, const AZStd::string &message, bool showCancel) const
 
virtual AZStd::string DisplayYesNoDialog (const AZStd::string &title, const AZStd::string &message, bool showCancel) const
 
virtual AssertAction DisplayAssertDialog (const AZStd::string &message) const
 
void SetMode (NativeUI::Mode mode)
 Set the operation mode of the native UI systen.
 

Protected Attributes

NativeUI::Mode m_mode = NativeUI::Mode::DISABLED
 

Member Function Documentation

◆ DisplayAssertDialog()

virtual AssertAction AZ::NativeUI::NativeUIRequests::DisplayAssertDialog ( const AZStd::string message) const
inlinevirtual

Displays an assert dialog box Returns the action selected by the user

◆ DisplayBlockingDialog()

virtual AZStd::string AZ::NativeUI::NativeUIRequests::DisplayBlockingDialog ( const AZStd::string title,
const AZStd::string message,
const AZStd::vector< AZStd::string > &  options 
) const
inlinevirtual

Waits for user to select an option before execution continues Returns the option string selected by the user

◆ DisplayOkDialog()

virtual AZStd::string AZ::NativeUI::NativeUIRequests::DisplayOkDialog ( const AZStd::string title,
const AZStd::string message,
bool  showCancel 
) const
inlinevirtual

Waits for user to select an option ('Ok' or optionally 'Cancel') before execution continues Returns the option string selected by the user

◆ DisplayYesNoDialog()

virtual AZStd::string AZ::NativeUI::NativeUIRequests::DisplayYesNoDialog ( const AZStd::string title,
const AZStd::string message,
bool  showCancel 
) const
inlinevirtual

Waits for user to select an option ('Yes', 'No' or optionally 'Cancel') before execution continues Returns the option string selected by the user


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