Scroll Container#

The Scroll Container is similar to the iframe or scrollable div element in HTML, it contains an object with its own scrollable selection.

Usage#

import toga

content = toga.WebView()

container = toga.ScrollContainer(content=content)

Scroll settings#

Horizontal or vertical scroll can be set via the initializer or using the property.

import toga

content = toga.WebView()

container = toga.ScrollContainer(content=content, horizontal=False)

container.vertical = False

Reference#

class toga.widgets.scrollcontainer.ScrollContainer(id=None, style=None, horizontal=True, vertical=True, on_scroll=None, content=None, factory=None)#

Instantiate a new instance of the scrollable container widget.

Parameters:

id (str) – An identifier for this widget.
style (Style) – An optional style object. If no style is provided then a new one will be created for the widget.
horizontal (bool) – If True enable horizontal scroll bar.
vertical (bool) – If True enable vertical scroll bar.
content (Widget) – The content of the scroll window.

MIN_HEIGHT = 100#

MIN_WIDTH = 100#

add(*children)#

Add the provided widgets as children of this widget.

If a node already has a different parent, it will be moved over. This does nothing if a node already is a child of this node.

Raises ValueError if this widget cannot have children.

Parameters:: children – The widgets to add as children of this widget.

property app#

The App to which this widget belongs.

When setting the app for a widget, all children of this widget will be recursively assigned to the same app.

Raises ValueError if the widget is already associated with another app.

property can_have_children#

Determine if the node can have children.

This does not resolve whether there actually are any children; it only confirms whether children are theoretically allowed.

property children#

The children of this node. This always returns a list, even if the node is a leaf and cannot have children.

Returns:: A list of the children for this widget.

property content#

Content of the scroll container.

Returns:: The content of the widget (Widget).

property enabled#: Is the widget currently enabled? i.e., can the user interact with the widget?

focus()#: Set this widget to have the current input focus.

property horizontal#

Shows whether horizontal scrolling is enabled.

Returns:: (bool) True if enabled, False if disabled.

property horizontal_position#

property id#: The node identifier. This id can be used to target styling directives.

insert(index, child)#

Insert a widget as a child of this widget.

If the node already has a parent, ownership of the widget will be transferred.

Raises ValueError if this node cannot have children.

Parameters:

index – The position in the list of children where the new widget should be added.
child – The child to insert as a child of this node.

property on_scroll#

property parent#

The parent of this node.

Returns:: The parent of this node. Returns None if this node is the root node.

refresh()#: Refresh the layout and appearance of the tree this node is contained in.

refresh_sublayouts()#: Refresh the layout and appearance of this widget.

remove(*children)#

Remove the provided widgets as children of this node.

This does nothing if a given node is not a child of this node.

Raises ValueError if this node is a leaf, and cannot have children.

Parameters:: children – The child nodes to remove.

property root#

The root of the tree containing this node.

Returns:: The root node. Returns self if this node is the root node.

property tab_index#: The position of the widget in the focus chain for the window.

property vertical#

Shows whether vertical scrolling is enabled.

Returns:: (bool) True if enabled, False if disabled.

property vertical_position#

property window#

The window to which this widget belongs.

When setting the window for a widget, all children of this widget will be recursively assigned to the same window.