pymel.core.uitypes.TextField

Inheritance diagram of TextField

class TextField

class counterpart of mel function textField

Create a text field control.

changeCommand(val=True, **kwargs)

Command executed when the text changes. This command is not invoked when the value changes via the -tx/text flag.

Derived from mel command maya.cmds.textField

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

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

enterCommand(val=True, **kwargs)

Command executed when the keypad ‘Enter’ key is pressed.

Derived from mel command maya.cmds.textField

getAlwaysInvokeEnterCommandOnReturn(**kwargs)

Sets whether to always invoke the enter command when the return key is pressed by the user.By default, this option is false.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.textField

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.textField

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

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

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/text flag regardless of the state of the -ed/editable flag.

Derived from mel command maya.cmds.textField

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

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.textField

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

getFont(**kwargs)

The font for the text. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.

Derived from mel command maya.cmds.textField

getFullPathName(**kwargs)

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

Derived from mel command maya.cmds.textField

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

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

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

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

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.textField

getPopupMenuArray(**kwargs)

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

Derived from mel command maya.cmds.textField

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

getText(**kwargs)

The field text.

Derived from mel command maya.cmds.textField

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

getVisibleChangeCommand(**kwargs)

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

Derived from mel command maya.cmds.textField

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

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

receiveFocusCommand(val=True, **kwargs)

Command executed when the field receives focus.

Derived from mel command maya.cmds.textField

setAlwaysInvokeEnterCommandOnReturn(val=True, **kwargs)

Sets whether to always invoke the enter command when the return key is pressed by the user.By default, this option is false.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.textField

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.textField

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

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

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/text flag regardless of the state of the -ed/editable flag.

Derived from mel command maya.cmds.textField

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

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.textField

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

setFont(val=True, **kwargs)

The font for the text. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.

Derived from mel command maya.cmds.textField

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

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

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

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

setText(val=True, **kwargs)

The field text.

Derived from mel command maya.cmds.textField

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

setVisibleChangeCommand(val=True, **kwargs)

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

Derived from mel command maya.cmds.textField

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

Previous topic

pymel.core.uitypes.TextCurves

Next topic

pymel.core.uitypes.TextFieldButtonGrp

Core

Core Modules

Other Modules

This Page