SCR_ConfigurableDialogUI.c File Reference

Go to the source code of this file.

Classes
class	SCR_ConfigurableDialogUi
class	SCR_ConfigurableDialogUiButtonPreset
	Configuration for a button. More...
class	SCR_ConfigurableDialogUiPreset
	Configuration for a dialog. More...
class	SCR_ConfigurableDialogUiPresets
	Class for a .conf file with multiple presets. More...

Macros
#define	DEBUG_CONFIGURABLE_DIALOGS

Typedefs
typedef func	ScriptInvokerConfigurableDialogMethod
typedef ScriptInvokerBase< ScriptInvokerConfigurableDialogMethod >	ScriptInvokerConfigurableDialog

Enumerations
enum	EConfigurableDialogUiButtonAlign { LEFT = 0 , RIGHT , CENTER }
	Configuration for button alignment. More...
enum	EConfigurableDialogStyle {   NEUTRAL , ACTION , WARNING , POSITIVE ,   ONLINE }
	Style of the dialog. More...

Functions
void	ScriptInvokerConfigurableDialogMethod (SCR_ConfigurableDialogUi dialog)
void	Init (SCR_ConfigurableDialogUi dlg)
override void	OnMenuUpdate (float tDelta)
override void	OnMenuFocusGained ()
override void	OnMenuFocusLost ()
override void	OnMenuShow ()
override void	OnMenuHide ()
override void	OnMenuClose ()

Variables
SCR_ConfigurableDialogUi	m_Dlg
	It is here to expose the Menu API to the configurable dialog instance.

Macro Definition Documentation

DEBUG_CONFIGURABLE_DIALOGS

#define DEBUG_CONFIGURABLE_DIALOGS

Configurable dialog can be configured via .conf presets. It has many options for button positions, title, message, colors, style, ...

If you add buttons "confirm" or "cancel", they are automatically bound to methods OnCancel and OnConfirm

Definition at line 7 of file SCR_ConfigurableDialogUI.c.

Typedef Documentation

ScriptInvokerConfigurableDialog

typedef ScriptInvokerBase<ScriptInvokerConfigurableDialogMethod> ScriptInvokerConfigurableDialog

Definition at line 11 of file SCR_ConfigurableDialogUI.c.

ScriptInvokerConfigurableDialogMethod

typedef func ScriptInvokerConfigurableDialogMethod

Definition at line 10 of file SCR_ConfigurableDialogUI.c.

Enumeration Type Documentation

EConfigurableDialogStyle

enum EConfigurableDialogStyle

Style of the dialog.

Enumerator
NEUTRAL
ACTION
WARNING
POSITIVE
ONLINE

Definition at line 719 of file SCR_ConfigurableDialogUI.c.

EConfigurableDialogUiButtonAlign

enum EConfigurableDialogUiButtonAlign

Configuration for button alignment.

Enumerator
LEFT
RIGHT
CENTER

Definition at line 706 of file SCR_ConfigurableDialogUI.c.

Function Documentation

Init()

void Init

(

SCR_ConfigurableDialogUi

dlg

)

Definition at line 645 of file SCR_ConfigurableDialogUI.c.

OnMenuClose()

override void OnMenuClose

(

)

Definition at line 694 of file SCR_ConfigurableDialogUI.c.

OnMenuFocusGained()

override void OnMenuFocusGained

(

)

Definition at line 658 of file SCR_ConfigurableDialogUI.c.

OnMenuFocusLost()

override void OnMenuFocusLost

(

)

Definition at line 667 of file SCR_ConfigurableDialogUI.c.

OnMenuHide()

override void OnMenuHide

(

)

Definition at line 685 of file SCR_ConfigurableDialogUI.c.

OnMenuShow()

override void OnMenuShow

(

)

Definition at line 676 of file SCR_ConfigurableDialogUI.c.

OnMenuUpdate()

override void OnMenuUpdate

(

float

tDelta

)

Definition at line 651 of file SCR_ConfigurableDialogUI.c.

ScriptInvokerConfigurableDialogMethod()

void ScriptInvokerConfigurableDialogMethod

(

SCR_ConfigurableDialogUi

dialog

)

Variable Documentation

m_Dlg

SCR_ConfigurableDialogUi m_Dlg

It is here to expose the Menu API to the configurable dialog instance.