SCR_DialogEditorUIComponent Interface Reference

Inheritance diagram for SCR_DialogEditorUIComponent:

Public Member Functions
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	AllowFocus (Widget w)
void	FocusWidget (Widget w)
void	SetLinkedWidgetVisibility (bool show)
void	OnInput (float value, EActionTrigger reason)
void	OnRepeat ()
bool	CanOpenDialog ()
void	CloseDialog ()
void	OnInputDeviceIsGamepad (bool isGamepad)
void	OnMenuUpdate (float timeSlice)
void	OnDialogOpened (SCR_DialogEditorUIComponent linkedComponent)
void	OnDialogClosed (SCR_DialogEditorUIComponent linkedComponent)
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Protected Attributes
string	m_sToggleActionName
string	m_sRepeatActionName
ChimeraMenuPreset	m_DialogPreset
int	m_iHideLinkedIndex
bool	m_bIsInDialog
bool	m_CanCloseWithToggleAction = true
EditorMenuBase	m_EditorMenu
SCR_DialogEditorUIComponent	m_LinkedComponent
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500

Member Function Documentation

AllowFocus()

void SCR_DialogEditorUIComponent.AllowFocus ( Widget  w )

protected

CanOpenDialog()

bool SCR_DialogEditorUIComponent.CanOpenDialog ( )

protected

Implemented in SCR_BaseToolbarEditorUIComponent, and SCR_FactionsToolbarEditorUIComponent.

CloseDialog()

void SCR_DialogEditorUIComponent.CloseDialog ( )

protected

FocusWidget()

void SCR_DialogEditorUIComponent.FocusWidget ( Widget  w )

protected

HandlerAttachedScripted()

override void SCR_DialogEditorUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

Implemented in SCR_ModesEditorUIComponent, SCR_ActionsToolbarEditorUIComponent, SCR_BaseToolbarEditorUIComponent, SCR_CommandToolbarEditorUIComponent, SCR_EntitiesToolbarEditorUIComponent, SCR_FactionsToolbarEditorUIComponent, and SCR_PlacingToolbarEditorUIComponent.

HandlerDeattached()

override void SCR_DialogEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

Implemented in SCR_ModesEditorUIComponent, SCR_ActionsToolbarEditorUIComponent, SCR_CommandToolbarEditorUIComponent, SCR_EntitiesToolbarEditorUIComponent, SCR_FactionsToolbarEditorUIComponent, and SCR_PlacingToolbarEditorUIComponent.

OnDialogClosed()

void SCR_DialogEditorUIComponent.OnDialogClosed ( SCR_DialogEditorUIComponent  linkedComponent )

protected

Implemented in SCR_BaseToolbarEditorUIComponent.

OnDialogOpened()

void SCR_DialogEditorUIComponent.OnDialogOpened ( SCR_DialogEditorUIComponent  linkedComponent )

protected

Implemented in SCR_ModesEditorUIComponent, and SCR_BaseToolbarEditorUIComponent.

OnInput()

void SCR_DialogEditorUIComponent.OnInput ( float  value, EActionTrigger  reason  )

protected

OnInputDeviceIsGamepad()

void SCR_DialogEditorUIComponent.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

Implemented in SCR_ModesEditorUIComponent, and SCR_CommandToolbarEditorUIComponent.

OnMenuUpdate()

void SCR_DialogEditorUIComponent.OnMenuUpdate ( float  timeSlice )

protected

Implemented in SCR_EntitiesToolbarEditorUIComponent.

OnRepeat()

void SCR_DialogEditorUIComponent.OnRepeat ( )

protected

Implemented in SCR_ModesEditorUIComponent, SCR_ActionsToolbarEditorUIComponent, SCR_EntitiesToolbarEditorUIComponent, and SCR_PlacingToolbarEditorUIComponent.

SetLinkedWidgetVisibility()

void SCR_DialogEditorUIComponent.SetLinkedWidgetVisibility ( bool  show )

protected

Member Data Documentation

m_bIsInDialog

bool SCR_DialogEditorUIComponent.m_bIsInDialog

protected

m_CanCloseWithToggleAction

bool SCR_DialogEditorUIComponent.m_CanCloseWithToggleAction = true

protected

m_DialogPreset

ChimeraMenuPreset SCR_DialogEditorUIComponent.m_DialogPreset

protected

m_EditorMenu

EditorMenuBase SCR_DialogEditorUIComponent.m_EditorMenu

protected

m_iHideLinkedIndex

int SCR_DialogEditorUIComponent.m_iHideLinkedIndex

protected

m_LinkedComponent

SCR_DialogEditorUIComponent SCR_DialogEditorUIComponent.m_LinkedComponent

protected

m_sRepeatActionName

string SCR_DialogEditorUIComponent.m_sRepeatActionName

protected

m_sToggleActionName

string SCR_DialogEditorUIComponent.m_sToggleActionName

protected

---

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

• Game/Editor/UI/Components/Common/SCR_DialogEditorUIComponent.c