deoEnableTrigger

deoEnableTrigger(
g_application
[ l_args ]
)
=> t / nil

Description

Determines if the application is enabled for use by the current user. The enable trigger will normally do any appropriate security checks necessary to make this determination. Design Editor calls the enable trigger before installing a plugin and then installs the plugin only if this trigger returns a non-nil value. The default deoEnableTrigger permits a plugin to be installed on top of an application as long as it is pluggable to the application.

If licensing or other restriction is desired, then the plugin code should define the enable trigger. A subplugin application should call next method in its deoEnableTrigger if it requires the licensing of the super plugin application.

Arguments

g_application

Specifies an instance (stdobj) of the plugin

l_args

Single argument, which is a disembodied property list. l_args->action property equals ‘activate in addition to the properties specified for DE main application triggers. The trigger argument (l_args) for DE plugin is  similar to the Trigger Argument given to DE main application triggers. Two new values are added for the args->action property, they are 'activate, and 'deactivate. These are used for installing and removing a plugin in a window, respectively.

Value Returned

t	Returns t if the specified application passes security check.
nil	Returns nil if the application should not be installed.

Examples

defmethod( deoEnableTrigger ((this MyPlugin) @optional args)

    (and (callNextMethod this args) (check_my_license this)))

Return to top