hdicoreMain.h File Reference

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

#include "hdicoreTypes.h"

Include dependency graph for hdicoreMain.h:

This graph shows which files directly or indirectly include this file:

Functions
void	hdi::core::pluginLoaded ()
	Write this function yourself to receive a call immediately after your plugin dynamic library is loaded by the parent application (i.e. before setup/startup has begun)
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.
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)
__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.

Detailed Description

Header file for various plugin entry points.

Copyright

Hot Door, Inc. 2010-2019

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 any remaining memory that your plugin allocated before it is unloaded.

pluginLoaded()

void hdi::core::pluginLoaded

(

)

Write this function yourself to receive a call immediately after your plugin dynamic library is loaded by the parent application (i.e. before setup/startup has begun)

Author

GW

Date

01/2018

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 perform pre-setup/pre-startup tasks (if needed). This is probably most applicable to Photoshop, where any non-action plugin does not receive a startup message until receiving its first message from the app (due to a user action).

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.