spreadSheetEditor

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

Synopsis

spreadSheetEditor [-allAttr] [-attrRegExp string] [-control] [-defineTemplate string] [-docTag string] [-execute string] [-exists] [-filter string] [-fixedAttrList string[]] [-forceMainConnection string] [-highlightConnection string] [-keyableOnly boolean] [-lockMainConnection] [-longNames boolean] [-mainListConnection string] [-niceNames boolean] [-panel string] [-parent string] [-precision int] [-selectedAttr] [-selectionConnection string] [-showShapes boolean] [-stateString] [-unParent] [-unlockMainConnection] [-updateMainConnection] [-useTemplate string] [name]

spreadSheetEditor 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)
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt)	string
Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
-useTemplate(-ut)	string
Force the command to use a command template other than the current one.
-panel(-pnl)	string
Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it is in is deleted.
-parent(-p)	string
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
-unParent(-up)
Specifies that the editor should be removed from its layout. This cannot be used with query.
-control(-ctl)
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible, at times, for an editor to exist without a control. This flag returns "NONE" if no control is present.
-mainListConnection(-mlc)	string
Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
-forceMainConnection(-fmc)	string
Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
-selectionConnection(-slc)	string
Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes changes, the editor updates to show the change.
-highlightConnection(-hlc)	string
Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all editors have a highlight list. For those that do, it is a secondary selection list.
-filter(-f)	string
Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.
-lockMainConnection(-lck)
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor. Further changes to the original mainConnection are ignored.
-stateString(-sts)
Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
-unlockMainConnection(-ulk)
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
-updateMainConnection(-upd)
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
-docTag(-dtg)	string
Attaches a tag to the Maya editor.
-niceNames(-nn)	boolean
Controls whether the attribute names will be displayed in a more user-friendly, readable way. When this is on, the longNames flag is ignored. When this is off, attribute names will be displayed either long or short, according to the longNames flag. Default is on. Queried, returns a boolean.
-longNames(-ln)	boolean
Controls whether the attributes are displayed using their long names or their short names.
-precision(-pre)	int
Specifies the maximum number of digits displayed to the right of the decimal place. Can be 0 to 20.
-keyableOnly(-ko)	boolean
Limits the displayed attributes to be those that are keyable. True by default
-showShapes(-ss)	boolean
If true, when transforms are selected their shapes will be displayed instead.
-fixedAttrList(-fal)	string[]
Forces the editor to only display attributes with the specified names.
-selectedAttr(-sla)
Returns a list of all the attribute names that are selected. This flag is ignored when not being queried.
-allAttr(-aa)
Returns a list of all the attribute names currently being displayed. This flag is ignored when not being queried.
-attrRegExp(-are)	string
Filter the current displayed attribute names. This expression matches the case-insensitive substring of attribute names.
-execute(-exe)	string
Immediately executes the command string once for every selected cell in the spreadSheet. Before the command is executed, "#A" is substituted with the name of the cell's attribute, "#N" is substituted with the name of the cell's node, and "#P" is substituted with the full path name of the node.

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

string $window = `window -widthHeight 400 300`;
paneLayout;
string $activeList = `selectionConnection -activeList`;
spreadSheetEditor -mainListConnection $activeList;
showWindow $window;