ScrollingFrame

class omni.ui.ScrollingFrame

Bases: Frame

The ScrollingFrame class provides the ability to scroll onto another widget. ScrollingFrame is used to display the contents of a child widget within a frame. If the widget exceeds the size of the frame, the frame can provide scroll bars so that the entire area of the child widget can be viewed. The child widget must be specified with addChild().

Methods

__init__(self, **kwargs)	Construct ScrollingFrame.
set_scroll_x_changed_fn(self, arg0)	The horizontal position of the scroll bar.
set_scroll_y_changed_fn(self, arg0)	The vertical position of the scroll bar.

Attributes

horizontal_scrollbar_policy	This property holds the policy for the horizontal scroll bar.
scroll_x	The horizontal position of the scroll bar.
scroll_x_max	The max position of the horizontal scroll bar.
scroll_y	The vertical position of the scroll bar.
scroll_y_max	The max position of the vertical scroll bar.
vertical_scrollbar_policy	This property holds the policy for the vertical scroll bar.

__init__(

self: omni.ui._ui.ScrollingFrame,

**kwargs,

) → None

Construct ScrollingFrame.

`kwargsdict`

See below

### Keyword Arguments:

`scroll_xfloat`

The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

`scroll_x_maxfloat`

The max position of the horizontal scroll bar.

`scroll_x_changed_fnCallable[[float], None]`

The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

`scroll_yfloat`

The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

`scroll_y_maxfloat`

The max position of the vertical scroll bar.

`scroll_y_changed_fnCallable[[float], None]`

The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

`horizontal_scrollbar_policyui.ScrollBarPolicy`

This property holds the policy for the horizontal scroll bar.

`vertical_scrollbar_policyui.ScrollBarPolicy`

This property holds the policy for the vertical scroll bar.

`horizontal_clipping`

When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for horizontal direction.

`vertical_clipping`

When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for vertial direction.

`separate_window`

A special mode where the child is placed to the transparent borderless window. We need it to be able to place the UI to the exact stacking order between other windows.

`raster_policy`

Determine how the content of the frame should be rasterized.

`build_fn`

Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It’s useful for lazy load.

`widthui.Length`

This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.

`heightui.Length`

This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.

`namestr`

The name of the widget that user can set.

`style_type_name_overridestr`

By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.

`identifierstr`

An optional identifier of the widget we can use to refer to it in queries.

`visiblebool`

This property holds whether the widget is visible.

`visibleMinfloat`

If the current zoom factor and DPI is less than this value, the widget is not visible.

`visibleMaxfloat`

If the current zoom factor and DPI is bigger than this value, the widget is not visible.

`tooltipstr`

Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style

`tooltip_fnCallable`

Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.

`tooltip_offset_xfloat`

Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.

`tooltip_offset_yfloat`

Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.

`enabledbool`

This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.

`selectedbool`

This property holds a flag that specifies the widget has to use eSelected state of the style.

`checkedbool`

This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.

`draggingbool`

This property holds if the widget is being dragged.

`opaque_for_mouse_eventsbool`

If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either

`explicit_hoverbool`

If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either

`skip_draw_when_clippedbool`

The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.

`mouse_moved_fnCallable`

Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)

`mouse_pressed_fnCallable`

Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.

`mouse_released_fnCallable`

Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)

`mouse_double_clicked_fnCallable`

Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)

`mouse_wheel_fnCallable`

Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)

`mouse_hovered_fnCallable`

Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)

`drag_fnCallable`

Specify that this Widget is draggable, and set the callback that is attached to the drag operation.

`accept_drop_fnCallable`

Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.

`drop_fnCallable`

Specify that this Widget accepts drops and set the callback to the drop operation.

`computed_content_size_changed_fnCallable`

Called when the size of the widget is changed.

set_scroll_x_changed_fn(

self: omni.ui._ui.ScrollingFrame,

arg0: Callable[[float], None],

) → None

The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

set_scroll_y_changed_fn(

self: omni.ui._ui.ScrollingFrame,

arg0: Callable[[float], None],

) → None

The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

property horizontal_scrollbar_policy

This property holds the policy for the horizontal scroll bar.

property scroll_x

The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

property scroll_x_max

The max position of the horizontal scroll bar.

property scroll_y

The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.

property scroll_y_max

The max position of the vertical scroll bar.

property vertical_scrollbar_policy

This property holds the policy for the vertical scroll bar.