Version

Quick search

RecycleLayout

New in version 1.10.0.

Warning

This module is highly experimental, its API may change in the future and the documentation is not complete at this time.

class kivy.uix.recyclelayout.RecycleLayout(**kwargs)[source]

Bases: kivy.uix.recycleview.layout.RecycleLayoutManagerBehavior, kivy.uix.layout.Layout

RecycleLayout provides the default layout for RecycleViews.

default_height

Default height for items

default_height is a NumericProperty and default to 100.

default_pos_hint

Default pos_hint value for items

default_pos_hint is a DictProperty and defaults to {}.

default_size

size (width, height). Each value can be None.

default_size is an ReferenceListProperty to [default_width, default_height].

default_size_hint

size (width, height). Each value can be None.

default_size_hint is an ReferenceListProperty to [default_size_hint_x, default_size_hint_y].

default_size_hint_max

Default value for size_hint_max of items

default_size_max is a ReferenceListProperty to [default_size_hint_x_max, default_size_hint_y_max].

default_size_hint_min

Default value for size_hint_min of items

default_size_min is a ReferenceListProperty to [default_size_hint_x_min, default_size_hint_y_min].

default_size_hint_x

Default size_hint_x for items

default_size_hint_x is a NumericProperty and default to None.

default_size_hint_x_max

Default value for size_hint_x_max of items

default_pos_hint_x_max is a NumericProperty and defaults to None.

default_size_hint_x_min

Default value for size_hint_x_min of items

default_pos_hint_x_min is a NumericProperty and defaults to None.

default_size_hint_y

Default size_hint_y for items

default_size_hint_y is a NumericProperty and default to None.

default_size_hint_y_max

Default value for size_hint_y_max of items

default_pos_hint_y_max is a NumericProperty and defaults to None.

default_size_hint_y_min

Default value for size_hint_y_min of items

default_pos_hint_y_min is a NumericProperty and defaults to None.

default_width

Default width for items

default_width is a NumericProperty and default to 100

do_layout(*largs)[source]

This function is called when a layout is called by a trigger. If you are writing a new Layout subclass, don’t call this function directly but use _trigger_layout() instead.

The function is by default called before the next frame, therefore the layout isn’t updated immediately. Anything depending on the positions of e.g. children should be scheduled for the next frame.

New in version 1.0.8.

initial_height

Initial height for the items.

initial_height is a NumericProperty and defaults to 100.

initial_size

Initial size of items

initial_size is a ReferenceListProperty to [initial_width, initial_height].

initial_width

Initial width for the items.

initial_width is a NumericProperty and defaults to 100.

key_pos_hint

If set, which key in the dict should be used to set the pos_hint of items.

key_pos_hint is a StringProperty and defaults to None.

key_size

If set, which key in the dict should be used to set the size property of the item.

key_size is a StringProperty and defaults to None.

key_size_hint

If set, which key in the dict should be used to set the size_hint property of the item.

key_size_hint is a StringProperty and defaults to None.

key_size_hint_max

If set, which key in the dict should be used to set the size_hint_max property of the item.

key_size_hint_max is a StringProperty and defaults to None.

key_size_hint_min

If set, which key in the dict should be used to set the size_hint_min property of the item.

key_size_hint_min is a StringProperty and defaults to None.

refresh_view_layout(index, layout, view, viewport)[source]

See :meth:`~kivy.uix.recycleview.views.RecycleDataAdapter.refresh_view_layout.

set_visible_views(indices, data, viewport)[source]

viewport is in coordinates of the layout manager.