Go to: Synopsis. Return value. Flags. Python examples.
windowPref( string , [enableAll=boolean], [exists=boolean], [height=int], [leftEdge=int], [loadAll=boolean], [parentMain=boolean], [remove=boolean], [removeAll=boolean], [restoreMainWindowState=string],
[saveAll=boolean], [saveMainWindowState=string],
[topEdge=int], [topLeftCorner=[int, int]],
[width=int], [widthHeight=[int, int]])
Note: Strings representing object names and
arguments must be separated by commas. This is not depicted in the
synopsis.
windowPref is undoable, queryable, and editable.
Create or modify preferred window attributes. The size and position
of a window is retained during and between application sessions. A
default window preference is created when a window is closed.
Window preferences must be named and, consequently, only affect the
window with a matching name. Note that window preferences are not
applied to the main Maya window nor the Command window.
None
In query mode, return type is based on queried flag.
enableAll, exists, height,
leftEdge, loadAll, parentMain, remove,
removeAll, restoreMainWindowState, saveAll, saveMainWindowState, topEdge, topLeftCorner, width, widthHeight
Long name (short name) |
Argument types |
Properties |
exists(ex) |
boolean |
|
|
Returns true|false depending upon whether the specified object
exists. Other flags are ignored. |
|
topEdge(te) |
int |
|
|
Top edge position of the window. |
|
leftEdge(le) |
int |
|
|
Left edge position of the window. |
|
topLeftCorner(tlc) |
[int, int] |
|
|
Top and left edge position of the window. |
|
width(w) |
int |
|
|
height(h) |
int |
|
|
widthHeight(wh) |
[int, int] |
|
|
Width and height of the window. |
|
parentMain(pm) |
boolean |
|
|
Set whether window is parented to main application window.
Windows only. |
|
enableAll(ea) |
boolean |
|
|
Enable/disable all window preferences. Preferences are enabled
by default. Set this flag to false and window's will ignore all
preference values. |
|
remove(r) |
boolean |
|
|
Remove a window preference. |
|
removeAll(ra) |
boolean |
|
|
Remove all window preferences. |
|
saveAll(sa) |
boolean |
|
|
Writes out file with window attributes. |
|
loadAll(la) |
boolean |
|
|
Reads in file with window attributes from disk. |
|
saveMainWindowState(sms) |
string |
|
|
Writes out file with main window state (positions of toolbars
and dock controls). |
|
restoreMainWindowState(
rms) |
string |
|
|
Reads in file with main window state (positions of toolbars and
dock controls). |
|
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. |
import maya.cmds as cmds
# Check if the window exists.
#
if cmds.window('ExampleWindow', exists=True):
cmds.deleteUI('ExampleWindow', window=True)
# Create a window.
#
cmds.window( 'ExampleWindow' )
cmds.columnLayout()
cmds.text( label='Size and position the window before closing it.' )
cmds.button( label='Close', command='cmds.deleteUI("ExampleWindow", window=True)' )
cmds.showWindow( 'ExampleWindow' )
# When the window is closed a window preference object is
# created for the window. It has the same name as the window
# object.
#
cmds.windowPref( 'ExampleWindow', exists=True )
# Query the window preference size and position.
#
cmds.windowPref( 'ExampleWindow', query=True, topLeftCorner=True )
cmds.windowPref( 'ExampleWindow', query=True, widthHeight=True )
# Create a window with the same name. When it is shown
# it will be sized and positioned according to the
# window preference.
#
if cmds.window('ExampleWindow', exists=True):
cmds.deleteUI('ExampleWindow', window=True)
cmds.window( 'ExampleWindow' )
cmds.columnLayout()
cmds.text( label='Size and position the window before closing it.' )
cmds.button( label='Close', command='cmds.deleteUI("ExampleWindow", window=True)' )
cmds.showWindow( 'ExampleWindow' )
# Delete the window preference and the window will have a
# default size and position.
#
cmds.windowPref( 'ExampleWindow', remove=True )
# Create the window one last time.
#
if cmds.window('ExampleWindow', exists=True):
cmds.deleteUI('ExampleWindow', window=True)
cmds.window( 'ExampleWindow' )
cmds.columnLayout()
cmds.text( label='Size and position the window before closing it.' )
cmds.button( label='Close', command='cmds.deleteUI("ExampleWindow", window=True)' )
cmds.showWindow( 'ExampleWindow' )