npHour plugin

npHourCreate

Create a new instance of an Hour 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 [LastError] variable store information about the error.

↑↑

npHourDestroy

Destroy a previously Hour 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 [LastError] variable store information about the error.

↑↑

npHourDestroyAll

Destroy all previously created instances of Hour objects.

↑↑

npHourActive

Activate or deactivate an instance of an Hour object. Set the Active argument to "True" or "Checked" values to activate the Clock, or "False" to deactivate. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npHourIsActive

Find if an instance of an Hour object is active or not. The result variable store "True" if the Clock is active, or "False" if not or an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npHourGetTime

Get the current hour, minute and second of an Hour object instance. Specity the Hour, Minutes and Seconds variables in order to retrieve the current Clock time. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npHourSetTime

Set the hour, minute and second of an Hour object instance. Specify the Hour, Minute and Second values to set the Clock with them. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npHourFaceImage

Set the face BMP image of an Hour object instance. Provide the path for a BMP file image in order to be placed as the face of the Clock. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npHourHandOptions

Set the hand options of an Hour object instance. Here is the list of the hand options you can set, with the value types and defaults.

• Color Color of the Hour control. "240,240,240" by default.
• DrawMarks Draw the Clock marks. Boolean value. "True" by default.
• HourHandColor Color of the hour hand. "0,0,0" by default.
• HourHandLength Length in pixels of the hour hand. "60" by default.
• HourHandWidth Widh in pixels of the hour hand. "4" by default.
• MinuteHandColor Color of the minute hand. "0,0,0" by default.
• MinuteHandLength Length in pixels of the minute hand. "80" by default.
• MinuteHandWidth Widh in pixels of the minute hand. "3" by default.
• SecondHandColor Color of the minute hand. "255,0,0" by default.
• SecondHandLength Length in pixels of the minute hand. "90" by default.
• SecondHandWidth Widh in pixels of the minute hand. "1" by default.
• ShowSecondHand Show or not the second hand. Boolean value. "True" by default.
• SolidHands Show or not solid hands. Boolea value. "True" by default.

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

↑↑

npHourDigitalOptions

Set the digital options of an Hour object instance.

• Color Color of the Hour control. "0,0,0" by default.
• BgColor Background color of the Hour control. "0,0,0" by default.
• MilitaryTime Show or not military time. Boolean value. "True" by default.
• OffColor Color of the off digits. "76,78,16" by default.
• OnColor Color of the on digits. "255,255,0" by default.
• ShowSeconds Show or not the seconds. Boolean value. "True" by default.
• Size Hour control size. In the range 1 to 10. "2" by default.

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

↑↑

npHourModesOptions

Set the modes options of an Hour object instance. Here is the possible values for the Clock mode argument:

• cmClock With this the Clock act like a normal clock.
• cmCountdownTimer With this the Clock is a countdown clock.
• cmTimer With this the Clock act like a timer clock.

When use "cmCountdownTimer" you can use the npHourSetOffsets action in order to set the countdown values. Below is the list of the possible Display modes argument values:

• dmAnalog With this the Clock show as an analog clock.
• dmDigital With this the Clock shown as a digital clock.

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

↑↑

npHourGetOffsets

Get the currently stablished offsets numbers of an Hour object instance. Specify the appropiate variables in order to retrieve the offsets values. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npHourSetOffsets

Set the offsets numbers of an Hour object instance. Specify the offsets values to be set on the Clock. This offsets can be used when the Clock is in "countdown" mode. So, you can set, for example, 0 hour, 1 minute and 0 seconds, in order to prepare a 1 minute countdown. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npOnHourHour

Set a publication subroutine to be executed when an hour of an Hour object instance change. The Rectangle variable store the name of the rectangle in which the Clock is attached. Doing this you can share the same subroutine with more than one Clock. The Hour variable store the current Clock hour. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npOnHourMinute

Set a publication subroutine to be executed when an minute of an Hour object instance change. The Rectangle variable store the name of the rectangle in which the Clock is attached. Doing this you can share the same subroutine with more than one Clock. The Minute variable store the current Clock minute. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npOnHourSecond

Set a publication subroutine to be executed when an second of an Hour object instance change. The Rectangle variable store the name of the rectangle in which the Clock is attached. Doing this you can share the same subroutine with more than one Clock. The Second variable store the current Clock second. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npOnHourClick

Set a publication subroutine to be executed when an Hour object instance is clicked. The Rectangle variable store the name of the rectangle in which the Clock is attached. Doing this you can share the same subroutine with more than one Clock. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npOnHourDblClick

Set a publication subroutine to be executed when an Hour object instance is double clicked. The Rectangle variable store the name of the rectangle in which the Clock is attached. Doing this you can share the same subroutine with more than one Clock. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable store information about the error.

↑↑

npOnHourCountdown

Set a publication subroutine to be executed when an Hour object instance countdown is done. The Rectangle variable store the name of the rectangle in which the Clock is attached. Doing this you can share the same subroutine with more than one Clock. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] variable 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.

↑↑