Configurable editbox dialog base. More...

Inheritance diagram for SCR_EditboxDialogUi:

Public Member Functions
void	DisplayWarningMessage (bool display)

void	SetWarningMessage (string message)

SCR_EditBoxComponent	GetEditbox ()

Public Member Functions inherited from SCR_ConfigurableDialogUi
Widget	GetRootWidget ()

OverlayWidget	GetDialogBaseOverlay ()
	Returns the base dialog overlay (the rectangle covered by the background). Useful for dialog wide darkening (e.g. by SCR_LoadingOverlay)

Widget	GetContentLayoutRoot ()
	Returns the root of the content layout.

SCR_ConfigurableDialogUiPreset	GetDialogPreset ()

void	Close ()

void	SetTitle (string text)

void	SetMessage (string text)

void	SetMessageColor (Color color)

TextWidget	GetMessageWidget ()

string	GetMessageStr ()

void	SetTitleIcon (ResourceName image, string imageName)
	Set title icons with custom image.

void	SetIconColor (Color color)
	Set title icons with custom image.

void	SetStyle (EConfigurableDialogStyle type)
	Sets colors based on style.

void	BindButtonConfirm (SCR_InputButtonComponent button)
	Allows to register a custom button to call OnConfirm (i.e. one not in the conf files but placed by hand in the layout)

void	BindButtonCancel (SCR_InputButtonComponent button)
	Allows to register a custom button to call OnCancel (i.e. one not in the conf files but placed by hand in the layout)

void	BindButtonGeneric (SCR_InputButtonComponent button, string tag=string.Empty)
	Allows to register a custom button to call OnButtonPressed (i.e. one not in the conf files but placed by hand in the layout). An empty tag will result in the widget's name being used instead.

SCR_InputButtonComponent	FindButton (string tag)
	Returns a button with given tag.

string	GetButtonTag (SCR_InputButtonComponent button)
	Returns a button's tag.

void	OnMenuUpdate (float tDelta)

void	OnMenuFocusGained ()

void	OnMenuFocusLost ()

void	OnMenuShow ()

void	OnMenuHide ()

void	OnMenuClose ()

Public Attributes
ref ScriptInvokerString	m_OnTextChange = new ScriptInvokerString()

ref ScriptInvokerString	m_OnWriteModeLeave = new ScriptInvokerString()

Public Attributes inherited from SCR_ConfigurableDialogUi
ref ScriptInvoker	m_OnConfirm = new ScriptInvoker()

ref ScriptInvoker	m_OnCancel = new ScriptInvoker()

ref ScriptInvoker	m_OnClose = new ScriptInvoker()

ref ScriptInvoker	m_OnCloseStart = new ScriptInvoker()

ref ScriptInvoker	m_OnButtonPressed = new ScriptInvoker()

Static Public Attributes
const string	WIDGET_EDITBOX = "EditBox"

const string	WIDGET_WARNING = "DialogWarning"

const string	WIDGET_TEXT_WARNING = "TxtDialogWarning"

Static Public Attributes inherited from SCR_ConfigurableDialogUi
static const ResourceName	NAVIGATION_BUTTON_LAYOUT = "{87037226B1A2064B}UI/layouts/WidgetLibrary/Buttons/WLib_NavigationButtonSuperSmall.layout"

static const string	BUTTON_CONFIRM = "confirm"

static const string	BUTTON_CANCEL = "cancel"

Protected Member Functions
override void	InitWidgets ()

override void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	Called last of all, after all the initialization of main element done.

void	OnWriteModeLeave (string text)

void	OnTextChange (string text)

Protected Member Functions inherited from SCR_ConfigurableDialogUi
void	OnConfirm ()

void	OnCancel ()

void	OnButtonPressed (SCR_InputButtonComponent button)

void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	Called last of all, after all the initialization of main element done.

void	Init (Widget root, SCR_ConfigurableDialogUiPreset preset, MenuBase proxyMenu)

void	InitWidgets ()

SCR_InputButtonComponent	CreateButton (SCR_ConfigurableDialogUiButtonPreset buttonPreset)

void	Internal_Close ()

void	InitAttributedVariables ()
	Verifies that all attributed variables are set up.

Protected Attributes
Widget	m_wWarningMessage

TextWidget	m_wTxtWarningMessage

SCR_EditBoxComponent	m_Editbox

Protected Attributes inherited from SCR_ConfigurableDialogUi
float	m_fFadeInTime

