FormIt Plugin API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
FormIt.Events API

Description

Functions

json FormIt.Events.AreaSelectBegan (pt, mods)
 AreaSelectBegan() function.
 
json FormIt.Events.AreaSelectChanged (pt, mods)
 AreaSelectChanged() function.
 
json FormIt.Events.AreaSelectEnded (mods)
 AreaSelectEnded() function.
 
json FormIt.Events.DoubleTap (pt, mods, isStylus)
 DoubleTap() function.
 
json FormIt.Events.DoubleTapTwoTouches (pt, mods)
 DoubleTapTwoTouches() function.
 
json FormIt.Events.HandleEvent (event)
 HandleEvent() function.
 
json FormIt.Events.KeyDown (keyCode, mods)
 KeyDown() function.
 
json FormIt.Events.KeyDownWithString (keyCode, mods, s)
 KeyDownWithString() function.
 
json FormIt.Events.KeyUp (keyCode, mods)
 KeyUp() function.
 
json FormIt.Events.LongPress (pt, mods, isStylus)
 LongPress() function.
 
json FormIt.Events.MouseDown (pt, button, mods)
 MouseDown() function.
 
json FormIt.Events.MouseMove (pt, button, mods)
 MouseMove() function.
 
json FormIt.Events.MouseOut (pt, button, mods)
 MouseOut() function.
 
json FormIt.Events.MouseOver (pt, button, mods)
 MouseOver() function.
 
json FormIt.Events.MouseUp (pt, button, mods)
 MouseUp() function.
 
json FormIt.Events.MouseWheel (pt, delta, button, mods)
 MouseWheel() function.
 
json FormIt.Events.PanBegin (pt, nTouches, mods, isStylus)
 PanBegin() function.
 
json FormIt.Events.PanChanged (vec, nTouches, mods, isStylus)
 PanChanged() function.
 
json FormIt.Events.PanEnded (mods, isStylus)
 PanEnded() function.
 
json FormIt.Events.PinchBegan (pt, mods)
 PinchBegan() function.
 
json FormIt.Events.PinchChanged (dDelta, mods)
 PinchChanged() function.
 
json FormIt.Events.PinchEnded (mods)
 PinchEnded() function.
 
json FormIt.Events.SingleTap (pt, mods, isStylus)
 SingleTap() function.
 
json FormIt.Events.TouchBegan (pt, mods, isStylus)
 TouchBegan() function.
 

Function Documentation

◆ AreaSelectBegan()

json FormIt.Events.AreaSelectBegan ( pt  ,
mods   
)

AreaSelectBegan() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ AreaSelectChanged()

json FormIt.Events.AreaSelectChanged ( pt  ,
mods   
)

AreaSelectChanged() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ AreaSelectEnded()

json FormIt.Events.AreaSelectEnded ( mods  )

AreaSelectEnded() function.

Parameters
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ DoubleTap()

json FormIt.Events.DoubleTap ( pt  ,
mods  ,
isStylus   
)

DoubleTap() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}

◆ DoubleTapTwoTouches()

json FormIt.Events.DoubleTapTwoTouches ( pt  ,
mods   
)

DoubleTapTwoTouches() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ HandleEvent()

json FormIt.Events.HandleEvent ( event  )

HandleEvent() function.

Parameters
[in]eventFormIt.InputEvent
Returns
JSON_UNDEFINED, i.e. {}

◆ KeyDown()

json FormIt.Events.KeyDown ( keyCode  ,
mods   
)

KeyDown() function.

Parameters
[in]keyCodeFormIt.KeyboardCode
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ KeyDownWithString()

json FormIt.Events.KeyDownWithString ( keyCode  ,
mods  ,
 
)

KeyDownWithString() function.

Parameters
[in]keyCodeFormIt.KeyboardCode
[in]modsFormIt.KeyboardModifier
[in]sString
Returns
JSON_UNDEFINED, i.e. {}

◆ KeyUp()

json FormIt.Events.KeyUp ( keyCode  ,
mods   
)

KeyUp() function.

Parameters
[in]keyCodeFormIt.KeyboardCode
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ LongPress()

json FormIt.Events.LongPress ( pt  ,
mods  ,
isStylus   
)

LongPress() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}

◆ MouseDown()

json FormIt.Events.MouseDown ( pt  ,
button  ,
mods   
)

MouseDown() function.

Parameters
[in]ptWSM.Point2d
[in]buttonFormIt.MouseButton
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ MouseMove()

json FormIt.Events.MouseMove ( pt  ,
button  ,
mods   
)

MouseMove() function.

Parameters
[in]ptWSM.Point2d
[in]buttonFormIt.MouseButton
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ MouseOut()

json FormIt.Events.MouseOut ( pt  ,
button  ,
mods   
)

MouseOut() function.

Parameters
[in]ptWSM.Point2d
[in]buttonFormIt.MouseButton
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ MouseOver()

json FormIt.Events.MouseOver ( pt  ,
button  ,
mods   
)

MouseOver() function.

Parameters
[in]ptWSM.Point2d
[in]buttonFormIt.MouseButton
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ MouseUp()

json FormIt.Events.MouseUp ( pt  ,
button  ,
mods   
)

MouseUp() function.

Parameters
[in]ptWSM.Point2d
[in]buttonFormIt.MouseButton
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ MouseWheel()

json FormIt.Events.MouseWheel ( pt  ,
delta  ,
button  ,
mods   
)

MouseWheel() function.

Parameters
[in]ptWSM.Point2d
[in]deltaint
[in]buttonFormIt.MouseButton
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ PanBegin()

json FormIt.Events.PanBegin ( pt  ,
nTouches  ,
mods  ,
isStylus   
)

PanBegin() function.

Parameters
[in]ptWSM.Point2d
[in]nTouchesint
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}

◆ PanChanged()

json FormIt.Events.PanChanged ( vec  ,
nTouches  ,
mods  ,
isStylus   
)

PanChanged() function.

Parameters
[in]vecWSM.Vector2d
[in]nTouchesint
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}

◆ PanEnded()

json FormIt.Events.PanEnded ( mods  ,
isStylus   
)

PanEnded() function.

Parameters
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}

◆ PinchBegan()

json FormIt.Events.PinchBegan ( pt  ,
mods   
)

PinchBegan() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ PinchChanged()

json FormIt.Events.PinchChanged ( dDelta  ,
mods   
)

PinchChanged() function.

Parameters
[in]dDeltadouble
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ PinchEnded()

json FormIt.Events.PinchEnded ( mods  )

PinchEnded() function.

Parameters
[in]modsFormIt.KeyboardModifier
Returns
JSON_UNDEFINED, i.e. {}

◆ SingleTap()

json FormIt.Events.SingleTap ( pt  ,
mods  ,
isStylus   
)

SingleTap() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}

◆ TouchBegan()

json FormIt.Events.TouchBegan ( pt  ,
mods  ,
isStylus   
)

TouchBegan() function.

Parameters
[in]ptWSM.Point2d
[in]modsFormIt.KeyboardModifier
[in]isStylusbool
Returns
JSON_UNDEFINED, i.e. {}