npShow plugin

npShowCreate

Create a new Show object instance and attach it to a NeoBook rectangle object. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowDestroy

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

↑↑

npShowDestroyAll

Destroy all currently availables instances of Show objects.

↑↑

npShowStyles

Get the names of all available Show object transitions styles. The Styles variable store a NeoBook Array with all available transitions styles names. The Styles count variable store the number of items in the Styles variable. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowLoad

Load an image to a Show object. The image is then prepared to be showed when the transition start. Supported images are BMP, JPG, PNG and GIF. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error. See also npOnShowStart.

↑↑

npShowStart

Start a Show object image transition. If npShowManual is not called or set to "False", the transition start automatically. If "Manual" feature is active, then the object wait for npShowProgress calls. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError].

↑↑

npShowStop

Stops a running Show object transition. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError].

↑↑

npShowClear

Clear the content area of a Show object. This action not remove the possible image loaded into the Show object. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError].

↑↑

npShowIsBusy

Find if a Show object transition is busy -running. The result variable store "True" if a Show object transition is running, or "False" if not. In this last case the [LastError] can contain information if any error occurr.

↑↑

npShowIsEmpty

Find if a Show object image is empty: have not load any image to it. The result variable store "True" if a Show object transition is running, or "False" if not. In this last case the [LastError] can contain information if any error occurr.

↑↑

npShowStyle

Set the transition style of a Show object. The style that can be applied when the transition start. You can choose one of the 173 available transition styles from the action properties form, wich include Show object previewer that show your choosed transition style. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error. See also npShowStyles.

↑↑

npShowStep

Determines the amount of change in Show object Progress in automatic transitions. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowColor

Set the color of a Show object. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowCenter

If set to true and Show object client area is larger than the loaded image, the image will be centered within the Show object client area. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowDelay

Set the amount of delay in milliseconds before showing the next frame of a Show object transition. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowManual

Determines whether the Show object transition will be advanced manually. When this option is set to "True", the Show object does not advance the transition automatically but wait for npShowProgress calls. When this option is set to "False", the Show object automatically advances the transition.

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

↑↑

npShowExact

When set this Show object option to "True", the Show object transition of the image will take almost (0.01 * Step * Delay) milliseconds to complete. Otherwise, it may take more time for large images or slow machines. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowFrame

Use this action to put a frame of a Show object image. You can determine the width and the frame color. By default no frame is used. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowReverse

When set this Show object option "True", automatic transitions plays in reverse. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowStretch

When set this Show object option "True", when the Show object client area is larger than the loaded image, the image it will be stretched (or shrinked) to fit within the Show object client area. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowAutoSize

When set this Show object option "True", automatically sizes the Show object to the size of the loaded image if any is loaded. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowOverDraw

Determines whether the Show object draws a new transition on the last ones. When this Show object option is set to "True", and current image and previous image has same dimensions, the Show object draws the new transition over the last one. Otherwise before starting a new transition, the Shwo object clears its screen to background.

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

↑↑

npShowProgress

Use this action to forward or backward a manual Show object transition. See also npOnShowStart and npShowManual. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npShowBgPicture

Set the Show object background image and the background type. Supported images are BMP, JPG, PNG and GIF. The background type can be one of the following values:

• bmNone Ignores the background image.
• bmTiled Fills the Show object client area by the background image as tiled.
• bmStretched Fills the Show object client area by stretching (or shrinking) the background image.
• bmCentered Draws the background image on the center of the Show object client area.

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

↑↑

npShowProportional

Indicates whether the image should be changed, without distortion, so that it fits the bounds of the Show object. When set this Object option to "True", images that are too large to fit in the Show object are scaled down (while maintaining the same aspect ratio) until they fit in the Show object client area. Images that are too small are displayed normally.

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

↑↑

npOnShowStart

Set a NeoBook subroutine to be executed when a Show object transition start. In this subroutine you can load a new image to a Show object, for the next Show object transition. The rectangle variable store the name of the rectangle on wich Show object is attached. See also npShowLoad and npShowStart. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnShowStop

Set a NeoBook subroutine to be executed when a Show object transition is aborted -stopped. The rectangle variable store the name of the rectangle on wich Show object is attached. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnShowClick

Set a NeoBook subroutine to be executed when the user click on a Show object client area. The rectangle variable store the name of the rectangle on wich Show object is attached. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnShowChange

Set a NeoBook subroutine to be executed when a Show object image has been changed. The rectangle variable store the name of the rectangle on wich Show object is attached. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnShowComplete

Set a NeoBook subroutine to be executed when a Show object transition has completed. If the transition has stopped (see npShowStop) this Show object event never occurr. The rectangle variable store the name of the rectangle on wich Show object is attached. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnShowDblClick

Set a NeoBook subroutine to be executed when the user double click on a Show object client area. The rectangle variable store the name of the rectangle on wich Show object is attached. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnShowProgress

Set a NeoBook subroutine to be executed when a Show object transition progress position changed. The rectangle variable store the name of the rectangle on wich Show object is attached. The Progress variable store the percent done of the Show object transition frames. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain 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.

↑↑