pymel.core.uitypes.ScriptedPanelType

class ScriptedPanelType

class counterpart of mel function scriptedPanelType

This command defines the callbacks for a type of scripted panel. The panel type created by this command is then used when creating a scripted panel. See also the ‘scriptedPanel’ command.

getAddCallback(**kwargs)

This flag specifies the callback procedure for adding the panel to a particular control layout. The parent layout is guaranteed to be the current default layout when the proc is called. If its name is required then it can be queried with ‘setParent -q’. Any editors should be parented here. global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

getCopyStateCallback(**kwargs)

This flag specifies the callback procedure for copying the state of the panel when a tear-off copy of the panel is made. The callback proc has the form: global proc procName (string $panelName, string $newPanelName) { .... } This procedure will be executed immediately after the addCallback procedure has finished executing. At that point, the copied panel will be fully created and accessible to facilitate copying of panel settings. Note: the addCallback procedure is called after the createCallback procedure has been called.

Derived from mel command maya.cmds.scriptedPanelType

getCreateCallback(**kwargs)

This flag specifies the callback procedure for initially creating the panel object. No UI should be created here. Any editors owned by the panel should be created here unparented. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

getCustomView(**kwargs)

This flag specifies if this view is a custom 3d view for MPx3dModelView types. This flag should only be used for MPx3dModelView types.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.scriptedPanelType

getDeleteCallback(**kwargs)

This flag specifies the callback procedure for final deletion of the panel. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

getInitCallback(**kwargs)

This flag specifies the callback procedure for the initialize callback. This will be called on file -new and file -open to give the panel an opportunity to re-initialize to a starting state, if required. The panel may be parented or unparented at this time. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

getObsolete(**kwargs)

This flag specifies that this type is no longer used in Maya.

Derived from mel command maya.cmds.scriptedPanelType

getRemoveCallback(**kwargs)

This flag specifies the callback procedure for removing the panel from its current control layout. Any editors should be unparented here. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

getRetainOnFileOpen(**kwargs)

This flag specifies if panels of this type should be retained after restoring panel cofiguration during file open. Default value is false.

Derived from mel command maya.cmds.scriptedPanelType

getSaveStateCallback(**kwargs)

This flag specifies the callback procedure for saving the state of the panel. The callback proc has the form: global proc string procName (string $panelName) { .... } Note that the proc returns a string. This string will be executed after the createCallback has been called to facilitate restoring the panel state.

Derived from mel command maya.cmds.scriptedPanelType

getUnique(**kwargs)

This flag specifies if only one instance of this type of panel can exist at a given time.

Derived from mel command maya.cmds.scriptedPanelType

setAddCallback(val=True, **kwargs)

This flag specifies the callback procedure for adding the panel to a particular control layout. The parent layout is guaranteed to be the current default layout when the proc is called. If its name is required then it can be queried with ‘setParent -q’. Any editors should be parented here. global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

setCopyStateCallback(val=True, **kwargs)

This flag specifies the callback procedure for copying the state of the panel when a tear-off copy of the panel is made. The callback proc has the form: global proc procName (string $panelName, string $newPanelName) { .... } This procedure will be executed immediately after the addCallback procedure has finished executing. At that point, the copied panel will be fully created and accessible to facilitate copying of panel settings. Note: the addCallback procedure is called after the createCallback procedure has been called.

Derived from mel command maya.cmds.scriptedPanelType

setCreateCallback(val=True, **kwargs)

This flag specifies the callback procedure for initially creating the panel object. No UI should be created here. Any editors owned by the panel should be created here unparented. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

setCustomView(val=True, **kwargs)

This flag specifies if this view is a custom 3d view for MPx3dModelView types. This flag should only be used for MPx3dModelView types.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.scriptedPanelType

setDeleteCallback(val=True, **kwargs)

This flag specifies the callback procedure for final deletion of the panel. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

setInitCallback(val=True, **kwargs)

This flag specifies the callback procedure for the initialize callback. This will be called on file -new and file -open to give the panel an opportunity to re-initialize to a starting state, if required. The panel may be parented or unparented at this time. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

setObsolete(val=True, **kwargs)

This flag specifies that this type is no longer used in Maya.

Derived from mel command maya.cmds.scriptedPanelType

setRemoveCallback(val=True, **kwargs)

This flag specifies the callback procedure for removing the panel from its current control layout. Any editors should be unparented here. The callback proc has the form: global proc procName (string $panelName) { ....

Derived from mel command maya.cmds.scriptedPanelType

setRetainOnFileOpen(val=True, **kwargs)

This flag specifies if panels of this type should be retained after restoring panel cofiguration during file open. Default value is false.

Derived from mel command maya.cmds.scriptedPanelType

setSaveStateCallback(val=True, **kwargs)

This flag specifies the callback procedure for saving the state of the panel. The callback proc has the form: global proc string procName (string $panelName) { .... } Note that the proc returns a string. This string will be executed after the createCallback has been called to facilitate restoring the panel state.

Derived from mel command maya.cmds.scriptedPanelType

setUnique(val=True, **kwargs)

This flag specifies if only one instance of this type of panel can exist at a given time.

Derived from mel command maya.cmds.scriptedPanelType