Class Documentation

Name:Keymaker
Version:1.0
ID:ID_KEYMAKER
Status:Unspecified
Category:Command/Tool
Date:December 2001
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2001. All rights reserved.
Short:  Generates keymap files from user defined configuration



Actions

The Keymaker class supports the following actions:

Activate  Runs the keymap maker and prints the results.
ClosingTag  If the object is non-static, this action will run the keymap maker process and then the object will self-destruct.

Methods

The Keymaker class implements the following methods:

About  Prints summarised information about the Keymaker class.

Structure

The Keymaker object consists of the following public fields:

Location  Must refer to the location of a keymap configuration file.
Output  Set this field to give the Keymaker an object to send output to.
Method:About()
Short:Prints summarised information about the Keymaker class.

If this method is called the Keymaker object will print a summary of what the Keymaker class does, who wrote it, copyright information and so on.

Result
ERR_Okay  The method executed successfully.
ERR_FieldNotSet  The Output field has not been set.

 

Field:Location
Synonyms:Src
Short:Must refer to the location of a keymap configuration file.
Type:STRING
Status:Read/Write

Before a Keymaker object can be activated, you must give it a configuration file to process. This requires that you set the Location field so that it refers to a keymap configuration file.

 

Field:Output
Short:Set this field to give the Keymaker an object to send output to.
Type:OBJECTID
Status:Read/Write

The Output field must be set in order for a Keymaker object to process the commands sent from the user. If it is not set then commands will not be executed when the Keymaker object is Activated. The Output object must accept text-based information via data channels in order for the data to be interpreted correctly. If the Output object does not support text based information, the Keymaker will still process the command but the user will not receive any text based output.

It is recommended that this field points to an object that is a member of the TextList class.