assignCommand

Show frames

Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

assignCommand [-addDivider string] [-altModifier] [-annotation string] [-command script] [-commandModifier] [-ctrlModifier] [-data1 string] [-data2 string] [-data3 string] [-delete int] [-dividerString string] [-factorySettings boolean] [-index int] [-keyString string] [-keyUp] [-name] [-numDividersPreceding int] [-numElements] [-optionModifier] [-sortByKey boolean] [-sourceUserCommands] int

assignCommand is undoable, queryable, and editable.

This command is obsolete for setting new hotkeys, instead please use the "hotkey" command.

Return value

None

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
-addDivider(-ad)	string
Appends an "annotated divider" item to the end of the list of commands.
-altModifier(-alt)
This flag specifies if an alt modifier is used for the key.
-annotation(-ann)	string
The string is the english name describing the command.
-command(-c)	script
This is the command that is executed when this object is mapped to a key or menuItem.
-commandModifier(-cmd)
This flag specifies if a command modifier is used for the key. This is only available on systems which support a separate command key.
-ctrlModifier(-ctl)
This flag specifies if a ctrl modifier is used for the key.
-data1(-da1)	string
Optional, user-defined data strings may be attached to the nameCommand objects.
-data2(-da2)	string
Optional, user-defined data strings may be attached to the nameCommand objects.
-data3(-da3)	string
Optional, user-defined data strings may be attached to the nameCommand objects.
-delete(-d)	int
This tells the Manager to delete the object at position index.
-dividerString(-ds)	string
If the passed index corresponds to a "divider" item, then the divider's annotation is returned. Otherwise, a null string is returned.
-factorySettings(-fs)	boolean
This flag sets the manager back to factory settings.
-index(-i)	int
The index of the object to operate on. The index value ranges from 1 to the number of name command objects.
-keyString(-k)	string
This specifies a key to assign a command to in edit mode. In query mode this flag returns the key string, modifiers and indicates if the command is mapped to keyUp or keyDown.
-keyUp(-kup)
This flag specifies if the command is executed on keyUp or keyDown.
-name(-n)
The name of the command object.
-numDividersPreceding(-ndp)	int
If the index of a namedCommand object C is passed in, then this flag returns the number of "divider" items preceding C when the namedCommands are sorted by category.
-numElements(-num)
This command returns the number of namedCommands in the system. This flag doesn't require the index to be specified.
-optionModifier(-opt)
This flag specifies if an option modifier is used for the key.
-sortByKey(-sbk)	boolean
This key tells the manager to sort by key or by order of creation.
-sourceUserCommands(-suc)
This command sources the user named command file.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Print out all the names of the named command objects and the
// hotkeys attached to them.
//
int $index, $count = `assignCommand -query -numElements`;
string $keyString[];
print ("There are " + $count + " named command objects.\n");
for ($index = 1; $index <= $count; $index++) {
    $keyString = `assignCommand -query -keyString $index`;
    if (0 < size($keyString) && $keyString[0] != "NONE") {
	    print (`assignCommand -query -name $index` + " (");
        if ("1" == $keyString[2]) {
            print ("Ctrl+");
        }
        if ("1" == $keyString[1]) {
            print ("Alt+");
        }
        if ("1" == $keyString[5]) {
            print ("Command+");
        }

        print ($keyString[0]);

        if ("1" == $keyString[3]) {
            print (" Release");
        }
        if ("1" == $keyString[4]) {
            print (" KeyRepeat");
        }
	    print (")\n");
    }
}