Hot Door CORE  0.7.1
Adobe® Illustrator® Plug-in Library
Functions
hdicoreMain.h File Reference

Header file for various Illustrator plugin entry points. More...

Functions

bool hdi::core::pluginSetup (Plugin *const plugin_)
 Write this function yourself to receive a call immediately after the Plugin instance is instantiated and before Plugin::__startup() is called. More...
 
void hdi::core::pluginDestroy (Plugin *const plugin_)
 Write this function yourself to receive a call immediately after the Plugin instance has been shutdown but before it is unloaded (after Plugin::__shutdown() is called). More...
 
__HDI_CORE_EXPORT __MainError PluginMain (const char *caller_, const char *selector_, void *data_)
 Main entry point for all plugins (required by Illustrator). This is called whenever a plugin should perform some action or respond to some message. More...
 

Detailed Description

Header file for various Illustrator plugin entry points.

Function Documentation

◆ pluginDestroy()

void hdi::core::pluginDestroy ( Plugin *const  plugin_)

Write this function yourself to receive a call immediately after the Plugin instance has been shutdown but before it is unloaded (after Plugin::__shutdown() is called).

Author
GW
Date
11/2013
Parameters
plugin_Current plugin object
Note
It is imperative that you define this function yourself as a consumer of this library! First of all, your plugin won't link without a definition, and this will be the only chance you've got to destroy and remaining memory that your plugin allocated before it is unloaded.

◆ PluginMain()

__HDI_CORE_EXPORT __MainError PluginMain ( const char *  caller_,
const char *  selector_,
void *  data_ 
)

Main entry point for all plugins (required by Illustrator). This is called whenever a plugin should perform some action or respond to some message.

Author
GW
Date
09/2013

◆ pluginSetup()

bool hdi::core::pluginSetup ( Plugin *const  plugin_)

Write this function yourself to receive a call immediately after the Plugin instance is instantiated and before Plugin::__startup() is called.

Author
GW
Date
09/2013
Parameters
plugin_Recently-instantiated plugin object
Returns
true if the setup process completes successfully, false otherwise
Note
It is imperative that you define this function yourself as a consumer of this library! First of all, your plugin won't link without a definition, and this will be the only chance you've got to set some basic callbacks on the plugin_ argument. Without doing so, you'll never receive startup, shutdown, tool, etc. messages!
When this function returns false, an error dialog will be shown at startup displaying the error code from the setupFailedErrorCode constant. It is recommended that in your production build you handle error conditions properly in your pluginSetup() definition, such that an end-user will never receive said error code.