componentEditor is undoable, queryable, and editable.
This command creates a new component editor
in the current layout.
In query mode, return type is based on queried flag.
| Long name (short name) |
Argument types |
Properties |
|
-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 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.
|
|
-exists(-ex)
|
|
|
|
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.
|
|
-floatField(-ff)
|
string
|
|
|
assigns a float field that the component editor will
use for editing groups of values.
|
|
-floatSlider(-fs)
|
string
|
|
|
assigns a float slider that the component editor will
use for editing groups of values.
|
|
-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.
|
|
-hidePathName(-hpn)
|
boolean
|
|
|
Hides path name of displayed element. By default
this flag is set to false.
|
|
-hideZeroColumns(-hzc)
|
boolean
|
|
|
Hides columns whose elements are all zero. By default
this flag is set to false.
|
|
-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.
|
|
-lockInput(-li)
|
boolean
|
|
|
Prevents the editor from responding to changes in
the active list. Independent of selection connection.
|
|
-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.
|
|
-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.
|
|
-newTab(-nt)
|
string string string
|
|
|
Creates a new tab, named by the first argument, based on an existing tab, given as the second argument
using elements from a set, given in the third argument
|
|
-operationCount(-oc)
|
|
|
|
returns the total number of operation types
known to the component editor.
|
|
-operationLabels(-ol)
|
|
|
|
returns a string array containing the names for all
operation types known to the editor.
|
|
-operationType(-ot)
|
int
|
|
|
Tells the editor which of its known operation types
it should be performing. This is a 0-based index.
|
|
-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.
|
|
-removeTab(-rt)
|
string
|
|
|
Removes the tab based on the set provided
|
|
-selected(-sl)
|
|
|
|
Returns a list of strings, containing the labels of the currently selected columns
|
|
-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.
|
|
-setOperationLabel(-sol)
|
int string
|
|
|
uses the string as the new name for the existing operation type
specified by the integer index. Note that there is no messaging
system which allows UI to be informed of changes made by this flag.
|
|
-showObjects(-so)
|
|
|
|
Restricts the display to columns that are in the current active list.
|
|
-showSelected(-ss)
|
boolean
|
|
|
Restricts the display to those columns which are currently selected. By default
this flag is set to false, so all columns are selected. The results from this flag
obey the current -hideZeroColumns setting.
|
|
-sortAlpha(-sa)
|
boolean
|
|
|
Controls alphabetical (true), or hierarchical sorting of columns
|
|
-stateString(-sts)
|
|
|
|
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)
|
|
|
|
Specifies that the editor should be removed from its layout.
This cannot be used in query mode.
|
|
-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.
|
|
-useTemplate(-ut)
|
string
|
|
|
Force the command to use a command template other than
the current one.
|
|
Flag can be used more than once in a command.