StringParam

Inherits StringParamBase

Synopsis

This parameter is used to contain a string. See here for more details.

Functions

Detailed Description

A StringParam can have several forms on the user interface, depending on its type

Here are the different types of string parameters:

../../../_images/stringParam.png

A basic string that can be edited by the user

../../../_images/stringLabel.png

A non animating label string that the user cannot edit

../../../_images/multiLineString.png

A multi-line string that the user can edit and animate

../../../_images/multiLineRichTextParam.png

A multi-line string with rich text support with a subset of html

Member functions description

NatronEngine.StringParam.setType(type)
Parameters:type – NatronEngine.StringParam.TypeEnum

Set the type of the StringParam. This should be called right away after creation time.

Warning

Once called, you should call refreshUserParamsGUI() to update the user interface.