window

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

window( [string] , [backgroundColor=[float, float, float]], [closeCommand=script], [defineTemplate=string], [docTag=string], [dockCorner=[string, string]], [dockStation=boolean], [dockingLayout=string], [exists=boolean], [frontWindow=boolean], [height=int], [iconName=string], [iconify=boolean], [interactivePlacement=boolean], [leftEdge=int], [mainMenuBar=boolean], [mainWindow=boolean], [maximizeButton=boolean], [menuArray=boolean], [menuBar=boolean], [menuBarCornerWidget=[string, string]], [menuBarResize=boolean], [menuBarVisible=boolean], [menuIndex=[string, uint]], [minimizeButton=boolean], [minimizeCommand=script], [nestedDockingEnabled=boolean], [numberOfMenus=boolean], [parent=string], [resizeToFitChildren=boolean], [restoreCommand=script], [retain=boolean], [sizeable=boolean], [state=string], [title=string], [titleBar=boolean], [titleBarMenu=boolean], [toolbox=boolean], [topEdge=int], [topLeftCorner=[int, int]], [useTemplate=string], [visible=boolean], [width=int], [widthHeight=[int, int]])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

window is undoable, queryable, and editable.

Note: The window will require a control layout of some kind to arrange the controls (buttons, sliders, fields, etc.). Examples of control layouts are columnLayout, formLayout, rowLayout, etc.

Note: This command will clear the uiTemplate stack. Templates for a window need to be set after the window cmd.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
backgroundColor(bgc)	[float, float, float]
The background color of the window. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
closeCommand(cc)	script
Script executed after the window is closed.
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.
docTag(dtg)	string
Attach a tag to the window.
dockCorner(dc)	[string, string]
Specifies which docking areas occupied the four different corners of the window. By default docking windows on the bottom or top will span the whole window. Use multiple instances of this flag to allow the left and right docking areas to occupy the corners. This method has two arguments: docking corner and docking area. Possible values for docking corner are "topLeft", "topRight", bottomLeft", and "bottomRight". Possible values for docking area are "left", "right", "top", and "bottom".
dockStation(ds)	boolean
When set this flag specifies that this window can contain other docked sub-windows.
dockingLayout(dl)	string
When queried this flag will return a string holding the docking layout information. This string can be set when creating or editing a docking station to restore the previous docking layout. This string is a hexadecimal representation of a binary string and is not meant to be humanly readable, but can be saved and loaded using the optionVar command to restore layouts across sessions of Maya.
exists(ex)	boolean
Returns whether the specified object exists or not. Other flags are ignored.
frontWindow(fw)	boolean
Return the name of the front window. Note: you must supply the name of any window (the window does not need to exist). Returns "unknown" if the front window cannot be determined.
height(h)	int
Height of the window excluding any window frame in pixels.
iconName(iconName)	string
The window's icon title. By default it is the same as the window's title.
iconify(i)	boolean
Icon state of the window.
interactivePlacement(ip)	boolean
Deprecated flag. Recognized but not implemented. This flag will be removed in a future version of Maya.
leftEdge(le)	int
Position of the left edge of the window.
mainMenuBar(mm)	boolean
If this flag is used then the main menu bar will be enabled.
mainWindow(mw)	boolean
Main window for the application. The main window has an 'Exit' item in the Window Manager menu. By default, the first created window becomes the main window.
maximizeButton(mxb)	boolean
Turns the window's maximize button on or off.
menuArray(ma)	boolean
Return a string array containing the names of the menus in the window's menu bar.
menuBar(mb)	boolean
Adds an empty menu bar to the window. The Qt name of the object will be m_menubar_nameOfTheWindow.
menuBarCornerWidget(mcw)	[string, string]
This flag specifies a widget to add to a corner of the parent window. The first argument corresponds to the widget name and the second to the position of the widget. Possible values for widget position are "topLeft", "topRight", "bottomLeft", "bottomRight". In query mode this flag returns all the corner widget names in the following order: topLeft, topRight, bottomLeft, bottomRight. Add the -mbr/-menuBarResize flag to the changeCommand of widget passed (first argument) so that it will always have an appropriate size.
menuBarResize(mbr)	boolean
This flag should be used with the -mcw/-menuBarCornerWidget flag. This is used to resize the menu bar so that the corner widgets are updated.
menuBarVisible(mbv)	boolean
Visibility of the menu bar (if there is one).
menuIndex(mi)	[string, uint]
Sets the index of a specified menu.
minimizeButton(mnb)	boolean
Turns the window's minimize button on or off.
minimizeCommand(mnc)	script
Script executed after the window is minimized (iconified).
nestedDockingEnabled(nde)	boolean
Controls whether nested docking is enabled or not. Nested docking allows for docking windows next to other docked windows for more possible arrangement styles.
numberOfMenus(nm)	boolean
Return the number of menus attached to the window's menu bar.
parent(p)	string
Specifies a parent window or layout which the created window is always on top of. Note: If the parent is a window the created window is not modal, so events are still propagated to the parent window.
resizeToFitChildren(rtf)	boolean
The window will always grow/shrink to just fit the controls it contains.
restoreCommand(rc)	script
Script executed after the window is restored from it's minimized (iconified) state.
retain(ret)	boolean
Retains the window after it has been closed. The default is to delete the window when it is closed.
sizeable(s)	boolean
Whether or not the window may be interactively resized.
state(st)	string
When queried this flag will return a string holding the window state information. This string is a hexadecimal representation of a binary string and is not meant to be humanly readable, but can be saved and loaded using the optionVar command to restore window state across sessions of Maya.
title(t)	string
The window's title.
titleBar(tb)	boolean
Turns the window's title bar on or off.
titleBarMenu(tbm)	boolean
Controls whether the title bar menu exists in the window title bar. Only valid if -tb/titleBar is true. This Windows only flag is true by default.
toolbox(tlb)	boolean
Makes this a toolbox style window. A Windows only flag that makes the title bar smaller and uses a slightly different display style.
topEdge(te)	int
Position of the top edge of the window.
topLeftCorner(tlc)	[int, int]
Position of the window's top left corner.
useTemplate(ut)	string
Forces the command to use a command template other than the current one.
visible(vis)	boolean
The window's visibility.
width(w)	int
Width of the window excluding any window frame in pixels.
widthHeight(wh)	[int, int]
Window's width and height excluding any window frame in pixels.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Make a new window
#
window = cmds.window( title="Long Name", iconName='Short Name', widthHeight=(200, 55) )
cmds.columnLayout( adjustableColumn=True )
cmds.button( label='Do Nothing' )
cmds.button( label='Close', command=('cmds.deleteUI(\"' + window + '\", window=True)') )
cmds.setParent( '..' )
cmds.showWindow( window )

# Resize the main window
#

# This is a workaround to get MEL global variable value in Python
gMainWindow = maya.mel.eval('$tmpVar=$gMainWindow')
cmds.window( gMainWindow, edit=True, widthHeight=(900, 777) )

# Add a menu to the right of the main window's menu bar.
#
import maya.cmds as cmds;

cmds.setParent ( "" )
menuName = "menuTest"
cmds.optionMenu( menuName, label='test menu')
cmds.menuItem( label='item 1', parent = menuName )
cmds.menuItem( label='item 2', parent = menuName )
cmds.menuItem( label='item 3', parent = menuName )

cmds.window ("MayaWindow", edit=True, menuBarCornerWidget = (menuName, "topRight") )