npGaug plugin

About this plugin

This plugin allow you to use one or more analog gauge controls on your publication. You can customize every control with their own colors, face, general options and events. Lot of colors, face, general options and events are availables.

Every analog gauge can be presented in three diferent styles: Left, Center and Right. Everyone allow you to play with the several included properties which can be used in order to modify the gauges appearance and the gauges behaviour.

Thirparty

This plugin are imposible without the aid of this people:

Thanks a lot!

Plugin actions index

npGaugCreate

Create a new instance of an Gaug object and attach it to a Neobook rectangle object. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npGaugDestroy

Destroy a previously created Gaug object instance and deattach from their NeoBook rectangle. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npGaugDestroyAll

Destroy all previously created instances of Gaug objects.

↑↑

npGaugGetPos

Get the position of the specified Gaug object instance. The Pos variable store the current position on the specified Gaug object instance. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npGaugSetPos

Set the position of the specified Gaug object instance. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npGaugFace

Set the face options of a Gaug object instance. Here is a list with the available Gaug object face options:

The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npGaugColors

Set the colors of a Gaug object instance. Here is a list with the available Gaug object colors:

The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npGaugOptions

Set the general options of a Gaug object instance. Here is a list with the available Gaug object general options:

The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npOnGaugClick

Set a publication subroutine to be executed when the specified Gaug object instance are clicked. The Rectangle variable store the rectangle object name which fire the event. So, it's easy to share the same subroutine to more than one objects, since you can determine who object fire the event with the Rectangle variable. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npOnGaugDblClick

Set a publication subroutine to be executed when the specified Gaug object instance are double clicked. The Rectangle variable store the rectangle object name which fire the event. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npOnGaugOverMin

Set a publication subroutine to be executed when the specified Gaug object position over the minimun value. The Rectangle variable store the rectangle object name which fire the event. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

npOnGaugOverMax

Set a publication subroutine to be executed when the specified Gaug object position over the maximum value. The Rectangle variable store the rectangle object name which fire the event. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the variable [LastError] store information about the error.

↑↑

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:

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.

↑↑