Package nuke :: Class String_Knob

Class String_Knob

object --+    
         |    
 nuke.Knob --+
             |
            nuke.String_Knob

Known Subclasses:

A knob which holds a string value. Appears as a text entry field in a Node panel.

Instance Methods

[hide private]

__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature

a new object with type S, a subtype of T

__new__(T, S, ...)

string

getText(self, oc)
Get the non-evaluated value of this knob - also see `value()`

str

getValue(self, oc)
Get the evaluated value of this knob as a string - also see `getText()`.

None

setText(self, val, view='default')
Set value of knob.

None

setValue(self, val, view='default')
Set value of knob.

None

splitView(self, view)
Split the view away from the current knob value.

None

unsplitView(self, view)
Unsplit the view so that it shares a value with other views.

str

value(self, oc)
Get the evaluated value of this knob as a string - also see `getText()`.

Inherited from Knob: Class, clearAnimated, clearFlag, critical, debug, enabled, error, fromScript, fullyQualifiedName, getDerivative, getFlag, getIntegral, getKeyIndex, getKeyList, getKeyTime, getNthDerivative, getNumKeys, getValueAt, hasExpression, isAnimated, isKey, isKeyAt, label, name, node, removeKey, removeKeyAt, setAnimated, setEnabled, setExpression, setFlag, setLabel, setName, setTooltip, setValueAt, setVisible, toScript, tooltip, visible, warning

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

new(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

getText(self, oc)

Get the non-evaluated value of this knob - also see `value()`

Parameters:

oc - Optional parameter specifying the output context. Return text associated with knob.

Returns: string

getValue(self, oc)

Get the evaluated value of this knob as a string - also see `getText()`.

Parameters:

oc - Optional parameter specifying the output context.

Returns: str

String value.

Overrides: Knob.getValue

setText(self, val, view='default')

Set value of knob.

Parameters:

val - The new value.
view - Optional parameter specifying which view to set the value for. If omitted, the value will be set for the default view.

Returns: None

None

setValue(self, val, view='default')

Set value of knob.

Parameters:

val - The new value.
view - Optional parameter specifying which view to set the value for. If omitted, the value will be set for the default view.

Returns: None

None

Overrides: Knob.setValue

splitView(self, view)

Split the view away from the current knob value.

Parameters:

view - Optional view. Default is current view.

Returns: None

None.

unsplitView(self, view)

Unsplit the view so that it shares a value with other views.

Parameters:

view - Optional view. Default is current view.

Returns: None

None.

value(self, oc)

Get the evaluated value of this knob as a string - also see `getText()`.

Parameters:

oc - Optional parameter specifying the output context.

Returns: str

String value.

Overrides: Knob.value

Class String_Knob

__init__(...) (Constructor)

__new__(T, S, ...)

getText(self, oc)

getValue(self, oc)

setText(self, val, view='default')

setValue(self, val, view='default')

splitView(self, view)

unsplitView(self, view)

value(self, oc)

init(...)
(Constructor)

new(T, S, ...)