Class for creating the OpenAlias interface to Alias
#include <AlFunctionHandle.h>
class AlFunctionHandle
AlFunctionHandle();
virtual ~AlFunctionHandle();
statusCode create( const char*, const char* );
statusCode create( const char*, AlFunction * );
AlFunctionHandle& operator =( const AlFunctionHandle& );
int operator !() const;
statusCode setAttributeString( const char * );
statusCode setOptionBox( const char *, const char *, const char * = NULL );
statusCode setIconPath( const char* );
statusCode setHelpFile( const char* );
statusCode addToMenu( const char * );
statusCode appendToMenu( const char * );
statusCode removeFromMenu();
statusCode deleteObject();
This class provides a means to interface the OpenAlias application to the Alias user interface. An AlFunction class or one of its derivatives ( AlMomentaryFunction, AlContinuousFunction ) is required by the create method. Note that the string name of an Al*Function could also be specified in the create() method.
Destructor for the AlFunctionHandle class.
Constructor for the AlFunctionHandle class.
Assignment operator for the AlFunctionHandle class.
Allows you to use statements to check the validity of the handle, such as
if( functionhandle ) ....
Initializes the function handle given a popupLabel and a momentary function name (command).
< popupLabel - the string that will appear on the menu pop-up for this plug-in
< command - a character string which is the name of the momentary command. It must be unique.
sInvalidArgument - name or command was NULL
sAlreadyCreated - the handle has already been created
sSuccess - the handle was created
sFailure - the handle could not be created
sObjectInSet - a command with name 'command' already exists
Initializes the function handle given a name and a momentary function name (command).
< popupLabel - the string that will appear on the menu pop-up for this plug-in
< func - the set of functions (momentary or continuous)
sInvalidArgument - name or command was NULL
sAlreadyCreated - the handle has already been created
sSuccess - the handle was created
sFailure - the handle could not be created
Sets the string that will appear on the attribute line below the prompt line when the plug-in is selected from the menu.
< str - the string to appear in the attribute line
sInvalidArgument - str was NULL
sInvalidObject - the function handle has not been initialized
sSuccess - the attribute string was set successfully
Sets the option box for the plug-in. If the plug-in has no option box, then do not call this method. This method will fail if the scheme file described by the name and prefix does not exist. Normally, the 'schemeFileName' is the name of the file which defines the option box. If the 'schemeFileNamePrefix' parameter is NULL, then the 'schemeFileName' will be loaded relative to the path defined by the environment variable ALIAS_WORKENV. If the 'schemeFileNamePrefix' parameter is not NULL, then it will be added to the start of the 'schemeFileName'. The string formed by concatenating 'schemeFileName' to 'schemeFileNamePrefix' will be be used as the filename that will be loaded, i.e. the actual scheme file that is loaded will be equivalent to schemeFileNamePrefix/schemeFileName.
< schemeFileName - name of the Scheme file which defined the option box
< editorName - the name given to the ui-editor function in the Scheme file
< schemeFileNamePrefix - the name of the directory to prefix to schemeFileName
sInvalidObject - function handle is invalid
sInvalidArgument - one of the arguments was NULL or the file does not exist
sFailure - the function handle is already attached to a menu
sSuccess - the option box was successfully set for the plug-in
Adds a plug-in to the bottom of the menu.
< menuname - the name of the menu the plug-ins will be added to
sInvalidArgument - menuname was NULL
sAlreadyCreated - the function handle is already attached to a menu
sObjectNotAMember - the menu name was not valid
sFailure - failed to attach the plug-in to the menu
Adds a plug-in to the top of the menu.
< menuname - the name of the menu the plug-ins will be added to
sInvalidArgument - menuname was NULL
sAlreadyCreated - the function handle is already attached to a menu
sObjectNotAMember - the menu name was not valid
sFailure - failed to attach the plug-in to the menu
This method installs a plug-in on a menu.
< menuname - the name of the menu the plugins will be placed on.
< topOfMenu - if TRUE, the plug-in is placed at the top of the menu. If FALSE, the plug-in is placed at the bottom of the menu.
sInvalidArgument - menuname was NULL
sAlreadyCreated - The function handle is already attached to a menu.
sObjectNotAMember - The menu name was not valid.
sFailure - Failed to attach the plugin to the menu.
Removes the function handle from its previously attached menu.
sFailure - the handle is not attached to a menu
sSuccess - the handle was removed from the menu
Sets the pathname to load the icon files from. Normally icons are loaded from ALIAS_BITMAP_LOCATION. In the specified path, there should be two directories:
small medium
In the small/ directory, there should be an icon file ending in the function name followed by '.S' In the medium/ directory, there should be an icon file ending in the function name followed by '.M' For example, if the function name is 'MySphere' and the icon path is '/usr/myicons', then the following files should exist:
/usr/myicons/small/MySphere.S /usr/myicons/medium/MySphere.M
sFailure - the path could not be set
sSuccess - the path was set for this function handle
Sets the filename to load the help file from.
sFailure - the file could not be set
sSuccess - the file was set for this function handle
Removes the function handle from the menu and invalidates it.
sFailure - the handle could not be removed from the menu
sSuccess - the handle was successfully removed