/*----------------------------------------------------------------------------
Copyright © 1998 Object International Software GmbH
----------------------------------------------------------------------------*/
package oisoft.togetherx.scriptapi;

//------------------------------------------------------------------------------
/**                                                                      
 ** In order to register a script in the "Tools" menu of Together/J      
 ** IDE, the script must implement the <i>ScriptResources</i> interface. 
 **                                                                      
 ** When a script is loaded at startup, Together checks                  
 ** whether the script class implements the <i>ScriptResources</i>       
 ** interface and, if yes, adds a menu item. The menu item name is       
 ** returned by <i>getMenuItem()</i> method.                             
 ** @version  2.1.01  28.05.1998                                           
 ** @author   Andrei Ivanov                                              
 ** @see      Script                                                     
 */
public interface ScriptResources
{
  /** The <i>getMenuItem()</i> method should return the string 
  for menu item used to invoke the script. 
  Using this method you can define a keyboard shortcut for script 
  invocation as well. Append the string with the '|' symbol and 
  a letter. The shortcuts have Ctrl modifier.<br>
  For example, return "Hello|A" for defining "Hello" as menu
  item and Ctrl-A as shortcut.
  @return Menu item resource string
  */
  public String getMenuItem();
};
//------------------------------------------------------------------------------