ScrollableTextLayoutGroup Class

Inheritance diagram of ScrollableTextLayoutGroup

class ScrollableTextLayoutGroup(parent=None)

Top-level rendering group for ScrollableTextLayout.

The group maintains internal state for setting the clipping planes and view transform for scrolling. Because the group has internal state specific to the text layout, the group is never shared.

Constructor:

__init__(parent=None)

Create a group.

Parameters:parent (Group) – Group to contain this group; its state will be set before this state’s.

Methods:

set_state()
set_state_recursive() Set this group and its ancestry.
unset_state()
unset_state_recursive() Unset this group and its ancestry.

Attributes:

height Height of the text layout.
left Left edge of the text layout.
top Top edge of the text layout (measured from the bottom of the graphics viewport).
translate_x Type: int
translate_y Type: int
view_x Horizontal scroll offset.
view_y Vertical scroll offset.
width Width of the text layout.

Methods

ScrollableTextLayoutGroup.set_state()
ScrollableTextLayoutGroup.unset_state()

Attributes

ScrollableTextLayoutGroup.height

Height of the text layout.

Type:int
ScrollableTextLayoutGroup.left

Left edge of the text layout.

Type:int
ScrollableTextLayoutGroup.top

Top edge of the text layout (measured from the bottom of the graphics viewport).

Type:int
ScrollableTextLayoutGroup.translate_x = 0
ScrollableTextLayoutGroup.translate_y = 0
ScrollableTextLayoutGroup.view_x

Horizontal scroll offset.

Type:int
ScrollableTextLayoutGroup.view_y

Vertical scroll offset.

Type:int
ScrollableTextLayoutGroup.width

Width of the text layout.

Type:int

Inherited members

Methods

ScrollableTextLayoutGroup.set_state_recursive()

Set this group and its ancestry.

Call this method if you are using a group in isolation: the parent groups will be called in top-down order, with this class’s set being called last.

ScrollableTextLayoutGroup.unset_state_recursive()

Unset this group and its ancestry.

The inverse of set_state_recursive.

Table Of Contents

Previous topic

ScrollableTextLayout Class

Next topic

TextLayout Class