pymel.core.general.toolPropertyWindow

toolPropertyWindow(*args, **kwargs)

End users should only call this command as 1. a query (in the custom tool property sheet code) or 2. with no arguments to create the default tool property sheet. The more complex uses of it are internal. In query mode, return type is based on queried flag.

Flags:
Long name (short name) Argument Types Properties
field (fld) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the name of the text field used to store the tool name in the property sheet.
helpButton (hb) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the name of the button used to show help on the tool in the property sheet.
icon (icn) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the name of the static picture object (used to display the tool icon in the property sheet).
inMainWindow (imw) bool ../../../_images/create.gif
 

Specify true if you want the tool settings to appear in the main window rather than a separate window.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

location (loc) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the location of the current tool property sheet, or an empty string if there is none.
noviceMode (nm) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the ‘novice mode’ flag.(unused at the moment)
resetButton (rb) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the name of the button used to restore the tool settings in the property sheet.
selectCommand (sel) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the property sheet’s select command.
showCommand (shw) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Sets/returns the property sheet’s display command.

Derived from mel command maya.cmds.toolPropertyWindow

Example:

import pymel.core as pm

pm.toolPropertyWindow()
pictureObject = pm.toolPropertyWindow(q=True, icon=True)

Previous topic

pymel.core.general.toolHasOptions

Next topic

pymel.core.general.transformCompare

Core

Core Modules

Other Modules

This Page