Package nuke :: Class Panel
[hide private]
[frames] | no frames]

Class Panel

object --+
         |
        nuke.Panel

Panel

Instance Methods [hide private]
a new object with type S, a subtype of T
__new__(T, S, ...)
True if successful
addBooleanCheckBox(self, name, value)
Add a boolean check box knob to the panel.
True if successful
addButton(self, name, value)
Add a button to the panel.
True if successful
addClipnameSearch(self, name, value)
Add a clipname search knob to the panel.
True if successful
addEnumerationPulldown(self, name, value)
Add a pulldown menu to the panel.
True if successful
addExpressionInput(self, name, value)
Add an expression evaluator to the panel.
True if successful
addFilenameSearch(self, name, value)
Add a filename search knob to the panel.
True if successful
addMultilineTextInput(self, name, value)
Add a multi-line text knob to the panel.
True if successful
addNotepad(self, name, value)
Add a text edit widget to the panel.
True if successful
addPasswordInput(self, name, value)
Add a password input knob to the panel.
True if successful
addRGBColorChip(self, name, value)
Add a color chooser to the panel.
True if successful
addScriptCommand(self, name, value)
Add a script command evaluator to the panel.
True if successful
addSingleLineInput(self, name, value)
Add a single-line input knob to the panel.
True if successful
addTextFontPulldown(self, name, value)
Add a font chooser to the panel.
None
clear(self)
Clear all panel attributes.
The result of the script as a string, or None if it fails
execute(self, name)
Execute the script command associated with a particular label and return the result as a string.
True if successful
setTitle(self, val)
Set the current title for the panel.
True if successful
setWidth(self, val)
Set the width of the panel.
An int value indicating how the dialog was closed (normally, or cancelled)
show(self)
Display the panel.
The title as a string
title(self)
Get the current title for the panel.
The value for the field if any, otherwise None
value(self, name)
Get the value of a particular control in the panel.
The width as an int
width(self)
Get the width of the panel.

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(T, S, ...)

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

addBooleanCheckBox(self, name, value)

 

Add a boolean check box knob to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addButton(self, name, value)

 

Add a button to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addClipnameSearch(self, name, value)

 

Add a clipname search knob to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addEnumerationPulldown(self, name, value)

 

Add a pulldown menu to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addExpressionInput(self, name, value)

 

Add an expression evaluator to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addFilenameSearch(self, name, value)

 

Add a filename search knob to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addMultilineTextInput(self, name, value)

 

Add a multi-line text knob to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addNotepad(self, name, value)

 

Add a text edit widget to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addPasswordInput(self, name, value)

 

Add a password input knob to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addRGBColorChip(self, name, value)

 

Add a color chooser to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addScriptCommand(self, name, value)

 

Add a script command evaluator to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addSingleLineInput(self, name, value)

 

Add a single-line input knob to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

addTextFontPulldown(self, name, value)

 

Add a font chooser to the panel.

Parameters:
  • name - The name for the new knob.
  • value - The initial value for the new knob.
Returns: True if successful
True if successful.

execute(self, name)

 

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

Parameters:
  • name - The name of the script field to execute.
Returns: The result of the script as a string, or None if it fails
The result of the script as a string, or None if it fails.

setTitle(self, val)

 

Set the current title for the panel.

Parameters:
  • val - The title as a string.
Returns: True if successful
True if successful.

setWidth(self, val)

 

Set the width of the panel.

Parameters:
  • val - The width as an int.
Returns: True if successful
True if successful.

show(self)

 

Display the panel.

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

title(self)

 

Get the current title for the panel.

Returns: The title as a string
The title as a string.

value(self, name)

 

Get the value of a particular control in the panel.

Parameters:
  • name - The name of the knob to get a value from.
Returns: The value for the field if any, otherwise None
The value for the field if any, otherwise None.

width(self)

 

Get the width of the panel.

Returns: The width as an int
The width as an int.