SplitPane widget

Two panes with a draggable divider. See split_pane().

Super class

Widget -> SplitPane

Public fields

direction

"horizontal" (panes side by side) or "vertical" (stacked).

min_size

Smallest size of a pane in cells (when there is room).

Active bindings

ratio

Share of the first pane (0 to 1). Assigning moves the divider (limited by min_size).

sizes

The current sizes (cells) of the two panes.

Methods

Public methods

• SplitPane$new()

• SplitPane$default_style()

• SplitPane$arrange_children()

• SplitPane$move_divider()

• SplitPane$set_ratio()

• SplitPane$drag_to()

• SplitPane$announce()

• SplitPane$clone()

Inherited methods

• Widget$add_class()
• Widget$ancestors()
• Widget$animate()
• Widget$bind()
• Widget$bind_reactive()
• Widget$bindings()
• Widget$blur()
• Widget$capture_mouse()
• Widget$child_clip()
• Widget$clear()
• Widget$computed_style()
• Widget$content_height()
• Widget$content_width()
• Widget$default_bindings()
• Widget$focus()
• Widget$format()
• Widget$get_state()
• Widget$has_class()
• Widget$invalidate()
• Widget$invalidate_paint()
• Widget$is_displayed()
• Widget$is_enabled()
• Widget$layout_descend()
• Widget$layout_differs()
• Widget$matches()
• Widget$mount()
• Widget$on()
• Widget$paint()
• Widget$post_message()
• Widget$print()
• Widget$pseudo_states()
• Widget$query()
• Widget$query_one()
• Widget$refresh()
• Widget$release_mouse()
• Widget$remove()
• Widget$remove_children()
• Widget$remove_class()
• Widget$render()
• Widget$render_lines()
• Widget$replace()
• Widget$run_action()
• Widget$run_process()
• Widget$run_worker()
• Widget$set()
• Widget$set_interval()
• Widget$set_state()
• Widget$set_timeout()
• Widget$toggle_class()
• Widget$walk()

---

SplitPane$new()

Create a split pane. See split_pane().

Usage

SplitPane$new(
  first,
  second,
  direction = "horizontal",
  ratio = 0.5,
  min_size = 3L,
  id = NULL,
  classes = NULL,
  style = NULL
)

Arguments

first, second

The two panes (widgets).

direction, ratio, min_size

See split_pane().

id, classes, style

See Widget.

---

SplitPane$default_style()

The built-in style.

Usage

SplitPane$default_style()

---

SplitPane$arrange_children()

Split the content area between the panes and the divider.

Usage

SplitPane$arrange_children(children, inner, st)

Arguments

children

Visible children.

inner

Content rectangle.

st

Computed style.

---

SplitPane$move_divider()

Move the divider by some cells.

Usage

SplitPane$move_divider(cells)

Arguments

cells

Positive: towards the second pane.

---

SplitPane$set_ratio()

Set the share of the first pane.

Usage

SplitPane$set_ratio(ratio)

Arguments

ratio

A number between 0 and 1.

---

SplitPane$drag_to()

Place the divider under a screen position (drags).

Usage

SplitPane$drag_to(x, y)

Arguments

x, y

Screen position.

---

SplitPane$announce()

Send "splitpane.resized" with the current ratio.

Usage

SplitPane$announce()

---

SplitPane$clone()

The objects of this class are cloneable with this method.

Usage

SplitPane$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.