c4d_help.h File Reference

Typedefs
typedef Bool(*	PluginHelpDelegate) (const maxon::String &opType, const maxon::String &baseType, const maxon::String &group, const maxon::String &property)

Functions
Bool	RegisterPluginHelpDelegate (Int32 pluginId, PluginHelpDelegate delegate)
void	OpenHelpBrowser (const maxon::String &opType, const maxon::String &baseType, const maxon::String &group, const maxon::String &property)

Typedef Documentation

PluginHelpDelegate

typedef Bool(* PluginHelpDelegate) (const maxon::String &opType, const maxon::String &baseType, const maxon::String &group, const maxon::String &property)

Plugin help support callback. Can be used to display context sensitive help when the user selects "Show Help" for an object or attribute.

Note

All names are always uppercase.

Warning

Only return true for your own object types.

Parameters

[in]	opType	The object type name, for example "OATOM".
[in]	baseType	The name of the base object type that opType is derived from, usually the same as opType.
[in]	group	The name of the group in the attribute manager, for example "ID_OBJECTPROPERTIES".
[in]	property	The name of the object property, for example "ATOMOBJECT_SINGLE".

Returns

true if if the plugin can display help for this request, otherwise false.

Function Documentation

RegisterPluginHelpDelegate()

Bool RegisterPluginHelpDelegate	(	Int32	pluginId,
		PluginHelpDelegate	delegate
	)

Registers the delegate for plugin help support.

Parameters

[in]	pluginId	A unique plugin ID. Must be obtained from http://www.plugincafe.com
[in]	delegate	The help handler for this plugin.

Returns

true if successful, otherwise false.

OpenHelpBrowser()

void OpenHelpBrowser	(	const maxon::String &	opType,
		const maxon::String &	baseType,
		const maxon::String &	group,
		const maxon::String &	property
	)

Opens the help browser for the indicated topic.

Note

All names are always uppercase.

Parameters

[in]	opType	The object type name, for example "OATOM".
[in]	baseType	The name of the base object type that opType is derived from, usually the same as opType.
[in]	group	The name of the group in the attribute manager, for example "ID_OBJECTPROPERTIES".
[in]	property	The name of the object property, for example "ATOMOBJECT_SINGLE".