Class PanelEventHandler
Use this class to handle input and send events to UI Toolkit runtime panels.
Implements
Inherited Members
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, IEventSystemHandler
Properties
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)
Called by the EventSystem when a Cancel event occurs.
Declaration
public void OnCancel(BaseEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData | The event data for the cancel. |
OnDeselect(BaseEventData)
Called by the EventSystem when this object is being deselected.
Declaration
public void OnDeselect(BaseEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData | The event data for the deselection. |
OnDisable()
Called when the behaviour becomes disabled, or its parent GameObject is deactivated.
Declaration
protected override void OnDisable()
Overrides
OnEnable()
Called when the behaviour becomes enabled.
Declaration
protected override void OnEnable()
Overrides
OnMove(AxisEventData)
Called by the EventSystem when a move event occurs.
Declaration
public void OnMove(AxisEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| AxisEventData | eventData | The axis event data for the move. |
OnPointerClick(PointerEventData)
Called by the EventSystem when a Click event occurs.
Declaration
public void OnPointerClick(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the click. |
OnPointerDown(PointerEventData)
Called by the EventSystem when a PointerDown event occurs.
Declaration
public void OnPointerDown(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the press. |
OnPointerEnter(PointerEventData)
Called by the EventSystem when the pointer enters this object.
Declaration
public void OnPointerEnter(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the enter. |
OnPointerExit(PointerEventData)
Called by the EventSystem when the pointer exits this object.
Declaration
public void OnPointerExit(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the exit. |
OnPointerMove(PointerEventData)
Use this callback to detect pointer move events
Declaration
public void OnPointerMove(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the move. |
OnPointerUp(PointerEventData)
Called by the EventSystem when a PointerUp event occurs.
Declaration
public void OnPointerUp(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the release. |
OnScroll(PointerEventData)
Called by the EventSystem when a new Scroll event occurs.
Declaration
public void OnScroll(PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | eventData | The pointer event data for the scroll. |
OnSelect(BaseEventData)
Called by the EventSystem when this object becomes selected.
Declaration
public void OnSelect(BaseEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData | The event data for the selection. |
OnSubmit(BaseEventData)
Called by the EventSystem when a Submit event occurs.
Declaration
public void OnSubmit(BaseEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseEventData | eventData | The event data for the submit. |
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()