MM Developer's Guide
MM Interfaces | MM Methods | MM Types and Misc API
Interface ID: IID_IMoaMmXTool
Pointer type:
PIMoaMmXTool
Inheritance: IMoaUnknown
Header file: mmixtool.h
The IMoaMmXTool interface
provides a mechanism for providing authoring-time tools that are
listed in the Xtras menu. The Director Developer's
Guide has more on implementing Tools Xtras.
In addition to this interface, Tools Xtras implement the IMoaRegister interface to inform the host application of its capabilities,
menu name, and other details. This interface is called by the
host application to get the enable state of your tool (unless
you're "alwaysEnabled")
and to invoke the tool.
- GetEnabled(PIMoaMmXToolThis,
- PMoaMmEnabledStatepEnabledState)
This
IMoaMmXTool
interfacepEnabledState
kMoaErr_NoErr | Succeeded, value at pEnabledState set |
kMoaMmErr_NotImplemented | Tool is specified as "alwaysEnabled" in registry. |
Value | Description |
kMoaMmEnabledState_Disabled | Tool cannot be invoked now |
kMoaMmEnabledState_Enabled | Tool can be invoked now |
If you registered a value of TRUE for the kMoaMmDictKey_AlwaysEnabled key in your IMoaRegister::Register() implementation, the host application assumes you're
always enabled and never calls this method.
- Invoke(PIMoaMmXToolThis)
This
IMoaMmXTool
interfacekMoaErr_NoErr | Succeeded, tool invoked |
kMoaMmErr_ToolDisabled | Failed because tool is disabled |
kMoaErr_OutOfMem | Failed due to memory error |
kMoaMmErr_InternalError | Failed due to internal error |