npGaug plugin

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:

• Bitmap The path of a BITMAP file to be used as background. String. Empty string by default.
• Show3D Show or not the 3D border of a gauge. Boolean. False by default.
• ShowBackground Determine if the background BITMAP is shown or not. Boolean. True by default.
• ShowCaption Specify if the gauge caption is shown or not. Boolean. True by default.
• ShowCenter Determine if the gauge arrow center is drawn or not. Boolean. True by default.
• ShowCircles Specify if the gauge ticks circles are visibles or not. Boolean. False by default.
• ShowFrame Determine if the gauge frame is visible or not. Boolean. True by default.
• ShowIndicatorMax Determine if the gauge max indicator line is shown or not. Boolean. True by default.
• ShowIndicatorMid Determine if the gauge middle indicator line is shown or not. Boolean. True by default.
• ShowIndicatorMin Determine if the gauge min indicator line is shown or not. Boolean. True by default.
• ShowMainTicks Determine if the gauge main ticks are shown or not. Boolean. True by default.
• ShowMargin Specify if the gauge margin are visibles or not. Boolean. False by default.
• ShowSubTicks Determine if the gauge subticks are visibles or not. Boolean. True by default.
• ShowValues Specify if the ticks numbers values are visibles or not. Boolean. True by default.

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:

• ArrowColor The gauge arrow color. NeoBook color. "0,0,0" by default.
• CaptionColor The gauge caption color. NeoBook color. "0,0,0" by default.
• CenterColor The gauge arrow center color. NeoBook color. "0,0,0" by default.
• CircleColor The gauge ticks circles color. NeoBook color. "0,0,0" by default.
• FaceColor The gauge face color. NeoBook color. "255,255,255" by default.
• MarginColor The gauge margin color. NeoBook color. "0,0,0" by default.
• MaxColor The gauge maximum level color. NeoBook color. "255,0,0" by default.
• MidColor The guage middle level color. NeoBook color. "255,255,0" by default.
• MinColor The gauge minimum level color. NeoBook color. "0,128,0" by default.
• ValueColor The gauge ticks numbers values color. NeoBook color. "0,0,0" by default.
• TicksColor The gauge ticks color. NeoBook color. "0,0,0" by default.

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:

• Angle The gauge angle. Integer. 120 by default.
• AntiAliased The gauge smoothing mode. One of this values: aaNone, aaBiline, aaTriline, aaQuadral. That means without smoothing, smoothing with cells of 2x2, 3x3 and 4x4 pixels. "aaNone" by default.
• ArrowWidth The gauge arrow width. Integer. 1 by default.
• Caption The gauge caption. String. "mV" by default.
• CenterRadius The gauge center radius. Integer. 8 by default.
• CircleRadius The gauge ticks circles radius. 3 by default.
• Font The gauge font. NeoBook font. "Tahoma|10|8,0,0" by default.
• IndMaximum The gauge maximum indicator. Integer. 80 by default.
• IndMinimum The gauge minimum indicator. Integer. 30 by default.
• LengthSubTicks The gauge subticks length. Integer. 8 by default.
• LengthMainTicks The gauge main ticks length. Integer. 15 by default.
• Margin The gauge margin. Integer. 10 by default.
• NumberMainTicks The gauge main ticks number. Integer. 7 by default.
• Scale The gauge scale. Integer. 120 by default.
• Style The gauge style. One of this values: LeftStyle, CenterStyle, RightStyle. "CenterStyle" by default.

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:

• [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.

↑↑