Class Pressable

Pressable Manipulator, used on Button elements.

Inheritance
object
Manipulator
MouseManipulator
PointerManipulator
Pressable
Draggable
Implements
Inherited Members
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
public class Pressable : PointerManipulator, IManipulator

Constructors

Pressable()

Constructor.

Declaration
public Pressable()

Pressable(Action)

Constructor.

Declaration
public Pressable(Action handler)
Parameters
Type Name Description
Action handler

The event handler to register with the Pressed event.

Pressable(Action<EventBase>)

Constructor.

Declaration
public Pressable(Action<EventBase> handler)
Parameters
Type Name Description
Action<EventBase> handler

The event handler to register with the Pressed event.

Properties

active

Check if the element is currently pressed.

Declaration
public bool active { get; }
Property Value
Type Description
bool

keepEventPropagation

When true, the event propagation will not be stopped when the element is pressed.

Declaration
public bool keepEventPropagation { get; set; }
Property Value
Type Description
bool

longPressDuration

The duration of a long press in milliseconds.

The default value is -1.

Declaration
public int longPressDuration { get; set; }
Property Value
Type Description
int
Remarks

Using a negative value will disable long press.

Methods

ForceActivePseudoState()

Force the active pseudo state on the target element.

Declaration
public void ForceActivePseudoState()

InvokeLongPressed()

Invoke the LongPressed event.

Declaration
public void InvokeLongPressed()

InvokePressed(EventBase)

Invoke the Pressed event.

Declaration
public void InvokePressed(EventBase evt)
Parameters
Type Name Description
EventBase evt

The base event to use to invoke the press.

ProcessDownEvent(EventBase, Vector2, int)

Custom handling of pointer enter events.

Declaration
protected virtual void ProcessDownEvent(EventBase evt, Vector2 localPos, int pointerId)
Parameters
Type Name Description
EventBase evt

The event to process.
Vector2 localPos

The local position of the pointer.
int pointerId

The pointer id.

ProcessMoveEvent(EventBase, Vector2)

Custom handling of pointer move events.

Declaration
protected virtual void ProcessMoveEvent(EventBase evt, Vector2 localPos)
Parameters
Type Name Description
EventBase evt

The event to process.
Vector2 localPos

The local position of the pointer.

ProcessUpEvent(EventBase, Vector2, int)

Custom handling of pointer leave events.

Declaration
protected virtual void ProcessUpEvent(EventBase evt, Vector2 localPos, int pointerId)
Parameters
Type Name Description
EventBase evt

The event to process.
Vector2 localPos

The local position of the pointer.
int pointerId

The pointer id.

RegisterCallbacksOnTarget()

Called to register event callbacks from the target element.

Declaration
protected override void RegisterCallbacksOnTarget()
Overrides

UnregisterCallbacksFromTarget()

Called to unregister event callbacks from the target element.

Declaration
protected override void UnregisterCallbacksFromTarget()
Overrides

Events

clicked

The event invoked when the element is pressed.

Declaration
public event Action clicked
Event Type
Type Description
Action

clickedWithEventInfo

The event invoked when the element is pressed.

Declaration
public event Action<EventBase> clickedWithEventInfo
Event Type
Type Description
Action<EventBase>

longClicked

The event invoked when the element is pressed for a long time.

Declaration
public event Action longClicked
Event Type
Type Description
Action

Implements