menuSet

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

Synopsis

menuSet [-addMenu string] [-allMenuSets] [-currentMenuSet string] [-exists string] [-hotBoxVisible boolean] [-insertMenu string uint] [-label string] [-menuArray string[]] [-moveMenu string uint] [-moveMenuSet string uint] [-numberOfMenuSets] [-numberOfMenus] [-permanent boolean] [-removeMenu string] [-removeMenuSet string] [object]

menuSet is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-exists(-ex)	string
Returns whether the specified menu set exists. This query flag supports string arguments. ie. menuSet -q -exists animationMenuSet; In query mode, this flag needs a value.
-label(-l)	string
The label of the current menu set. Query returns string.
-addMenu(-am)	string
Appends a menu onto the end of the current menu set.
-insertMenu(-im)	string uint
Inserts a menu into a specified index in the current menu set.
-moveMenu(-mm)	string uint
Moves a specified menu from the current menu set to a new position.
-removeMenu(-rm)	string
Removes a specified menu from the current menu set.
-numberOfMenus(-nm)
The mumber of menus in the current menu set. Query returns int.
-menuArray(-ma)	string[]
An array of menu names (strings) in the current menu set. Query returns string array.
-currentMenuSet(-cms)	string
The currently active menu set under which all operations affect (append, insert, remove, etc.). Query returns string.
-moveMenuSet(-mms)	string uint
Moves a specified menu set to another index.
-removeMenuSet(-rms)	string
Removes the specified menu set object from the list of all menu sets.
-numberOfMenuSets(-nms)
Number of menuSets in total. Query returns int.
-allMenuSets(-ams)
Returns an array of the all the menu set object names in use. Query returns string array.
-hotBoxVisible(-hbv)	boolean
Whether this menu set should be displayed in the hotbox as well as in the main menubar.
-permanent(-p)	boolean
Whether this menu set can be removed.

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

  // creating a new menu set;
  menuSet -label "newMenuSet Label" newMenuSetObjName;

// using commands on a current menu set
      // first find the menu set if you don't know the name of it
      string $animMS = `findMenuSetFromLabel "Animation"`;

      // menu sets can be queried like normal commands
      string $animMenus[] = `menuSet -q -menuArray $animMS`;

      // but editing the set requires either setting the current menu set...
      // (notice that the menu set comamnds following specify no specific menu set)
      menuSet -currentMenuSet $animMS;
      menuSet -removeMenu $animMenus[0];
      // : (other commands which pertain to the animation menu set)

      // .. or temporarily setting the menu set to work on (does not affect current menu set)
      // (notice that every command following specifies the specific set to apply operations to)
      string $polyMS = `findMenuSetFromLabel "Polygons"`;
      string $polyMenus[] = `menuSet -q -menuArray $polyMS`;
      menuSet -removeMenu $polyMenus[0] -insertMenu $polyMenus[1] 0 $polyMS;

      // .. where the following commands still affect the animation menu set
      string $animMenus[] = `menuSet -q -menuArray`;

      // if you need to find a specific menu...
      string $deformMenu = `findMenuFromMenuSet $animMS "Deform"`;

      // moving a menu from one spot to another
      // (ie. moving the Deform Menu to the front of the list)
      menuSet -moveMenu $deformMenu 0;