pymel.core.windows.scrollField

scrollField(*args, **kwargs)

This command creates a scrolling field that handles multiple lines of text.

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.
changeCommand (cc)		script
	Command executed when the value changes. This command is executed whenever the field loses focus.
clear (cl)		bool
	Removes all text in the field.
command (c)		unicode
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.
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 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.
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.
enterCommand (ec)		script
	Command executed when the enter key is pressed. This applies to the enter key on the numeric keypad only.
exists (ex)		bool
	Returns true|false depending upon whether the specified object exists. Other flags are ignored.
font (fn)		unicode
	The font for the text. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.
fullPathName (fpn)		unicode
	Return the full path name of the widget, which includes all the parents
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.
insertText (it)		unicode
	Insert text into the field at the current insertion position (specified by the -ip/insertionPosition flag).
insertionPosition (ip)		int
	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.
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.
keyPressCommand (kpc)		script
	Command executed when any key is pressed.
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.
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.
numberOfLines (nl)		int
	Number of lines in the scroll field.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
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.
selection (sl)		bool
	The selected text in the field. An empty string is returned if there is no selected text.
text (tx)		unicode
	The field text.
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.
wordWrap (ww)		bool
	Specify true to break lines at spaces, tabs, or newlines. Text will continue on the following line. A value of false will not break text between words, in which case text may disappear beyond the edge of the field. This flag must be set at create time. Lines do not word wrap by default.

Derived from mel command maya.cmds.scrollField

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.paneLayout( configuration='horizontal4' )
# Result: ui.PaneLayout('window1|paneLayout13') #
pm.scrollField( editable=False, wordWrap=True, text='Non editable with word wrap' )
# Result: ui.ScrollField('window1|paneLayout13|scrollField3') #
pm.scrollField( editable=False, wordWrap=False, text='Non editable with no word wrap' )
# Result: ui.ScrollField('window1|paneLayout13|scrollField4') #
pm.scrollField( editable=True, wordWrap=True, text='Editable with word wrap' )
# Result: ui.ScrollField('window1|paneLayout13|scrollField5') #
pm.scrollField( editable=True, wordWrap=False, text='Editable with no word wrap' )
# Result: ui.ScrollField('window1|paneLayout13|scrollField6') #
pm.showWindow()