npGest plugin

npGestActive

Active the mouse gestures for the publication. Call this action in order to activate the mouse gestures on your publication. You can call this action first, but, maybe you want before to set the mouse gestures button (see npGestSetButton) and/or the mouse gesture event subroutine (see npOnMouseGesture).

↑↑

npGestDeactive

Deactive the mouse gestures for the publication.

↑↑

npGestIsActive

Find if the mouse gestures are activated or not. The result variable store "True" if the mouse gestures is activated, or "False" if not.

↑↑

npGestSetButton

Set the mouse button used by capture gestures. The button variable can be one of the following values: mbLeft, mnMiddle or mbRight in order to use mouse gestures from the left, middle or right mouse buttons respectively.

↑↑

npGestGetButton

Get the mouse button used by capture gestures. The result variable store one of the following values: mbLeft, mnMiddle or mbRight.

↑↑

npOnMouseGesture

Set a publication subroutine to be executed on every mouse gestures. The button variable store the mouse button used in the gesture and can be one of the following values: mbLeft, mnMiddle or mbRight. The gesture variable store the mouse gesture identification, wich you can use to make something on your publication.

This the table of the basic gestures identifiers:

So, from the center of the table, if you drag the mouse button to up, the gesture identifier is "U", if you drag the mouse button to down, the gesture is "D" and so on. Note however that the gestures can be more complicated, like the "DR" gesture, that is, when you drag the mouse button to down and then to right. I recommend you to see the plugin samples, wich show the possible gestures you can catch in order to make something on your publication.

↑↑

Action errors subroutine

All the NeoPlugins deal with errors in the same way that NeoBook does: when the plugin found an action error the [LastError] variable store information about the error, so you can take care about this variable when execute an action.

But all the NeoPlugins also incorporate an advanced way to deal with possible action errors. You can define a subroutine named OnNeoPluginActionError in order to be executed when some action error are found and you can use this variables inside:

• [LastError] The last action error message.
• [PluginName] Store the plugin name which cause the error.

Note that this error handling subroutine are shared for all the NeoPlugins, so you no need to specify a subroutine for every plugin you use in your publication because the same subroutine are recognized and automagically used by every NeoPlugin. Below you can view a sample of this subroutine code:

:OnNeoPluginActionError
  AlertBox "NeoPlugin Error" "Error [LastError] in plugin: [PluginName]"
Return

Also note that the use of this NeoPlugins error handling subroutine is completelly optional. You can continue using the [LastError] variable as usual and even use the both methods at the same time.

↑↑