renoise.Views.MultiLineTextField

Shows multiple text lines of text, auto-wrapping paragraphs into lines. The text can be edited by the user.

 +--------------------------+-+
 | Editable Te|xt.          |+|
 |                          | |
 | With multiple paragraphs | |
 | and auto-wrapping        |+|
 +--------------------------+-+

• Properties
  • active : TextActive
  • value : TextMultilineString
  • text : TextValueAlias
  • selected_text : TextMultilineSelectedString
  • paragraphs : TextParagraphs
  • font : TextFontStyle
  • style : TextBackgroundStyle
  • edit_mode : TextEditMode
  • visible : ViewVisibility
  • origin : ViewOrigin
  • width : ViewDimension
  • height : ViewDimension
  • size : ViewSize
  • tooltip : ViewTooltip
  • cursor : ViewCursorShape
  • views : renoise.Views.View[]
• Functions
  • add_notifier(self, notifier : StringValueNotifierFunction)
  • remove_notifier(self, notifier : StringValueNotifierFunction)
  • scroll_to_last_line(self)
  • scroll_to_first_line(self)
  • add_line(self, text : string)
  • clear(self)
  • 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
  • StringValueNotifierFunction
  • TextActive
  • TextBackgroundStyle
  • TextEditMode
  • TextFontStyle
  • TextMultilineSelectedString
  • TextMultilineString
  • TextParagraphs
  • TextValueAlias
  • ViewCursorShape
  • ViewDimension
  • ViewOrigin
  • ViewPosition
  • ViewSize
  • ViewTooltip
  • ViewVisibility

Properties

active : TextActive

When false, text is displayed but can not be entered/modified by the user.

• Default: true

value : TextMultilineString

The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs.

text : TextValueAlias

Exactly the same as "value"; provided for consistency.

• Default: ""

selected_text : TextMultilineSelectedString

READ-ONLY The currently selected text, if any. Newlines (Windows, Mac or Unix styled) will use the unix newline format.

paragraphs : TextParagraphs

A table of text lines to be used instead of specifying a single text line with newline characters like "text"

• Default: []

font : TextFontStyle

The style that the text should be displayed with.

style : TextBackgroundStyle

Default: "border"

edit_mode : TextEditMode

True when the text field is focused. setting it at run-time programmatically will focus the text field or remove the focus (focus the dialog) accordingly.

• Default: false

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 : StringValueNotifierFunction)

Add value change (text change) notifier

remove_notifier(self, notifier : StringValueNotifierFunction)

Remove value change (text change) notifier

scroll_to_last_line(self)

When a scroll bar is visible, scroll the text to show the last line.

scroll_to_first_line(self)

When a scroll bar is visible, scroll the text to show the first line.

add_line(self, text : string)

Append a new text to the existing text. Newline characters in the string will create new paragraphs, otherwise a single paragraph is appended.

clear(self)

Clear the whole text.

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

StringValueNotifierFunction

(value : string)

TextActive

boolean

When false, text is displayed but can not be entered/modified by the user.

• Default: true

TextBackgroundStyle

"body" | "border" | "strong"

-- Setup the text view's background:
TextBackgroundStyle:
    | "body" -- simple text color with no background
    | "strong" -- stronger text color with no background
    | "border" -- text on a bordered background

TextEditMode

boolean

True when the text field is focused. setting it at run-time programmatically will focus the text field or remove the focus (focus the dialog) accordingly.

• Default: false

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

TextMultilineSelectedString

string

READ-ONLY The currently selected text, if any. Newlines (Windows, Mac or Unix styled) will use the unix newline format.

TextMultilineString

string

The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs.

TextParagraphs

string[]

A table of text lines to be used instead of specifying a single text line with newline characters like "text"

• Default: []

TextValueAlias

string

Exactly the same as "value"; provided for consistency.

• Default: ""

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