nuke.Panel

class nuke.Panel

Bases: object

Methods

addBooleanCheckBox

Add a boolean check box knob to the panel.

addButton

Add a button to the panel.

addClipnameSearch

Add a clipname search knob to the panel.

addEnumerationPulldown

Add a pulldown menu to the panel.

addExpressionInput

Add an expression evaluator to the panel.

addFilenameSearch

Add a filename search knob to the panel.

addMultilineTextInput

Add a multi-line text knob to the panel.

addNotepad

Add a text edit widget to the panel.

addPasswordInput

Add a password input knob to the panel.

addRGBColorChip

Add a color chooser to the panel.

addScriptCommand

Add a script command evaluator to the panel.

addSingleLineInput

Add a single-line input knob to the panel.

addTextFontPulldown

Add a font chooser to the panel.

clear

Clear all panel attributes.

execute

Execute the script command associated with a particular label and return the result as a string.

setTitle

Set the current title for the panel.

setWidth

Set the width of the panel.

show

Display the panel.

title

Get the current title for the panel.

value

Get the value of a particular control in the panel.

width

Get the width of the panel.

addBooleanCheckBox(name, value) True if successful.

Add a boolean check box knob to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addButton(name, value) True if successful.

Add a button to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addClipnameSearch(name, value) True if successful.

Add a clipname search knob to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addEnumerationPulldown(name, value) True if successful.

Add a pulldown menu to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addExpressionInput(name, value) True if successful.

Add an expression evaluator to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addFilenameSearch(name, value) True if successful.

Add a filename search knob to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addMultilineTextInput(name, value) True if successful.

Add a multi-line text knob to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addNotepad(name, value) True if successful.

Add a text edit widget to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addPasswordInput(name, value) True if successful.

Add a password input knob to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addRGBColorChip(name, value) True if successful.

Add a color chooser to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addScriptCommand(name, value) True if successful.

Add a script command evaluator to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addSingleLineInput(name, value) True if successful.

Add a single-line input knob to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

addTextFontPulldown(name, value) True if successful.

Add a font chooser to the panel. :param name: The name for the new knob. :param value: The initial value for the new knob. :return: True if successful.

clear() None

Clear all panel attributes.

execute(name) The result of the script as a string, or None if it fails.

Execute the script command associated with a particular label and return the result as a string. :param name: The name of the script field to execute. :return: The result of the script as a string, or None if it fails.

setTitle(val) True if successful.

Set the current title for the panel. :param val: The title as a string. :return: True if successful.

setWidth(val) True if successful.

Set the width of the panel. :param val: The width as an int. :return: True if successful.

show() An int value indicating how the dialog was closed (normally, or cancelled).

Display the panel. :return: An int value indicating how the dialog was closed (normally, or cancelled).

title() The title as a string.

Get the current title for the panel. :return: The title as a string.

value(name) The value for the field if any, otherwise None.

Get the value of a particular control in the panel. :param name: The name of the knob to get a value from. :return: The value for the field if any, otherwise None.

width() The width as an int.

Get the width of the panel. :return: The width as an int.