renoise.Views.ScrollBar

A special slider alike control to scroll through some content.

min and max define to the scrollable area's range. pagesize is the currently visible area within that range and value is the offset from min to max - pagestep within the whole scrollable area:

min   value                      max
 |      [xxxxxxxxxxxxxx]          |
        <---pagestep--->
 <---------scroll-area------------>

Note that the minimum offset value is min and the maximum offset value is max - pagestep.

A scrollbar can be horizontal or vertical. It will flip its orientation according to the set width and height. By default it's horizontal.

• Properties
  • active : ControlActive
  • midi_mapping : ControlMidiMappingString
  • min : ScrollbarMin
  • max : ScrollbarMax
  • value : ScrollbarValue
  • step : ScrollbarStep
  • pagestep : ScrollbarPagestep
  • background : ViewBackgroundStyle
  • autohide : ScrollbarAutoHide
  • visible : ViewVisibility
  • origin : ViewOrigin
  • width : ViewDimension
  • height : ViewDimension
  • size : ViewSize
  • tooltip : ViewTooltip
  • cursor : ViewCursorShape
  • views : renoise.Views.View[]
• Functions
  • add_notifier(self, notifier : IntegerValueNotifierFunction)
  • remove_notifier(self, notifier : IntegerValueNotifierFunction)
  • add_view(self, child : renoise.Views.View)
  • remove_view(self, child : renoise.Views.View)
  • swap_views(self, child1 : renoise.Views.View, child2 : renoise.Views.View)
  • add_child(self, child : renoise.Views.View)
  • remove_child(self, child : renoise.Views.View)
  • swap_childs(self, child1 : renoise.Views.View, child2 : renoise.Views.View)
• Aliases
  • ControlActive
  • ControlMidiMappingString
  • IntegerValueNotifierFunction
  • ScrollbarAutoHide
  • ScrollbarMax
  • ScrollbarMin
  • ScrollbarPagestep
  • ScrollbarStep
  • ScrollbarValue
  • ViewBackgroundStyle
  • ViewCursorShape
  • ViewDimension
  • ViewOrigin
  • ViewPosition
  • ViewSize
  • ViewTooltip
  • ViewVisibility

Properties

active : ControlActive

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

min : ScrollbarMin

Default 0. Minimum offset value.

max : ScrollbarMax

Default 100. Maximum offset value.

value : ScrollbarValue

Default 0. Offset value in range min to max - pagestep.

step : ScrollbarStep

Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar move the scrollable area.

pagestep : ScrollbarPagestep

Default 100. Size of the currently visible area.

background : ViewBackgroundStyle

Setup a background style for the view.

autohide : ScrollbarAutoHide

Default: false. When true, view gets automatically hidden when no scrolling is needed

visible : ViewVisibility

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

• Default: true

origin : ViewOrigin

The position of a view within its parent view. Only the stack layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.

width : ViewDimension

Deprecated. Use property size instead.

height : ViewDimension

Deprecated. Use property size instead.

size : ViewSize

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example vb:text { size = { width = "80%", height = 20}}. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.

tooltip : ViewTooltip

A ViewTooltip text that should be shown for this view on mouse hover.

• Default: "" (no tip will be shown)

cursor : ViewCursorShape

The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.

views : renoise.Views.View[]

READ-ONLY Empty for all controls, for layout views this contains the layout child views in the order they got added

Functions

add_notifier(self, notifier : IntegerValueNotifierFunction)

Add offset value change notifier

remove_notifier(self, notifier : IntegerValueNotifierFunction)

Remove offset value change notifier

add_view(self, child : renoise.Views.View)

Add a new child view to this view.

remove_view(self, child : renoise.Views.View)

Remove a child view from this view.

swap_views(self, child1 : renoise.Views.View, child2 : renoise.Views.View)

Swap position of two child views in this view. With a series of swaps views can be moved to any position in the parent.

add_child(self, child : renoise.Views.View)

Deprecated. Use add_view instead

remove_child(self, child : renoise.Views.View)

Deprecated. Use remove_view instead

swap_childs(self, child1 : renoise.Views.View, child2 : renoise.Views.View)

Deprecated. Use swap_views instead

Aliases

ControlActive

boolean

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

ControlMidiMappingString

string

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

IntegerValueNotifierFunction

(value : integer)

ScrollbarAutoHide

boolean

Default: false. When true, view gets automatically hidden when no scrolling is needed

ScrollbarMax

integer

Default 100. Maximum offset value.

ScrollbarMin

integer

Default 0. Minimum offset value.

ScrollbarPagestep

integer

Default 100. Size of the currently visible area.

ScrollbarStep

integer

Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar move the scrollable area.

ScrollbarValue

integer

Default 0. Offset value in range min to max - pagestep.

ViewBackgroundStyle

"body" | "border" | "group" | "invisible" | "panel" | "plain"

-- Setup a background style for the view. 
ViewBackgroundStyle:
    | "invisible" -- no background (Default)
    | "plain" -- undecorated, single coloured background
    | "border" -- same as plain, but with a bold nested border
    | "body" -- main "background" style, as used in dialog backgrounds
    | "panel" -- alternative "background" style, beveled
    | "group" -- background for "nested" groups within body

ViewCursorShape

"busy" | "change_value" | "crosshair" | "default" | "drag" | "drop" | "edit_text" | "empty" | "erase" | "extend_bottom" | "extend_bottom_alias" | "extend_left" | "extend_left_alias" | "extend_right" | "extend_right_alias" | "extend_top" | "extend_top_alias" | "marker" | "move" | "nodrop" | "none" | "pencil" | "play" | "resize_edge_diagonal_left" | "resize_edge_diagonal_right" | "resize_edge_horizontal" | "resize_edge_vertical" | "resize_horizontal" | "resize_vertical" | "zoom" | "zoom_horizontal" | "zoom_vertical"

-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
    | "none"
    | "empty"
    | "default"
    | "change_value"
    | "edit_text"
    | "pencil"
    | "marker"
    | "crosshair"
    | "move"
    | "erase"
    | "play"
    | "drag"
    | "drop"
    | "nodrop"
    | "busy"
    | "resize_vertical"
    | "resize_horizontal"
    | "resize_edge_vertical"
    | "resize_edge_horizontal"
    | "resize_edge_diagonal_left"
    | "resize_edge_diagonal_right"
    | "extend_left"
    | "extend_right"
    | "extend_top"
    | "extend_bottom"
    | "extend_left_alias"
    | "extend_right_alias"
    | "extend_top_alias"
    | "extend_bottom_alias"
    | "zoom_vertical"
    | "zoom_horizontal"
    | "zoom"

ViewDimension

string | integer

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

ViewOrigin

{ 1 : ViewPosition, 2 : ViewPosition } | { x : ViewPosition, y : ViewPosition }

The position of a view within its parent view. Only the stack layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.

ViewPosition

integer

Horizontal (x) or Vertical (y) position of a view within its parent view.

ViewSize

{ 1 : ViewDimension, 2 : ViewDimension } | { height : ViewDimension, width : ViewDimension }

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example vb:text { size = { width = "80%", height = 20}}. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.

ViewTooltip

string

A ViewTooltip text that should be shown for this view on mouse hover.

• Default: "" (no tip will be shown)

ViewVisibility

boolean

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

• Default: true