Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

renoise.Views.Text

Shows a "static" text string. Static just means that its not linked, bound to some value and has no notifiers. The text can not be edited by the user. Nevertheless you can of course change the text at run-time with the "text" property.

  Text, Bla 1

Properties

text : TextSingleLineString

The text that should be displayed. Setting a new text will resize the view in order to make the text fully visible (expanding only).

  • Default: ""

font : TextFontStyle

The style that the text should be displayed with.

style : TextStyle

Get/set the color style the text should be displayed with.

color : TextColor

When set, the text will be drawn in the specified color. Set style to something else than "custom" or color to {0, 0, 0} to enable the default theme color for the text again.

orientation : TextOrientation

Setup the texts's orientation (writing direction).

align : TextAlignment

Setup the text's alignment. Applies only when the view's size is larger than the needed size to draw the text

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_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

RGBColor

{ 1 : integer, 2 : integer, 3 : integer }

A table of 3 bytes (ranging from 0 to 255) representing the red, green and blue channels of a color. {0xFF, 0xFF, 0xFF} is white {165, 73, 35} is the red from the Renoise logo

TextAlignment

"center" | "left" | "right"

-- Setup the text's alignment. Applies only when the view's size is larger than
-- the needed size to draw the text
TextAlignment:
    | "left" -- (Default)
    | "right" -- aligned to the right
    | "center" -- center text

TextColor

RGBColor | ThemeColor

-- When set, the text will be drawn in the specified color.
-- Set style to something else than "custom" or color to `{0, 0, 0}`
-- to enable the default theme color for the text again.
-- A table of 3 bytes (ranging from 0 to 255)
-- representing the red, green and blue channels of a color.
-- {0xFF, 0xFF, 0xFF} is white
-- {165, 73, 35} is the red from the Renoise logo
-- The application theme's colors
TextColor:
    | "main_back"
    | "main_font"
    | "alternate_main_back"
    | "alternate_main_font"
    | "body_back"
    | "body_font"
    | "strong_body_font"
    | "button_back"
    | "button_font"
    | "button_highlight_font"
    | "selected_button_back"
    | "selected_button_font"
    | "selection_back"
    | "selection_font"
    | "standby_selection_back"
    | "standby_selection_font"
    | "midi_mapping_back"
    | "midi_mapping_font"
    | "tooltip_back"
    | "tooltip_font"
    | "valuebox_back"
    | "valuebox_font"
    | "valuebox_font_icons"
    | "scrollbar"
    | "slider"
    | "folder"
    | "pattern_default_back"
    | "pattern_default_font"
    | "pattern_default_font_volume"
    | "pattern_default_font_panning"
    | "pattern_default_font_pitch"
    | "pattern_default_font_delay"
    | "pattern_default_font_global"
    | "pattern_default_font_other"
    | "pattern_default_font_dspfx"
    | "pattern_default_font_unused"
    | "pattern_highlighted_back"
    | "pattern_highlighted_font"
    | "pattern_highlighted_font_volume"
    | "pattern_highlighted_font_panning"
    | "pattern_highlighted_font_pitch"
    | "pattern_highlighted_font_delay"
    | "pattern_highlighted_font_global"
    | "pattern_highlighted_font_other"
    | "pattern_highlighted_font_dspfx"
    | "pattern_highlighted_font_unused"
    | "pattern_playposition_back"
    | "pattern_playposition_font"
    | "pattern_centerbar_back"
    | "pattern_centerbar_font"
    | "pattern_centerbar_back_standby"
    | "pattern_centerbar_font_standby"
    | "pattern_selection"
    | "pattern_standby_selection"
    | "pattern_mute_state"
    | "automation_grid"
    | "automation_line_edge"
    | "automation_line_fill"
    | "automation_point"
    | "automation_marker_play"
    | "automation_marker_single"
    | "automation_marker_pair"
    | "automation_marker_diamond"
    | "vumeter_meter"
    | "vumeter_meter_low"
    | "vumeter_meter_middle"
    | "vumeter_meter_high"
    | "vumeter_peak"
    | "vumeter_back_normal"
    | "vumeter_back_clipped"
    | "default_color_01"
    | "default_color_02"
    | "default_color_03"
    | "default_color_04"
    | "default_color_05"
    | "default_color_06"
    | "default_color_07"
    | "default_color_08"
    | "default_color_09"
    | "default_color_10"
    | "default_color_11"
    | "default_color_12"
    | "default_color_13"
    | "default_color_14"
    | "default_color_15"
    | "default_color_16"

TextFontStyle

"big" | "bold" | "code" | "italic" | "mono" | "normal"

-- The style that the text should be displayed with.
TextFontStyle:
    | "normal" -- (Default)
    | "big" -- big text
    | "bold" -- bold font
    | "italic" -- italic font
    | "mono" -- monospace font
    | "code" -- monospace code font

TextOrientation

"horizontal" | "horizontal-rl" | "vertical" | "vertical-tb"

-- Setup the texts's orientation (writing direction).
TextOrientation:
    | "horizontal" -- Draw from left to right (Default)
    | "horizontal-rl" -- Draw from right to left
    | "vertical" -- Draw from bottom to top
    | "vertical-tb" -- Draw from top to bottom

TextSingleLineString

string

The text that should be displayed. Setting a new text will resize the view in order to make the text fully visible (expanding only).

  • Default: ""

