Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

scrollLayout [-annotation string] [-backgroundColor float float float] [-borderVisible boolean] [-childArray] [-childResizable boolean] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-enableKeyboardFocus boolean] [-exists] [-fullPathName] [-height int] [-highlightColor float float float] [-horizontalScrollBarThickness int] [-isObscured] [-manage boolean] [-minChildWidth int] [-noBackground boolean] [-numberOfChildren] [-numberOfPopupMenus] [-panEnabled boolean] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-resizeCommand script] [-scrollAreaHeight] [-scrollAreaValue] [-scrollAreaWidth] [-scrollByPixel string int] [-scrollPage string] [-statusBarMessage string] [-useTemplate string] [-verticalScrollBarAlwaysVisible boolean] [-verticalScrollBarThickness int] [-visible boolean] [-visibleChangeCommand script] [-width int] [string]

scrollLayout is undoable, queryable, and editable.

This command creates a scroll layout. A scroll layout is useful for when you have a number of controls which cannot all be visible at a time. This layout will display a horizontal and/or vertical scroll bar when necessary to bring into view the hidden controls. Since the scroll layout provides no real positioning of children you should use another control layout as the immediate child.

Return value

stringFull path name to the control.

In query mode, return type is based on queried flag.

Flags

annotation, backgroundColor, borderVisible, childArray, childResizable, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, enableKeyboardFocus, exists, fullPathName, height, highlightColor, horizontalScrollBarThickness, isObscured, manage, minChildWidth, noBackground, numberOfChildren, numberOfPopupMenus, panEnabled, parent, popupMenuArray, preventOverride, resizeCommand, scrollAreaHeight, scrollAreaValue, scrollAreaWidth, scrollByPixel, scrollPage, statusBarMessage, useTemplate, verticalScrollBarAlwaysVisible, verticalScrollBarThickness, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
-annotation(-ann) string createqueryedit
Annotate the control with an extra string value.
-backgroundColor(-bgc) float float float createqueryedit
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.
-borderVisible(-bv) boolean createqueryedit
Visibility of the border.
-childArray(-ca) query
Returns a string array of the names of the layout's immediate children.
-childResizable(-cr) boolean createquery
Set to true if you want the child of the control layout to be as wide as the scroll area. You may also indicate a minimum width for the child using the -mcw/minChildWidth flag.
-defineTemplate(-dt) string create
Puts the command in a mode where any other flags and arguments 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) string createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
-dragCallback(-dgc) script createedit
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 CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + 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 createedit
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'")

-enable(-en) boolean createqueryedit
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) boolean createqueryedit
Enables the background color of the control.
-enableKeyboardFocus(-ekf) boolean createqueryedit
If enabled, the user can navigate to the control with the tab key and select values with the keyboard or mouse. This flag would typically be used to turn off focus support from controls that get it by default, like Edit and List controls. If disabled, text in text fields can still be selected with the mouse but cannot be copied (except on Linux when "Middle Click Paste" is enabled).
-exists(-ex) create
Returns whether the specified object exists or not. Other flags are ignored.
-fullPathName(-fpn) query
Return the full path name of the widget, which includes all the parents.
-height(-h) int createqueryedit
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 createqueryedit
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.
-horizontalScrollBarThickness(-hst) int createedit
Thickness of the horizontal scroll bar. Specify an integer value of pixels greater than or equal to 0. Other than setting the value to 0 to hide the scrollbar, this flag has no effect on Windows systems.
-isObscured(-io) query
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.
-manage(-m) boolean createqueryedit
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.
-minChildWidth(-mcw) int createquery
A positive non-zero integer value indicating the minimum width the scroll layout's child. This flag only has meaning when the -cr/childResizable flag is set to true.
-noBackground(-nbg) boolean createedit
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.
-numberOfChildren(-nch) query
Returns in an int the number of immediate children of the layout.
-numberOfPopupMenus(-npm) query
Return the number of popup menus attached to this control.
-panEnabled(-pe) boolean queryedit
Set to true if you want to pan the scroll layout using ALT + MMB. On OSX, in one button and two button mode, you could use command+alt+LMB to pan it. The pan effect is disabled by default.
-parent(-p) string createquery
The parent layout for this control.
-popupMenuArray(-pma) query
Return the names of all the popup menus attached to this control.
-preventOverride(-po) boolean createqueryedit
If true, this flag prevents overriding the control's attribute via the control's right mouse button menu.
-resizeCommand(-rc) script createedit
The command invoked when the scroll layout is resized.
-scrollAreaHeight(-sah) query
Return the height of the scroll area (in pixels).
-scrollAreaValue(-sav) query
Return the vertical and horizontal values of the scroll area (in pixels).
-scrollAreaWidth(-saw) query
Return the width of the scroll area (in pixels).
-scrollByPixel(-sbp) string int edit
Scroll the client area in the direction of the string. The int specifies the number of pixels.
-scrollPage(-sp) string edit
Scroll the client area in the direction of the string. Valid values are "up", "down", "left" or "right".
-statusBarMessage(-sbm) string createedit
Extra string to display in the status bar when the mouse is over the control.
-useTemplate(-ut) string create
Forces the command to use a command template other than the current one.
-verticalScrollBarAlwaysVisible(-vsb) boolean create
Set to true if you want to always have the vertical scroll bar visible.
-verticalScrollBarThickness(-vst) int createedit
Thickness of the vertical scroll bar. Specify an integer value of pixels greater than or equal to 0. This flag has no effect on Windows systems.
-visible(-vis) boolean createqueryedit
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 createqueryedit
Command that gets executed when visible state of the control changes.
-width(-w) int createqueryedit
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
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 be used more than once in a command.

MEL examples

window -widthHeight 350 150;
    string $scrollLayout = `scrollLayout
        -horizontalScrollBarThickness 16
        -verticalScrollBarThickness   16`;
        rowColumnLayout -numberOfColumns 3;
        int $index;
        for ($index = 0; $index < 10; $index++) {
            text; intField; intSlider;
        }
showWindow;

int $top, $left, $value[2];
$value = `scrollLayout -query -scrollAreaValue $scrollLayout`;
$top = $value[0];
$left = $value[1];