preloadRefEd is undoable, queryable, and editable.
This creates an editor for managing which references will be read
in (loaded) and which deferred (unloaded) upon opening a file.
In query mode, return type is based on queried flag.
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. |
|
-selectFileNode(-sf) |
|
|
|
Query the currently selected load setting. Returns the id of
the currently selected load setting. This id can be used as an
argument to the selLoadSettings command. |
|