ScummVM API documentation
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Common::DialogManager Class Reference
Common API » Dialog Manager

#include <dialogs.h>

Public Types

enum  DialogResult { kDialogError = -1, kDialogCancel = 0, kDialogOk = 1 }
 

Public Member Functions

virtual DialogResult showFileBrowser (const Common::U32String &title, FSNode &choice, bool isDirBrowser=false)
 

Protected Member Functions

void beginDialog ()
 
void endDialog ()
 

Protected Attributes

bool _wasFullscreen
 

Detailed Description

The DialogManager allows GUI code to interact with native system dialogs.

Member Enumeration Documentation

◆ DialogResult

enum Common::DialogManager::DialogResult

Values representing the user response to a dialog.

Enumerator
kDialogError 

Dialog could not be displayed.

kDialogCancel 

User cancelled the dialog (Cancel/No/Close buttons).

kDialogOk 

User confirmed the dialog (OK/Yes buttons).

Member Function Documentation

◆ showFileBrowser()

virtual DialogResult Common::DialogManager::showFileBrowser ( const Common::U32String &  title,
FSNode &  choice,
bool  isDirBrowser = false 
)
inlinevirtual

Display a dialog for selecting a file or folder in the file system.

Parameters
titleDialog title.
choicePath selected by the user.
isDirBrowserRestrict selection to directories.
Returns
The dialog result.

◆ beginDialog()

void Common::DialogManager::beginDialog ( )
inlineprotected

Call before opening a dialog.

◆ endDialog()

void Common::DialogManager::endDialog ( )
inlineprotected

Call after closing a dialog.

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