pymel.core.uitypes.ScriptedPanel

Inheritance diagram of ScriptedPanel

class ScriptedPanel

class counterpart of mel function scriptedPanel

This command will create an instance of the specified scriptedPanelType. A panel is a collection of UI objects (buttons, fields, graphical views) that are grouped together. A panel can be moved around as a group within the application interface, and torn off to exist in its own window. The panel takes care of maintaining the state of its UI when it is relocated, or recreated. A scripted panel is a panel that is defined in MEL, with all of the required callbacks available as MEL proc’s.

copy(val=True, **kwargs)

Makes this panel a copy of the specified panel. Both panels must be of the same type.

Derived from mel command maya.cmds.scriptedPanel

getControl(**kwargs)

Returns the top level control for this panel. Usually used for getting a parent to attach popup menus. CAUTION: panels may not have controls at times. This flag can return “” if no control is present.

Derived from mel command maya.cmds.scriptedPanel

getDocTag(**kwargs)

Attaches a tag to the maya panel.

Derived from mel command maya.cmds.scriptedPanel

getIsUnique(**kwargs)

Returns true if only one instance of this panel type is allowed.

Derived from mel command maya.cmds.scriptedPanel

getLabel(**kwargs)

Specifies the user readable label for the panel.

Derived from mel command maya.cmds.scriptedPanel

getMenuBarVisible(**kwargs)

Controls whether the menu bar for the panel is displayed.

Derived from mel command maya.cmds.scriptedPanel

getNeedsInit(**kwargs)

(Internal) On Edit will mark the panel as requiring initialization. Query will return whether the panel is marked for initialization. Used during file -new and file -open.

Derived from mel command maya.cmds.scriptedPanel

getPopupMenuProcedure(**kwargs)

Specifies the procedure called for building the panel’s popup menu(s). The default value is “buildPanelPopupMenu”. The procedure should take one string argument which is the panel’s name.

Derived from mel command maya.cmds.scriptedPanel

getTearOff(**kwargs)

Will tear off this panel into a separate window with a paneLayout as the parent of the panel. When queried this flag will return if the panel has been torn off into its own window.

Derived from mel command maya.cmds.scriptedPanel

getType(**kwargs)

This flag specifies the type of scripted panel to create.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.scriptedPanel

init(val=True, **kwargs)

Initializes the panel’s default state. This is usually done automatically on file -new and file -open.

Derived from mel command maya.cmds.scriptedPanel

replacePanel(val=True, **kwargs)

Will replace the specifed panel with this panel. If the target panel is within the same layout it will perform a swap.

Derived from mel command maya.cmds.scriptedPanel

setDocTag(val=True, **kwargs)

Attaches a tag to the maya panel.

Derived from mel command maya.cmds.scriptedPanel

setLabel(val=True, **kwargs)

Specifies the user readable label for the panel.

Derived from mel command maya.cmds.scriptedPanel

setMenuBarVisible(val=True, **kwargs)

Controls whether the menu bar for the panel is displayed.

Derived from mel command maya.cmds.scriptedPanel

setNeedsInit(val=True, **kwargs)

(Internal) On Edit will mark the panel as requiring initialization. Query will return whether the panel is marked for initialization. Used during file -new and file -open.

Derived from mel command maya.cmds.scriptedPanel

setPopupMenuProcedure(val=True, **kwargs)

Specifies the procedure called for building the panel’s popup menu(s). The default value is “buildPanelPopupMenu”. The procedure should take one string argument which is the panel’s name.

Derived from mel command maya.cmds.scriptedPanel

setTearOff(val=True, **kwargs)

Will tear off this panel into a separate window with a paneLayout as the parent of the panel. When queried this flag will return if the panel has been torn off into its own window.

Derived from mel command maya.cmds.scriptedPanel

unParent(val=True, **kwargs)

Specifies that the panel should be removed from its layout. This (obviously) cannot be used with query.

Derived from mel command maya.cmds.scriptedPanel

Previous topic

pymel.core.uitypes.ScriptTable

Next topic

pymel.core.uitypes.ScriptedPanelType

Core

Core Modules

Other Modules

This Page