pymel.core.uitypes.TextFieldButtonGrp

class TextFieldButtonGrp

class counterpart of mel function textFieldButtonGrp

All of the group commands position their individual controls in columns starting at column 1. The layout of each control (ie. column) can be customized using the -cw/columnWidth, -co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumnflags. By default, columns are left aligned with no offset and are 100 pixels wide. Only one column in any group can be adjustable. This command adds a button to the textFieldGrp command.

adjustableColumn(val=True, **kwargs)

Specifies which column has an adjustable size that changes with the sizing of the layout. The column value is a 1-based index. You may also specify 0 to turn off the previous adjustable column.

Derived from mel command maya.cmds.textFieldButtonGrp

adjustableColumn2(val=True, **kwargs)

Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly two columns.

Derived from mel command maya.cmds.textFieldButtonGrp

adjustableColumn3(val=True, **kwargs)

Specifies that the column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly three columns.

Derived from mel command maya.cmds.textFieldButtonGrp

adjustableColumn4(val=True, **kwargs)

Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly four columns.

Derived from mel command maya.cmds.textFieldButtonGrp

adjustableColumn5(val=True, **kwargs)

Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly five columns.

Derived from mel command maya.cmds.textFieldButtonGrp

adjustableColumn6(val=True, **kwargs)

Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly six columns.

Derived from mel command maya.cmds.textFieldButtonGrp

buttonCommand(val=True, **kwargs)

Command attached to the button.

Derived from mel command maya.cmds.textFieldButtonGrp

changeCommand(val=True, **kwargs)

Command executed when the field text changes and user presses Enter or Return.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAlign(val=True, **kwargs)

Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAlign2(val=True, **kwargs)

Sets the text alignment of both columns. Ignored if there is not exactly two columns. Valid values are “left”, “right”, and “center”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAlign3(val=True, **kwargs)

Sets the text alignment for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are “left”, “right”, and “center”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAlign4(val=True, **kwargs)

Sets the text alignment for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are “left”, “right”, and “center”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAlign5(val=True, **kwargs)

Sets the text alignment for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are “left”, “right”, and “center”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAlign6(val=True, **kwargs)

Sets the text alignment for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are “left”, “right”, and “center”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAttach(val=True, **kwargs)

Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAttach2(val=True, **kwargs)

Sets the attachment type of both columns. Ignored if there is not exactly two columns. Valid values are “left”, “right”, and “both”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAttach3(val=True, **kwargs)

Sets the attachment type for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are “left”, “right”, and “both”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAttach4(val=True, **kwargs)

Sets the attachment type for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are “left”, “right”, and “both”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAttach5(val=True, **kwargs)

Sets the attachment type for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are “left”, “right”, and “both”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnAttach6(val=True, **kwargs)

Sets the attachment type for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are “left”, “right”, and “both”.

Derived from mel command maya.cmds.textFieldButtonGrp

columnOffset2(val=True, **kwargs)

This flag is used in conjunction with the -columnAttach2 flag. If that flag is not used then this flag will be ignored. It sets the offset for the two columns. The offsets applied are based on the attachments specified with the -columnAttach2 flag. Ignored if there is not exactly two columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnOffset3(val=True, **kwargs)

This flag is used in conjunction with the -columnAttach3 flag. If that flag is not used then this flag will be ignored. It sets the offset for the three columns. The offsets applied are based on the attachments specified with the -columnAttach3 flag. Ignored if there is not exactly three columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnOffset4(val=True, **kwargs)

This flag is used in conjunction with the -columnAttach4 flag. If that flag is not used then this flag will be ignored. It sets the offset for the four columns. The offsets applied are based on the attachments specified with the -columnAttach4 flag. Ignored if there is not exactly four columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnOffset5(val=True, **kwargs)

This flag is used in conjunction with the -columnAttach5 flag. If that flag is not used then this flag will be ignored. It sets the offset for the five columns. The offsets applied are based on the attachments specified with the -columnAttach5 flag. Ignored if there is not exactly five columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnOffset6(val=True, **kwargs)

This flag is used in conjunction with the -columnAttach6 flag. If that flag is not used then this flag will be ignored. It sets the offset for the six columns. The offsets applied are based on the attachments specified with the -columnAttach6 flag. Ignored if there is not exactly six columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth(val=True, **kwargs)

Arguments are : column number, column width. Sets the width of the specified column where the first parameter specifies the column (1 based index) and the second parameter specifies the width.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth1(val=True, **kwargs)

Sets the width of the first column. Ignored if there is not exactly one column.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth2(val=True, **kwargs)

Sets the column widths of both columns. Ignored if there is not exactly two columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth3(val=True, **kwargs)

Sets the column widths for all 3 columns. Ignored if there is not exactly 3 columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth4(val=True, **kwargs)

