SCR_MouseAreaEditorUIComponent Interface Reference

Inheritance diagram for SCR_MouseAreaEditorUIComponent:

Public Member Functions
bool	IsMouseOn ()
	Check if cursor is hovering on the widget, and not outside or on another widget further above.
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
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	OnInputDeviceIsGamepad (bool isGamepad)
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
bool	m_bIsMouseOn
bool	m_bIsUsingMouseAndKeyboard
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

HandlerAttachedScripted()

override void SCR_MouseAreaEditorUIComponent.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.

HandlerDeattached()

override void SCR_MouseAreaEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

IsMouseOn()

bool SCR_MouseAreaEditorUIComponent.IsMouseOn

(

)

Check if cursor is hovering on the widget, and not outside or on another widget further above.

Returns

True when hovering on thr widget.

OnInputDeviceIsGamepad()

void SCR_MouseAreaEditorUIComponent.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

OnMouseEnter()

override bool SCR_MouseAreaEditorUIComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y
	)

OnMouseLeave()

override bool SCR_MouseAreaEditorUIComponent.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y
	)

Member Data Documentation

m_bIsMouseOn

bool SCR_MouseAreaEditorUIComponent.m_bIsMouseOn

protected

m_bIsUsingMouseAndKeyboard

bool SCR_MouseAreaEditorUIComponent.m_bIsUsingMouseAndKeyboard

protected

---

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

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