GEOS SDK TechDocs
|
| 
2.9 Suspending and Unsuspending
| 
3 Exported Message Ranges
MSG_META_GET_HELP_FILE, MSG_META_SET_HELP_FILE, MSG_META_BRING_UP_HELP
These help messages are contained within MetaClass to allow help files within any object in the GEOS system.
void MSG_META_GET_HELP_FILE(
char *buf);
This message returns the name of the help file attached to the object sent this message. If no help file is found, the default
MetaClass
handler walks up the tree.
Source: Unrestricted.
Destination: Object in object tree containing help.
Parameters: buf Pointer to buffer to store the help file name.
Return: Buffer filled in.
Interception: The default handler walks up the tree; you may intercept to change the help file for a branch.
void MSG_META_SET_HELP_FILE(
char *buf);
This message sets the help file for the object sent this message.
Source: Unrestricted, though generally an object sends this to itself.
Destination: An object within a tree.
Parameters: buf Pointer to help file name. This buffer's size must be at least FILE_LONGNAME_BUFFER_SIZE.
Interception: Generally not intercepted.
void MSG_META_BRING_UP_HELP();
This message finds a help context for the current object tree and sends a notification to bring up help with that context.
Source: Unrestricted, though generally an object sends this to itself.
Destination: An object within a tree.
Interception: The default handler for this message walks up the visual tree (not the generic tree) eventually finding a
GenClass
object with ATTR_GEN_HELP_CONTEXT. You may intercept at any level to change the help context for a branch.
GEOS SDK TechDocs
|
| 2.9 Suspending and Unsuspending
| 3 Exported Message Ranges