renoise.Views.TextField

Shows a text string that can be clicked and edited by the user.

 +----------------+
 | Editable Te|xt |
 +----------------+

Properties

active : TextActive

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

  • Default: true

align : TextAlignment

Only used when not editing.

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

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.

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

The currently shown text. The text will not be updated when editing, rather only after editing is complete (return is pressed, or focus is lost).

  • Default: ""

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_notifier(self, notifier : StringValueNotifierFunction)

Add value change (text change) notifier

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

Local Aliases

StringValueNotifierFunction

(value : string)

TextActive

boolean

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

  • Default: true

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

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

TextValue

string

The currently shown text. The text will not be updated when editing, rather only after editing is complete (return is pressed, or focus is lost).

  • 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