Murl::ISystemDialog Interface Referenceabstract

The system-dialog interface. More...

#include "murl_i_system_dialog.h"

Inherited by Murl::Platform::Ios::SystemDialog, Murl::Platform::Osx::SystemDialog, Murl::Platform::Tvos::SystemDialog, and Murl::Platform::Win32::SystemDialog.

Public Member Functions

virtual const StringGetTitle () const =0
 Get the title string. More...
 
virtual const StringGetMessage () const =0
 Get the message string. More...
 
virtual UInt32 GetNumberOfButtons () const =0
 Get the number of buttons. More...
 
virtual const StringGetButtonLabel (UInt32 index) const =0
 Get a button label string by index. More...
 
virtual Bool AddButton (const String &label)=0
 Add a button to the dialog. More...
 
virtual Bool Open ()=0
 Open (show) the dialog. More...
 
virtual Bool Close (SInt32 clickedButtonIndex)=0
 Close (hide) the dialog. More...
 
virtual Bool IsOpen () const =0
 Check if the dialog is open. More...
 
virtual Bool WasClosed () const =0
 Check if the dialog was closed in the most recent tick. More...
 
virtual SInt32 GetClickedButtonIndex () const =0
 Get the clicked button index. More...
 

Detailed Description

The system-dialog interface.

The ISystemDialog object can be created by the ISystemDialogControl object.

Member Function Documentation

◆ GetTitle()

virtual const String& Murl::ISystemDialog::GetTitle ( ) const
pure virtual

Get the title string.

Returns
The title string.

◆ GetMessage()

virtual const String& Murl::ISystemDialog::GetMessage ( ) const
pure virtual

Get the message string.

Returns
The message string.

◆ GetNumberOfButtons()

virtual UInt32 Murl::ISystemDialog::GetNumberOfButtons ( ) const
pure virtual

Get the number of buttons.

Returns
the number of buttons.

◆ GetButtonLabel()

virtual const String& Murl::ISystemDialog::GetButtonLabel ( UInt32  index) const
pure virtual

Get a button label string by index.

A valid button index is [0 .. GetNumberOfButtons() - 1].

Parameters
indexThe zero-based index of the button.
Returns
The button label string.

◆ AddButton()

virtual Bool Murl::ISystemDialog::AddButton ( const String label)
pure virtual

Add a button to the dialog.

Button appearance is platform dependent but it is ensured that the negative button is always button 0 on dialogs with more than 1 button. On Android the maximum number of visible dialog buttons is limited to 3.

Parameters
labelThe button label string.
Returns
true if successful.

◆ Open()

virtual Bool Murl::ISystemDialog::Open ( )
pure virtual

Open (show) the dialog.

Returns
true if successful.

◆ Close()

virtual Bool Murl::ISystemDialog::Close ( SInt32  clickedButtonIndex)
pure virtual

Close (hide) the dialog.

A valid button index is [0 .. GetNumberOfButtons() - 1].

Parameters
clickedButtonIndexThe zero-based index of the clicked button.
Returns
true if successful.

◆ IsOpen()

virtual Bool Murl::ISystemDialog::IsOpen ( ) const
pure virtual

Check if the dialog is open.

Returns
true if the dialog is open.

◆ WasClosed()

virtual Bool Murl::ISystemDialog::WasClosed ( ) const
pure virtual

Check if the dialog was closed in the most recent tick.

Returns
true if the dialog was closed in the most recent tick.

◆ GetClickedButtonIndex()

virtual SInt32 Murl::ISystemDialog::GetClickedButtonIndex ( ) const
pure virtual

Get the clicked button index.

ButtonIndex 0 is the default (selected) button, button appearance is right to left or bottom up.

Returns
The zero-based index of the clicked button, or -1 if no button was selected.

The documentation for this interface was generated from the following file:
  • murl_i_system_dialog.h


Copyright © 2011-2017 Spraylight GmbH.