Sets the column widths for all 4 columns. Ignored if there is not exactly 4 columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth5(val=True, **kwargs)

Sets the column widths for all 5 columns. Ignored if there is not exactly 5 columns.

Derived from mel command maya.cmds.textFieldButtonGrp

columnWidth6(val=True, **kwargs)

Sets the column widths for all 6 columns. Ignored if there is not exactly 6 columns.

Derived from mel command maya.cmds.textFieldButtonGrp

dragCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.textFieldButtonGrp

dropCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.textFieldButtonGrp

forceChangeCommand(val=True, **kwargs)

If used together with -text or -inserText flag, change command will be executed after text modification.

Derived from mel command maya.cmds.textFieldButtonGrp

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.textFieldButtonGrp

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

getButtonLabel(**kwargs)

Label text of the button.

Derived from mel command maya.cmds.textFieldButtonGrp

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.textFieldButtonGrp

getEditable(**kwargs)

The edit state of the field. By default, this flag is set to true and the field value may be changed by typing into it. If false then the field is ‘read only’ and can not be typed into. The text in the field can always be changed with the -tx/textflag regardless of the state of the -ed/editableflag.

Derived from mel command maya.cmds.textFieldButtonGrp

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.textFieldButtonGrp

getEnableButton(**kwargs)

Enable state of the button. By default, this flag is set to true and the button is enabled. Specify true, and the button will appear dimmed or greyed-out indicating it is disabled.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.textFieldButtonGrp

getFileName(**kwargs)

Text in the field as a filename. This does conversions between internal and external (UI) file representation.

Derived from mel command maya.cmds.textFieldButtonGrp

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.textFieldButtonGrp

getHeight(**kwargs)

The height 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.textFieldButtonGrp

getInsertionPosition(**kwargs)

The insertion position for inserted text. This is a 1 based value where position 1 specifies the beginning of the field. Position 0 may be used to specify the end of the field.

Derived from mel command maya.cmds.textFieldButtonGrp

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

getLabel(**kwargs)

Label text for the group.

Derived from mel command maya.cmds.textFieldButtonGrp

getManage(**kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.textFieldButtonGrp

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.textFieldButtonGrp

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.textFieldButtonGrp

getText(**kwargs)

Text in the field.

Derived from mel command maya.cmds.textFieldButtonGrp

getVisible(**kwargs)

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).

Derived from mel command maya.cmds.textFieldButtonGrp

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.textFieldButtonGrp

getWidth(**kwargs)

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.textFieldButtonGrp

insertText(val=True, **kwargs)

Insert text into the field at the current insertion position (specified by the -ip/insertionPosition flag).

Derived from mel command maya.cmds.textFieldButtonGrp

rowAttach(val=True, **kwargs)

Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.

Derived from mel command maya.cmds.textFieldButtonGrp

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.textFieldButtonGrp

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

setButtonLabel(val=True, **kwargs)

Label text of the button.

Derived from mel command maya.cmds.textFieldButtonGrp

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.textFieldButtonGrp

setEditable(val=True, **kwargs)

The edit state of the field. By default, this flag is set to true and the field value may be changed by typing into it. If false then the field is ‘read only’ and can not be typed into. The text in the field can always be changed with the -tx/textflag regardless of the state of the -ed/editableflag.

Derived from mel command maya.cmds.textFieldButtonGrp

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.textFieldButtonGrp

setEnableButton(val=True, **kwargs)

Enable state of the button. By default, this flag is set to true and the button is enabled. Specify true, and the button will appear dimmed or greyed-out indicating it is disabled.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.textFieldButtonGrp

setFileName(val=True, **kwargs)

Text in the field as a filename. This does conversions between internal and external (UI) file representation.

Derived from mel command maya.cmds.textFieldButtonGrp

setHeight(val=True, **kwargs)

The height 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.textFieldButtonGrp

setInsertionPosition(val=True, **kwargs)

The insertion position for inserted text. This is a 1 based value where position 1 specifies the beginning of the field. Position 0 may be used to specify the end of the field.

Derived from mel command maya.cmds.textFieldButtonGrp

setLabel(val=True, **kwargs)

Label text for the group.

Derived from mel command maya.cmds.textFieldButtonGrp

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.textFieldButtonGrp

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.textFieldButtonGrp

setText(val=True, **kwargs)

Text in the field.

Derived from mel command maya.cmds.textFieldButtonGrp

setVisible(val=True, **kwargs)

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).

Derived from mel command maya.cmds.textFieldButtonGrp

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.textFieldButtonGrp

setWidth(val=True, **kwargs)

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.textFieldButtonGrp

textChangedCommand(val=True, **kwargs)

Command executed immediately when the field text changes.

Derived from mel command maya.cmds.textFieldButtonGrp