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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Annotate the control with an extra string value.
backgroundColor / bgc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/edit.gif
  Command executed when the value changes. This command is executed whenever the field loses focus.
clear / cl bool ../../../_images/create.gif ../../../_images/edit.gif
  Removes all text in the field.
command / c unicode  
   
defineTemplate / dt unicode ../../../_images/create.gif
  Puts the 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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/edit.gif
  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 dragControlvalue 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 ../../../_images/create.gif ../../../_images/edit.gif
  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 dragControlvalue 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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Enables the background color of the control.
enterCommand / ec script ../../../_images/create.gif ../../../_images/edit.gif
  Command executed when the enter key is pressed. This applies to the enter key on the numeric keypad only.
exists / ex bool ../../../_images/create.gif
  Returns whether the specified object exists or not. Other flags are ignored.
font / fn unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The font for the text. Valid values are boldLabelFont, smallBoldLabelFont, tinyBoldLabelFont, plainLabelFont, smallPlainLabelFont, obliqueLabelFont, smallObliqueLabelFont, fixedWidthFontand smallFixedWidthFont.
fontPointSize / fns int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The font point size for the text.
fullPathName / fpn bool ../../../_images/query.gif
  Return the full path name of the widget, which includes all the parents
height / h int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor / hlc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The highlight 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.
insertText / it unicode ../../../_images/create.gif ../../../_images/edit.gif
  Insert text into the field at the current insertion position (specified by the -ip/insertionPosition flag).
insertionPosition / ip int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/query.gif
  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 ../../../_images/create.gif ../../../_images/edit.gif
  Command executed when any key is pressed.
manage / m bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/edit.gif
  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 ../../../_images/query.gif
  Number of lines in the scroll field.
numberOfPopupMenus / npm bool ../../../_images/query.gif
  Return the number of popup menus attached to this control.
parent / p unicode ../../../_images/create.gif ../../../_images/query.gif
  The parent layout for this control.
popupMenuArray / pma bool ../../../_images/query.gif
  Return the names of all the popup menus attached to this control.
preventOverride / po bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
qtFont / qfn unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The Qt font family for the text.
selection / sl bool ../../../_images/query.gif
  The selected text in the field. An empty string is returned if there is no selected text.
text / tx unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The field text.
useTemplate / ut unicode ../../../_images/create.gif
  Force the command to use a command template other than the current one.
visible / vis bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Command that gets executed when visible state of the control changes.
width / w int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif
  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. Flag can have multiple arguments, passed either as a tuple or a list.

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