TextStyle

"custom" | "disabled" | "normal" | "strong"

-- Get/set the color style the text should be displayed with.
TextStyle:
    | "normal" -- (Default)
    | "strong" -- highlighted color
    | "disabled" -- greyed out color
    | "custom" -- custom color

ThemeColor

"alternate_main_back" | "alternate_main_font" | "automation_grid" | "automation_line_edge" | "automation_line_fill" | "automation_marker_diamond" | "automation_marker_pair" | "automation_marker_play" | "automation_marker_single" | "automation_point" | "body_back" | "body_font" | "button_back" | "button_font" | "button_highlight_font" | "default_color_01" | "default_color_02" | "default_color_03" | "default_color_04" | "default_color_05" | "default_color_06" | "default_color_07" | "default_color_08" | "default_color_09" | "default_color_10" | "default_color_11" | "default_color_12" | "default_color_13" | "default_color_14" | "default_color_15" | "default_color_16" | "folder" | "main_back" | "main_font" | "midi_mapping_back" | "midi_mapping_font" | "pattern_centerbar_back" | "pattern_centerbar_back_standby" | "pattern_centerbar_font" | "pattern_centerbar_font_standby" | "pattern_default_back" | "pattern_default_font" | "pattern_default_font_delay" | "pattern_default_font_dspfx" | "pattern_default_font_global" | "pattern_default_font_other" | "pattern_default_font_panning" | "pattern_default_font_pitch" | "pattern_default_font_unused" | "pattern_default_font_volume" | "pattern_highlighted_back" | "pattern_highlighted_font" | "pattern_highlighted_font_delay" | "pattern_highlighted_font_dspfx" | "pattern_highlighted_font_global" | "pattern_highlighted_font_other" | "pattern_highlighted_font_panning" | "pattern_highlighted_font_pitch" | "pattern_highlighted_font_unused" | "pattern_highlighted_font_volume" | "pattern_mute_state" | "pattern_playposition_back" | "pattern_playposition_font" | "pattern_selection" | "pattern_standby_selection" | "scrollbar" | "selected_button_back" | "selected_button_font" | "selection_back" | "selection_font" | "slider" | "standby_selection_back" | "standby_selection_font" | "strong_body_font" | "tooltip_back" | "tooltip_font" | "valuebox_back" | "valuebox_font" | "valuebox_font_icons" | "vumeter_back_clipped" | "vumeter_back_normal" | "vumeter_meter" | "vumeter_meter_high" | "vumeter_meter_low" | "vumeter_meter_middle" | "vumeter_peak"

-- The application theme's colors
ThemeColor:
    | "main_back"
    | "main_font"
    | "alternate_main_back"
    | "alternate_main_font"
    | "body_back"
    | "body_font"
    | "strong_body_font"
    | "button_back"
    | "button_font"
    | "button_highlight_font"
    | "selected_button_back"
    | "selected_button_font"
    | "selection_back"
    | "selection_font"
    | "standby_selection_back"
    | "standby_selection_font"
    | "midi_mapping_back"
    | "midi_mapping_font"
    | "tooltip_back"
    | "tooltip_font"
    | "valuebox_back"
    | "valuebox_font"
    | "valuebox_font_icons"
    | "scrollbar"
    | "slider"
    | "folder"
    | "pattern_default_back"
    | "pattern_default_font"
    | "pattern_default_font_volume"
    | "pattern_default_font_panning"
    | "pattern_default_font_pitch"
    | "pattern_default_font_delay"
    | "pattern_default_font_global"
    | "pattern_default_font_other"
    | "pattern_default_font_dspfx"
    | "pattern_default_font_unused"
    | "pattern_highlighted_back"
    | "pattern_highlighted_font"
    | "pattern_highlighted_font_volume"
    | "pattern_highlighted_font_panning"
    | "pattern_highlighted_font_pitch"
    | "pattern_highlighted_font_delay"
    | "pattern_highlighted_font_global"
    | "pattern_highlighted_font_other"
    | "pattern_highlighted_font_dspfx"
    | "pattern_highlighted_font_unused"
    | "pattern_playposition_back"
    | "pattern_playposition_font"
    | "pattern_centerbar_back"
    | "pattern_centerbar_font"
    | "pattern_centerbar_back_standby"
    | "pattern_centerbar_font_standby"
    | "pattern_selection"
    | "pattern_standby_selection"
    | "pattern_mute_state"
    | "automation_grid"
    | "automation_line_edge"
    | "automation_line_fill"
    | "automation_point"
    | "automation_marker_play"
    | "automation_marker_single"
    | "automation_marker_pair"
    | "automation_marker_diamond"
    | "vumeter_meter"
    | "vumeter_meter_low"
    | "vumeter_meter_middle"
    | "vumeter_meter_high"
    | "vumeter_peak"
    | "vumeter_back_normal"
    | "vumeter_back_clipped"
    | "default_color_01"
    | "default_color_02"
    | "default_color_03"
    | "default_color_04"
    | "default_color_05"
    | "default_color_06"
    | "default_color_07"
    | "default_color_08"
    | "default_color_09"
    | "default_color_10"
    | "default_color_11"
    | "default_color_12"
    | "default_color_13"
    | "default_color_14"
    | "default_color_15"
    | "default_color_16"

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