npPush plugin

About this plugin

This plugin put at your service the possibility to use advance buttons controls on your publications, who can be customized in several ways, using various gradients colors and styles, borders bevels, glyps images, wallpapers images and events.

Every button have default options and four states options: normal, hot, down and disabled states options. Like others NeoPlugins, you can use one or more Push objects (buttons) on your publications, customizing it separatelly, with shareable publication subroutines/events.

Thirparty

This plugin are imposible without the aid of this people:

Thanks a lot!

Plugin actions index

npPushCreate

Create a new instance of a Push object 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.

↑↑

npPushDestroy

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

↑↑

npPushDestroyAll

Destroy all previously Push objects instances and deattach from their NeoBook rectangles.

↑↑

npPushDefaultOptions

Set the default options of a Push object instance. This options affect to all states of the buttons, if you didn't specify the contrary on other plugin actions. Below you can see the list of default options names, possibles and default values:

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

↑↑

npPushNormalOptions

Set the normal state options of a Push object instance. This options affect only to the normal state of the buttons, if you didn't specify the contrary on other plugin actions. Below you can see the list of default options names, possibles and default values:

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

↑↑

npPushHotOptions

Set the hot state options of a Push object instance. This action can determine the same button properties that npPushNormalOptions action, but act when the state of the button are hot. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npPushDownOptions

Set the down state options of a Push object instance. This action can determine the same button properties that npPushNormalOptions action, but act when the state of the button are down. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npPushDisabledOptions

Set the disabled state options of a Push object instance. This action can determine the same button properties that npPushNormalOptions action, but act when the state of the button are disabled. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnPushClick

Set a publication subroutine to be executed when the specified Push object instance click event is fired. The Rectangle variable store the rectangle object who fired the event. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnPushEnter

Set a publication subroutine to be executed when the specified Push object instance mouse enter event is fired. The Rectangle variable store the rectangle object who fired the event. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnPushLeave

Set a publication subroutine to be executed when the specified Push object instance mouse leave event is fired. The Rectangle variable store the rectangle object who fired the event. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnPushMouseUp

Set a publication subroutine to be executed when the specified Push object instance mouse up event is fired. The Rectangle variable store the rectangle object who fired the event. The Button variable can store one of these values: mbLeft, mbRight, mbMiddle. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnPushMouseDown

Set a publication subroutine to be executed when the specified Push object instance mouse down event is fired. The Rectangle variable store the rectangle object who fired the event. The Button variable can store one of these values: mbLeft, mbRight, mbMiddle. 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:

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.

↑↑