ResourceName	m_sNavigationButtonLayout

string	m_sWidgetNameButtonsLeft

string	m_sWidgetNameButtonsRight

string	m_sWidgetNameButtonsCenter

ImageWidget	m_wImgTopLine

ImageWidget	m_wImgTitleIcon

TextWidget	m_wTitle

TextWidget	m_wMessage

VerticalLayoutWidget	m_wContentVerticalLayout

ref map< string, SCR_InputButtonComponent >	m_aButtonComponents = new map<string, SCR_InputButtonComponent>

Widget	m_wRoot

OverlayWidget	m_wDialogBase

SCR_DynamicFooterComponent	m_DynamicFooter

MenuBase	m_ProxyMenu

ref SCR_ConfigurableDialogUiPreset	m_DialogPreset

string	m_sLastPressedButtonTag

bool	m_bIsClosing

Additional Inherited Members
Static Public Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi	CreateFromPreset (ResourceName presetsResourceName, string tag, SCR_ConfigurableDialogUi customDialogObj=null)
	Creates a dialog from preset.

static SCR_ConfigurableDialogUi	GetCurrentDialog ()

static string	GetCurrentDialogTag ()

static bool	IsPresetValid (ResourceName presetsResourceName, string tag)

Static Protected Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi	CreateByPreset (SCR_ConfigurableDialogUiPreset preset, SCR_ConfigurableDialogUi customDialogObj=null)

static Widget	GetContentWidget (Widget baseWidget)
	Returns the container in which to place the content layout. Container must be called ContentLayoutContainer.

Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi	m_CurrentDialog

Detailed Description

Configurable editbox dialog base.

Member Function Documentation

◆ DisplayWarningMessage()

void SCR_EditboxDialogUi.DisplayWarningMessage ( bool display )

◆ GetEditbox()

SCR_EditBoxComponent SCR_EditboxDialogUi.GetEditbox ( )

◆ InitWidgets()

override void SCR_EditboxDialogUi.InitWidgets ( )

protected

Implements SCR_ConfigurableDialogUi.

◆ OnMenuOpen()

override void SCR_EditboxDialogUi.OnMenuOpen ( SCR_ConfigurableDialogUiPreset preset )

protected

Called last of all, after all the initialization of main element done.

Here you can perform custom initialization.

Implements SCR_ConfigurableDialogUi.

◆ OnTextChange()

void SCR_EditboxDialogUi.OnTextChange ( string text )

protected

◆ OnWriteModeLeave()

void SCR_EditboxDialogUi.OnWriteModeLeave ( string text )

protected

◆ SetWarningMessage()

void SCR_EditboxDialogUi.SetWarningMessage ( string message )

Member Data Documentation

◆ m_Editbox

SCR_EditBoxComponent SCR_EditboxDialogUi.m_Editbox

protected

◆ m_OnTextChange

ref ScriptInvokerString SCR_EditboxDialogUi.m_OnTextChange = new ScriptInvokerString()

◆ m_OnWriteModeLeave

ref ScriptInvokerString SCR_EditboxDialogUi.m_OnWriteModeLeave = new ScriptInvokerString()

◆ m_wTxtWarningMessage

TextWidget SCR_EditboxDialogUi.m_wTxtWarningMessage

protected

◆ m_wWarningMessage

Widget SCR_EditboxDialogUi.m_wWarningMessage

protected

◆ WIDGET_EDITBOX

const string SCR_EditboxDialogUi.WIDGET_EDITBOX = "EditBox"

static

◆ WIDGET_TEXT_WARNING

const string SCR_EditboxDialogUi.WIDGET_TEXT_WARNING = "TxtDialogWarning"

static

◆ WIDGET_WARNING

const string SCR_EditboxDialogUi.WIDGET_WARNING = "DialogWarning"

static

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

Game/UI/Menu/Dialogs/SCR_EditboxDialogUI.c

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DisplayWarningMessage()

◆ GetEditbox()

◆ InitWidgets()

◆ OnMenuOpen()

◆ OnTextChange()

◆ OnWriteModeLeave()

◆ SetWarningMessage()

Member Data Documentation

◆ m_Editbox

◆ m_OnTextChange

◆ m_OnWriteModeLeave

◆ m_wTxtWarningMessage

◆ m_wWarningMessage

◆ WIDGET_EDITBOX

◆ WIDGET_TEXT_WARNING

◆ WIDGET_WARNING