Class PanelEventHandler
Use this class to handle input and send events to UI Toolkit runtime panels.
Implements
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetEntityId()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.UIElements
Assembly: UnityEngine.UI.dll
Syntax
[AddComponentMenu("UI Toolkit/Panel Event Handler (UI Toolkit)")]
public class PanelEventHandler : UIBehaviour, IPointerMoveHandler, IPointerUpHandler, IPointerDownHandler, ISubmitHandler, ICancelHandler, IMoveHandler, IScrollHandler, ISelectHandler, IDeselectHandler, IPointerExitHandler, IPointerEnterHandler, IPointerClickHandler, IEventSystemHandlerProperties
panel
The panel that this component relates to. If panel is null, this component will have no effect. Will be set to null automatically if panel is Disposed from an external source.
Declaration
public IPanel panel { get; set; }Property Value
| Type | Description |
|---|---|
| IPanel |
Methods
OnCancel(BaseEventData)
Declaration
public void OnCancel(BaseEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData |
OnDeselect(BaseEventData)
Called by the EventSystem when a new object is being selected.
Declaration
public void OnDeselect(BaseEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData |
OnDisable()
Declaration
protected override void OnDisable()Overrides
OnEnable()
Declaration
protected override void OnEnable()Overrides
OnMove(AxisEventData)
Called by a BaseInputModule when a move event occurs.
Declaration
public void OnMove(AxisEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| AxisEventData | eventData |
OnPointerClick(PointerEventData)
Use this callback to detect clicks.
Declaration
public void OnPointerClick(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnPointerDown(PointerEventData)
Use this callback to detect pointer down events.
Declaration
public void OnPointerDown(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnPointerEnter(PointerEventData)
Use this callback to detect pointer enter events
Declaration
public void OnPointerEnter(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnPointerExit(PointerEventData)
Use this callback to detect pointer exit events
Declaration
public void OnPointerExit(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnPointerMove(PointerEventData)
Use this callback to detect pointer move events
Declaration
public void OnPointerMove(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnPointerUp(PointerEventData)
Use this callback to detect pointer up events.
Declaration
public void OnPointerUp(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnScroll(PointerEventData)
Use this callback to detect scroll events.
Declaration
public void OnScroll(PointerEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData |
OnSelect(BaseEventData)
Declaration
public void OnSelect(BaseEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData |
OnSubmit(BaseEventData)
Declaration
public void OnSubmit(BaseEventData eventData)Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData |
Update()
This method is automatically called on every frame. It can also be called manually to force some queued events to be processed.
Declaration
public void Update()