pymel.core.windows.scriptTable

scriptTable(*args, **kwargs)

This command creates/edits/queries the script table control.

Maya Bug Fix:

• fixed getCellCmd to work with python functions, previously only worked with mel callbacks

  IMPORTANT: you cannot use the print statement within the getCellCmd callback function or your values will not be returned to the table

Flags:

Long name (short name)		Argument Types	Properties
annotation (ann)		unicode
	Annotate the control with an extra string value.
backgroundColor (bgc)		float, float, float
	The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
cellBackgroundColorCommand (cbc)		script
	Sets the script to call when it requires the background color of a cell. The procedure is called with 2 integer arguments specifying the row and column for which the value is required. The procedure should return an array of ints which is the RGB color value for the cell. The row and column numbers passed in are 1-based (ie. (1,1) is the upper left cell). The procedure should be of the form: global proc int[] procedureName(int $row, int $column) { return {255,0,0}; // return Red as cell background color }
cellChangedCmd (ccc)		script
	Sets the script to call when somebody has changed the value of a cell. The procedure is called with 2 integer arguments specifying the row and column for which the value was changed. The 3rd argument is the string which was entered into that cell. The procedure should return an integer value which indicates whether that value should be accepted (return 1 if yes, and 0 if no). The row and column numbers passed in are 1-based (ie. (1,1) is the upper left cell). The procedure should be of the form: global proc int procedureName(int $row, int $column, string $value)
cellForegroundColorCommand (cfc)		script
	Sets the script to call when it requires the foreground color of a cell. The procedure is called with 2 integer arguments specifying the row and column for which the value is required. The procedure should return an array of ints which is the RGB color value for the cell. The row and column numbers passed in are 1-based (ie. (1,1) is the upper left cell). The procedure should be of the form: global proc int[] procedureName(int $row, int $column) { return {0,0,0}; // return Black as Text color }
cellIndex (ci)		int, int
	used with cellValue , to give the index of row and column This flag and its argument must be passed to the command before the -q flag (see examples).
cellValue (cv)		unicode
	query and set the cell value on the table by the index of row and column referred in flag -cellIndex
clearRow (cr)		int
	Clear the contents for all the cells on the specified row. Any procedure specified by the -gcc flag will be called to populate the cleared cells The row number is 1-based (ie. the first row is 1 not 0).
clearTable (ct)		bool
	Clears the contents of all the cells in the table. Any procedure specified by the -gcc flag will be called to populate the cleared cells
columnFilter (cf)		int, unicode
	Filter the specified column with the string value provided. Set filter to colums 0 will apply the filter to all columns. The filter is case insensitive and support wildcards. Wildcard Matching: Wildcard matching is much simpler than full regexps and has only four features: c Any character represents itself apart from those mentioned below. Thus c matches the character c. ? Matches any single character. It is the same as . in full regexps. * Matches zero or more of any characters. It is the same as .* in full regexps. [...] Sets of characters can be represented in square brackets, similar to full regexps. Within the character class, backslash has no special meaning. (ie. you can search for “MyValue” with “y*u” or ”??Val??” or “[MyThe]Value” or any letters in “MyValue” The column number is 1-based (ie. the first row is 1 not 0).Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
columnWidth (cw)		int, int
	Set the width of the specified column The column number is 1-based (ie. the first column is 1 not 0).
columns (c)		int
	Set the number of columns in the table
defineTemplate (dt)		unicode
	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.
deleteRow (dr)		int
	Delete the specified row The row number is 1-based (ie. the first row is 1 not 0).
docTag (dtg)		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
dragCallback (dgc)		script
	Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys “dragControl”, “x”, “y”, “modifiers”. The “dragControl” value is a string and the other values are integers (eg the callback string could be “print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’”)
dropCallback (dpc)		script
	Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys “dragControl”, “dropControl”, “messages”, “x”, “y”, “type”. The “dragControl” value is a string and the other values are integers (eg the callback string could be “print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’”)
editable (ed)		bool
	The edit state of the table. By default, this flag is set to true, and the table can be edited. If false, then the table is ‘read only’ and cannot be typed into.
enable (en)		bool
	The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground (ebg)		bool
	Enables the background color of the control.
excludingHeaders (eh)		bool
	when querying the count for the rows or the columns , the number returned will not include the headers
exists (ex)		bool
	Returns true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn)		unicode
	Return the full path name of the widget, which includes all the parents
getCellCmd (gcc)		script
	Sets the script to call when it requires the contents of a cell. The procedure is called with 2 integer arguments specifying the row and column for which the value is required. The procedure should return a string which is the value for the cell. The row and column numbers passed in are 1-based (ie. (1,1) is the upper left cell). The procedure should be of the form: global proc string procedureName(int $row, int $column)
height (h)		int
	The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
insertRow (ir)		int
	Insert an empty row before the specified row. Any procedure specified by the -gcc flag will be called to populate the new new cells. The row number is 1-based (ie. the first row is 1 not 0).
isObscured (io)		bool
	Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.
label (l)		int, unicode
	Set the label of the specified column. The column number is 1-based (ie. the first column is 1 not 0).
manage (m)		bool
	Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
multiEditEnabled (mee)		int
	True: scriptTable support multi-editing function
noBackground (nbg)		bool
	Clear/reset the control’s background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfPopupMenus (npm)		bool
	Return the number of popup menus attached to this control.
parent (p)		unicode
	The parent layout for this control.
popupMenuArray (pma)		bool
	Return the names of all the popup menus attached to this control.
preventOverride (po)		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
rowHeight (rh)		bool
	Sets the height for each row in the scriptTable
rows (r)		int
	Set the number of rows in the table
selectedCells (sc)		<type ‘int’>, ...
	Select the cells or return the cells currently selected. This returns a list of indices, the first of each pair is the row, the second is the column, repeated for each cell selected The returned cell numbers are 1-based (ie. the first row is 1 not 0, the first column is 1 not 0).
selectedColumns (scs)		<type ‘int’>, ...
	select the columns or return the columns currently selected. This returns a list of indices of each column completely selected The returned column numbers are 1-based
selectedRow (sr)		bool
	The current row selected. The returned row number is 1-based (ie. the first row is 1 not 0).
selectedRows (srs)		<type ‘int’>, ...
	In edit mode, select the rows given as argument. In query mode, return a list of indices of completely selected rows. The row numbers are 1-based
selectionBehavior (sb)		int
	Set the selection behavior, valid values are from 0 to 2 (inclusive) 0 - Selecting single items. 1 - Selecting only rows. 2 - Selecting only columns.
selectionMode (sm)		int
	Set the selection Mode, valid values are from 0 to 4 (inclusive)0 - Items cannot be selected.1 - When the user selects an item, any already-selected item becomes unselected, and the user cannot unselect the selected item by clicking on it.2 - When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone. Multiple items can be toggled by dragging the mouse over them.3 - When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item. Multiple items can be selected by dragging the mouse over them.4 - When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item.
sortEnabled (se)		bool
	enable scriptTable sorted by column default value is false and the whole row will be sorted
underPointerColumn (upc)		bool
	The column under the pointer. The returned column number is 1-based (ie. the first column is 1 not 0).
underPointerRow (upr)		bool
	The row under the pointer. The returned row number is 1-based (ie. the first row is 1 not 0).
useDoubleClickEdit (udc)		bool
	this controls the cell edit modeFalse: Click in the cell to select (in Row selection, the last cell of the row is edited, in Column selection, the last cell of the column is edited)(default)True: Clicked in cell is edited when double-clicked only
useTemplate (ut)		unicode
	Force the command to use a command template other than the current one.
visible (vis)		bool
	The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand (vcc)		script
	Command that gets executed when visible state of the control changes.
width (w)		int
	The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.scriptTable

Example:

import pymel.core as pm

def edit_cell(row, column, value):
    return 1

window = pm.window(widthHeight=(400, 300))
form = pm.formLayout()
table = pm.scriptTable(rows=4, columns=2, label=[(1,"Column 1"), (2,"Column 2")], cellChangedCmd=edit_cell)

addButton = pm.button(label="Add Row",command="pm.scriptTable(table, edit=True,insertRow=1)")
deleteButton = pm.button(label="Delete Row",command="pm.scriptTable(table, edit=True,deleteRow=1)")

pm.formLayout(form, edit=True, attachForm=[(table, 'top', 0), (table, 'left', 0), (table, 'right', 0), (addButton, 'left', 0), (addButton, 'bottom', 0), (deleteButton, 'bottom', 0), (deleteButton, 'right', 0)], attachControl=(table, 'bottom', 0, addButton), attachNone=[(addButton, 'top'),(deleteButton, 'top')],  attachPosition=[(addButton, 'right', 0, 50), (deleteButton, 'left', 0, 50)] )
# Result: ui.FormLayout('window1|formLayout78') #

pm.showWindow( window )

# Set and query cells
pm.scriptTable($table, cellIndex=1 1, edit=True,cellValue="MyValue")
scriptTable -cellIndex 1 1 -query -cellValue $table;

# Select and query rows, columns and cells
pm.scriptTable(table, edit=True, selectedRows=[1, 3])
print pm.scriptTable(table, query=True, selectedRows=True)
pm.scriptTable(table, edit=True, selectedColumns=[1])
print pm.scriptTable(table, query=True, selectedColumns=True)
pm.scriptTable(table, edit=True, selectedCells=[1,2,2,1,3,2,4,1])
print pm.scriptTable(table, query=True, selectedCells=True)

# Set a filter for the first column
pm.scriptTable(table, edit=True, columnFilter=(1,"MyValue"))
# Set a filter for all columns
pm.scriptTable(table, edit=True, columnFilter=(0,"MyValue"))