pymel.core.windows.toolCollection¶

toolCollection(*args, **kwargs)¶

This command creates a tool button collection. Collections are parented to the current default layout if no parent is specified with the -p/parent flag. As children of the layout they will be deleted when the layout is deleted. Collections may also span more than one window if the -gl/global flag is used. In this case the collection has no parent and must be explicitly deleted with the ‘deleteUI’ command when it is no longer wanted.

Flags:

Long Name / Short Name		Argument Types	Properties
collectionItemArray / cia		bool
	Returns a string list giving the long names of all the items in this collection.
defineTemplate / dt		unicode
	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.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
gl / gl		bool
	Set the collection to have no parent layout. This flag must be specified when the collection is created and can not be queried or edited. Consequently, global collections must be explicitly deleted.
numberOfCollectionItems / nci		bool
	Returns the number of items that are in this collection.
parent / p		unicode
	Specify the parent to associate the collection with. The collection will be deleted along with the parent. This flag must be specified when the collection is created and can not be edited.
select / sl		unicode
	Select the specified collection item. If queried will return the name of the currently selected collection item.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.toolCollection

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout93') #
pm.toolCollection()
# Result: ui.ToolCollection('window1|columnLayout93|toolCollection3') #
pm.toolButton( tool='selectSuperContext', toolImage1=('selectSuperContext', 'aselect.xpm') )
# Result: ui.ToolButton('window1|columnLayout93|toolButton4') #
pm.toolButton( tool='moveSuperContext', toolImage1=('moveSuperContext', 'move_M.png') )
# Result: ui.ToolButton('window1|columnLayout93|toolButton5') #
pm.toolButton( tool='scaleSuperContext', toolImage1=('scaleSuperContext', 'scale_M.png') )
# Result: ui.ToolButton('window1|columnLayout93|toolButton6') #
pm.showWindow()