spreadSheetEditor is undoable, queryable, and editable.
This command creates a new spread sheet editor in the
current layout.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
allAttr(aa)
|
boolean
|
|
|
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.
|
|
control(ctl)
|
boolean
|
|
|
Query only. Returns the top level control for this editor.
Usually used for getting a parent to attach popup menus.
Caution: It is possible for an editor to exist without a
control. The query will return "NONE" if no control is present.
|
|
defineTemplate(dt)
|
string
|
|
|
Puts the 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.
|
|
docTag(dtg)
|
string
|
|
|
Attaches a tag to the editor.
|
|
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.
|
|
exists(ex)
|
boolean
|
|
|
Returns whether the
specified object exists or not. Other flags are ignored.
|
|
filter(f)
|
string
|
|
|
Specifies the name of an itemFilter object to be used with this editor.
This filters the information coming onto the main list
of the editor.
|
|
fixedAttrList(fal)
|
[string,...]
|
|
|
Forces the editor to only display attributes with the
specified names.
|
|
forceMainConnection(fmc)
|
string
|
|
|
Specifies the name of a selectionConnection object that 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.
|
|
highlightConnection(hlc)
|
string
|
|
|
Specifies the name of a selectionConnection object that
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.
|
|
keyableOnly(ko)
|
boolean
|
|
|
Limits the displayed attributes to be those that are keyable.
True by default
|
|
lockMainConnection(lck)
|
boolean
|
|
|
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.
|
|
longNames(ln)
|
boolean
|
|
|
Controls whether the attributes are displayed using their
long names or their short names.
|
|
mainListConnection(mlc)
|
string
|
|
|
Specifies the name of a selectionConnection object that the
editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
|
|
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.
|
|
panel(pnl)
|
string
|
|
|
Specifies the panel for this editor. By default if
an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor does not 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.
|
|
precision(pre)
|
int
|
|
|
Specifies the maximum number of digits displayed to the right
of the decimal place. Can be 0 to 20.
|
|
selectedAttr(sla)
|
boolean
|
|
|
Returns a list of all the attribute names
that are selected. This flag is ignored when not being queried.
|
|
selectionConnection(slc)
|
string
|
|
|
Specifies the name of a selectionConnection object that 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 changes.
|
|
showShapes(ss)
|
boolean
|
|
|
If true, when transforms are selected their shapes will
be displayed instead.
|
|
stateString(sts)
|
boolean
|
|
|
Query only flag. Returns the MEL command that will create an
editor to match the current editor state. The returned command string
uses the string variable $editorName in place of a specific name.
|
|
unParent(up)
|
boolean
|
|
|
Specifies that the editor should be removed from its layout.
This cannot be used in query mode.
|
|
unlockMainConnection(ulk)
|
boolean
|
|
|
Unlocks the mainConnection, effectively restoring the original
mainConnection (if it is still available), and dynamic updates.
|
|
updateMainConnection(upd)
|
boolean
|
|
|
Causes a locked mainConnection to be updated from the orginal
mainConnection, but preserves the lock state.
|
|
useTemplate(ut)
|
string
|
|
|
Force the command to use a command template other than
the current one.
|
|