scriptedPanelType is undoable, queryable, and editable.
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.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
-addCallback(-acb)
|
string
|
|
|
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) { .... }
|
|
-copyStateCallback(-ocb)
|
string
|
|
|
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.
|
|
-createCallback(-ccb)
|
string
|
|
|
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) { .... }
|
|
-customView(-cv)
|
boolean
|
|
|
This flag specifies if this view is a custom 3d view for
MPx3dModelView types. This flag should only be used for
MPx3dModelView types.
|
|
-defineTemplate(-dt)
|
string
|
|
|
Puts the command in a mode where any other flags and arguments are
parsed and added to the command template specified in the argument.
They will be used as default arguments in any subsequent
invocations of the command when templateName is set as the
current template.
|
|
-deleteCallback(-dcb)
|
string
|
|
|
This flag specifies the callback procedure for final deletion of
the panel. The callback proc has the form:
global proc procName (string $panelName) { .... }
|
|
-exists(-ex)
|
|
|
|
Returns whether the
specified object exists or not. Other flags are ignored.
|
|
-hotkeyCtxClient(-hkc)
|
string
|
|
|
This flag is used to specify the name of the hotkey context client for this panel type.
By default, it is the same as the panel type.
|
|
-initCallback(-icb)
|
string
|
|
|
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) { .... }
|
|
-label(-l)
|
string
|
|
|
-obsolete(-o)
|
boolean
|
|
|
This flag specifies that this type is no longer used in Maya.
|
|
-removeCallback(-rcb)
|
string
|
|
|
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) { .... }
|
|
-retainOnFileOpen(-rfo)
|
boolean
|
|
|
This flag specifies if panels of this type should be retained after
restoring panel cofiguration during file open. Default value is false.
|
|
-saveStateCallback(-scb)
|
string
|
|
|
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.
|
|
-unique(-u)
|
boolean
|
|
|
This flag specifies if only one instance of this type of panel can exist
at a given time.
|
|
-useTemplate(-ut)
|
string
|
|
|
Forces the command to use a command template other than
the current one.
|
|