pymel.core.windows.componentEditor¶

componentEditor(*args, **kwargs)¶

This command creates a new component editor in the current layout.

Flags:

Long Name / Short Name		Argument Types	Properties
control / ctl		bool
	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 NONEif no control is present.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and arguments 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		unicode
	Attaches a tag to the editor.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
filter / f		unicode
	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		unicode
	assigns a float field that the component editor will use for editing groups of values.
floatSlider / fs		unicode
	assigns a float slider that the component editor will use for editing groups of values.
forceMainConnection / fmc		unicode
	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		bool
	Hides path name of displayed element. By default this flag is set to false.
hideZeroColumns / hzc		bool
	Hides columns whose elements are all zero. By default this flag is set to false.
highlightConnection / hlc		unicode
	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		bool
	Prevents the editor from responding to changes in the active list. Independent of selection connection.
lockMainConnection / lck		bool
	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		unicode
	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		unicode, unicode, unicode
	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		bool
	returns the total number of operation types known to the component editor.
operationLabels / ol		bool
	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		unicode
	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		unicode
	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		unicode
	Removes the tab based on the set provided
selected / sl		bool
	Returns a list of strings, containing the labels of the currently selected columns
selectionConnection / slc		unicode
	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, unicode
	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		bool
	Restricts the display to columns that are in the current active list.
showSelected / ss		bool
	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		bool
	Controls alphabetical (true), or hierarchical sorting of columns
stateString / sts		bool
	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		bool
	Specifies that the editor should be removed from its layout. This cannot be used in query mode.
unlockMainConnection / ulk		bool
	Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection / upd		bool
	Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.componentEditor

Example:

import pymel.core as pm

# componentEditorWindow is a MEL procedure so need to call through MEL.
import maya.mel
maya.mel.eval('componentEditorWindow()')
# Result: u'componentEditorWinComponEditor' #
pm.componentEditor( 'componentEditorWinComponEditor', q=True, ctl=True )
# Result: u'componentEditorWin|compEdMenLayout|compEdForm|compEdFrame|formLayout52|componentEditorWinComponEditor' #