Go to: Synopsis. Flags. Return value. Python examples.
scriptTable(
[name]
, [annotation=string], [backgroundColor=[float, float, float]], [cellChangedCmd=string], [clearRow=int], [clearTable=boolean], [columnWidth=[int, int]], [columns=int], [defineTemplate=string], [deleteRow=int], [docTag=boolean], [dragCallback=string], [dropCallback=string], [edit=boolean], [enable=boolean], [exists=boolean], [getCellCmd=string], [height=int], [insertRow=int], [isObscured=boolean], [label=[int, string]], [manage=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [query=boolean], [rows=int], [selectedRow=boolean], [underPointerRow=boolean], [useTemplate=string], [visible=boolean], [width=int])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
scriptTable is undoable, queryable, and editable.
This command creates/edits/queries the script table control.
annotation, backgroundColor, cellChangedCmd, clearRow, clearTable, columnWidth, columns, defineTemplate, deleteRow, docTag, dragCallback, dropCallback, edit, enable, exists, getCellCmd, height, insertRow, isObscured, label, manage, numberOfPopupMenus, parent, popupMenuArray, preventOverride, query, rows, selectedRow, underPointerRow, useTemplate, visible, width
| Long name (short name) |
[argument types] |
Properties |
query(q)
|
boolean
|
|
|
Puts the command in query mode so that it will return the
value of the specified flag.
In query mode, this flag needs a value.
|
|
edit(e)
|
boolean
|
|
|
Puts the command in edit mode so that it will
change the values of the specified flags
|
|
exists(ex)
|
boolean
|
|
|
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
|
|
|
Will force the command to use a command template other than
the current one.
|
|
parent(p)
|
string
|
|
|
The parent layout for this control.
|
|
enable(en)
|
boolean
|
|
|
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.
In query mode, this flag needs a value.
|
|
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.
In query mode, this flag needs a value.
|
|
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.
In query mode, this flag needs a value.
|
|
visible(vis)
|
boolean
|
|
|
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).
In query mode, this flag needs a value.
|
|
isObscured(io)
|
boolean
|
|
|
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.
In query mode, this flag needs a value.
|
|
manage(m)
|
boolean
|
|
|
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.
In query mode, this flag needs a value.
|
|
numberOfPopupMenus(npm)
|
boolean
|
|
|
Return the number of popup menus attached to this control.
In query mode, this flag needs a value.
|
|
popupMenuArray(pma)
|
boolean
|
|
|
Return the names of all the popup menus attached to this
control.
In query mode, this flag needs a value.
|
|
preventOverride(po)
|
boolean
|
|
|
If true, this flag disallows overriding the control's
attribute via the control's right mouse button menu.
In query mode, this flag needs a value.
|
|
annotation(ann)
|
string
|
|
|
Annotate the control with an extra string value.
In query mode, this flag needs a 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. (Windows only flag)
|
|
docTag(dt)
|
boolean
|
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure like hierarchy.
Eg. -dt render/multiLister/createNode/material
In query mode, this flag needs a value.
|
|
dragCallback(dgc)
|
string
|
|
|
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)
|
string
|
|
|
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'")
|
|
label(l)
|
[int, string]
|
|
|
Set the label of the specified column.
The column number is 1-based (ie. the first column is 1 not 0).
|
|
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).
|
|
selectedRow(sr)
|
boolean
|
|
|
The current row selected.
The returned row number is 1-based (ie. the first row is 1 not 0).
In query mode, this flag needs a value.
|
|
underPointerRow(upr)
|
boolean
|
|
|
The row under the pointer.
The returned row number is 1-based (ie. the first row is 1 not 0).
In query mode, this flag needs a value.
|
|
getCellCmd(gcc)
|
string
|
|
|
Sets the MEL procedure 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)
|
|
cellChangedCmd(ccc)
|
string
|
|
|
Sets the MEL procedure 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 true if yes, and false 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)
|
|
rows(r)
|
int
|
|
|
Set the number of rows in the table
In query mode, this flag needs a value.
|
|
columns(c)
|
int
|
|
|
Set the number of columns in the table
In query mode, this flag needs a value.
|
|
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).
|
|
deleteRow(dr)
|
int
|
|
|
Delete the specified row
The row number is 1-based (ie. the first row is 1 not 0).
|
|
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)
|
boolean
|
|
|
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
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
The full path name to the created script table control.
import maya.cmds as cmds
window = cmds.window(widthHeight=(400, 300))
form = cmds.formLayout()
table = cmds.scriptTable(rows=4, columns=2, label=[(1,"Column 1"), (2,"Column 2")])
addButton = cmds.button(label="Add Row",command="cmds.scriptTable(table, edit=True,insertRow=1)")
deleteButton = cmds.button(label="Delete Row",command="cmds.scriptTable(table, edit=True,deleteRow=1)")
cmds.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)] )
cmds.showWindow( window )
Return to Autodesk Index