pymel.core.windows.iconTextRadioCollection

static windows.iconTextRadioCollection(*args, **kwargs)

This command creates a cluster for iconTextRadioButtons. Clusters will be 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. Clusters may also span more than one window if the -g/global flag is used. In this case the cluster has no parent so must be explicitly deleted with the ‘deleteUI’ command.

Flags:
Long name (short name) Argument Types Properties
collectionItemArray (cia) bool ../../../_images/query.gif
 

Returns a string list giving the long names of all the items in this collection. Flag can have multiple arguments, passed either as a tuple or a list.

defineTemplate (dt) unicode  
   
disableCommands (dcm) bool ../../../_images/edit.gif
 

Allows a particular iconTextRadioButton in the collection to be selected without invoking the commands attached to the -cc/changeCommand, -onc/onCommand, or -ofc/offCommand flags. This flag is only meaningful when used in conjuction with the -edit and -select flags.

exists (ex) bool  
   
gl (gl) bool ../../../_images/create.gif ../../../_images/query.gif
 

Set the collection to have no parent layout. If the collection has a parent layout then it will be deleted with that layout, otherwise if it is specified to be global it must be explicitly deleted.

numberOfCollectionItems (nci) bool ../../../_images/query.gif
 
Returns the number of items that are in this collection.
parent (p) unicode ../../../_images/create.gif
 
Set the specified layout to be the parent layout of the cluster.
select (sl) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Select the specified collection item. If queried will return the name of the currently selected collection item.
useTemplate (ut) unicode  
   

Derived from mel command maya.cmds.iconTextRadioCollection

Example:

import pymel.core as pm

pm.window( tlc=(100, 400) )
# Result: ui.Window('window1') #
pm.columnLayout( adj=True )
# Result: ui.ColumnLayout('window1|columnLayout47') #
pm.iconTextRadioCollection( 'itRadCollection' )
# Result: ui.IconTextRadioCollection('window1|columnLayout47|itRadCollection') #
pm.iconTextRadioButton( st='textOnly', i1='sphere.png', l='sphere' )
# Result: ui.IconTextRadioButton('window1|columnLayout47|iconTextRadioButton5') #
pm.iconTextRadioButton( st='iconOnly', i1='spotlight.png', l='spotlight' )
# Result: ui.IconTextRadioButton('window1|columnLayout47|iconTextRadioButton6') #
pm.iconTextRadioButton( st='iconAndTextHorizontal', i1='cone.png', l='cone' )
# Result: ui.IconTextRadioButton('window1|columnLayout47|iconTextRadioButton7') #
pm.iconTextRadioButton( st='iconAndTextVertical', i1='cube.png', l='cube' )
# Result: ui.IconTextRadioButton('window1|columnLayout47|iconTextRadioButton8') #
pm.showWindow()

Previous topic

pymel.core.windows.iconTextRadioButton

Next topic

pymel.core.windows.iconTextScrollList

Core

Core Modules

Other Modules

This Page