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
  • edit_mode : TextEditMode
  • font : TextFontStyle
  • height : ViewDimension
  • paragraphs : TextParagraphs
  • style : TextBackgroundStyle
  • text : TextValueAlias
  • tooltip : ViewTooltip
  • value : TextMultilineString
  • views : renoise.Views.View[]
  • visible : ViewVisibility
  • width : ViewDimension
• Functions
  • add_child(self, child : renoise.Views.View)
  • add_line(self, text : string)
  • add_notifier(self, notifier : StringValueNotifierFunction)
  • clear(self)
  • remove_child(self, child : renoise.Views.View)
  • remove_notifier(self, notifier : StringValueNotifierFunction)
  • scroll_to_first_line(self)
  • scroll_to_last_line(self)
• Local Aliases
  • StringValueNotifierFunction
  • TextActive
  • TextBackgroundStyle
  • TextEditMode
  • TextFontStyle
  • TextMultilineString
  • TextParagraphs
  • TextValueAlias
  • ViewDimension
  • ViewTooltip
  • ViewVisibility

Properties

active : TextActive

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

• Default: true

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

font : TextFontStyle

The style that the text should be displayed with.

height : 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 { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

paragraphs : TextParagraphs

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

• Default: []

style : TextBackgroundStyle

Default: "border"

text : TextValueAlias

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

• Default: ""

tooltip : ViewTooltip

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

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

value : TextMultilineString

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

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

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

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 { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

Functions

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

Add a new child view to this view.

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.

add_notifier(self, notifier : StringValueNotifierFunction)

Add value change (text change) notifier

clear(self)

Clear the whole text.

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

Remove a child view from this view.

remove_notifier(self, notifier : StringValueNotifierFunction)

Remove value change (text change) notifier

scroll_to_first_line(self)

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

scroll_to_last_line(self)

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

Local 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" | "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

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: ""

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.

ViewTooltip

string

A tooltip 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