Window(bpy_struct)

base class — bpy_struct

class bpy.types.Window(bpy_struct)

Open window

height

Window height

Type

int in [0, 32767], default 0, (readonly)

parent

Active workspace and scene follow this window

Type

Window, (readonly)

scene

Active scene to be edited in the window

Type

Scene, (never None)

screen

Active workspace screen showing in the window

Type

Screen, (never None)

stereo_3d_display

Settings for stereo 3D display

Type

Stereo3dDisplay, (readonly, never None)

view_layer

The active workspace view layer showing in the window

Type

ViewLayer, (never None)

width

Window width

Type

int in [0, 32767], default 0, (readonly)

workspace

Active workspace showing in the window

Type

WorkSpace, (never None)

x

Horizontal location of the window

Type

int in [-32768, 32767], default 0, (readonly)

y

Vertical location of the window

Type

int in [-32768, 32767], default 0, (readonly)

cursor_warp(x, y)

Set the cursor position

cursor_set(cursor)

Set the cursor

Parameters

cursor (enum in ['DEFAULT', 'NONE', 'WAIT', 'CROSSHAIR', 'MOVE_X', 'MOVE_Y', 'KNIFE', 'TEXT', 'PAINT_BRUSH', 'PAINT_CROSS', 'DOT', 'ERASER', 'HAND', 'SCROLL_X', 'SCROLL_Y', 'SCROLL_XY', 'EYEDROPPER', 'PICK_AREA', 'STOP', 'COPY', 'CROSS', 'MUTE', 'ZOOM_IN', 'ZOOM_OUT']) – cursor

cursor_modal_set(cursor)

Restore the previous cursor after calling cursor_modal_set

Parameters

cursor (enum in ['DEFAULT', 'NONE', 'WAIT', 'CROSSHAIR', 'MOVE_X', 'MOVE_Y', 'KNIFE', 'TEXT', 'PAINT_BRUSH', 'PAINT_CROSS', 'DOT', 'ERASER', 'HAND', 'SCROLL_X', 'SCROLL_Y', 'SCROLL_XY', 'EYEDROPPER', 'PICK_AREA', 'STOP', 'COPY', 'CROSS', 'MUTE', 'ZOOM_IN', 'ZOOM_OUT']) – cursor

cursor_modal_restore()

cursor_modal_restore

event_simulate(type, value, unicode='', x=0, y=0, shift=False, ctrl=False, alt=False, oskey=False)

event_simulate

Parameters

• type (enum in ['NONE', 'LEFTMOUSE', 'MIDDLEMOUSE', 'RIGHTMOUSE', 'BUTTON4MOUSE', 'BUTTON5MOUSE', 'BUTTON6MOUSE', 'BUTTON7MOUSE', 'PEN', 'ERASER', 'MOUSEMOVE', 'INBETWEEN_MOUSEMOVE', 'TRACKPADPAN', 'TRACKPADZOOM', 'MOUSEROTATE', 'MOUSESMARTZOOM', 'WHEELUPMOUSE', 'WHEELDOWNMOUSE', 'WHEELINMOUSE', 'WHEELOUTMOUSE', 'EVT_TWEAK_L', 'EVT_TWEAK_M', 'EVT_TWEAK_R', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'ZERO', 'ONE', 'TWO', 'THREE', 'FOUR', 'FIVE', 'SIX', 'SEVEN', 'EIGHT', 'NINE', 'LEFT_CTRL', 'LEFT_ALT', 'LEFT_SHIFT', 'RIGHT_ALT', 'RIGHT_CTRL', 'RIGHT_SHIFT', 'OSKEY', 'APP', 'GRLESS', 'ESC', 'TAB', 'RET', 'SPACE', 'LINE_FEED', 'BACK_SPACE', 'DEL', 'SEMI_COLON', 'PERIOD', 'COMMA', 'QUOTE', 'ACCENT_GRAVE', 'MINUS', 'PLUS', 'SLASH', 'BACK_SLASH', 'EQUAL', 'LEFT_BRACKET', 'RIGHT_BRACKET', 'LEFT_ARROW', 'DOWN_ARROW', 'RIGHT_ARROW', 'UP_ARROW', 'NUMPAD_2', 'NUMPAD_4', 'NUMPAD_6', 'NUMPAD_8', 'NUMPAD_1', 'NUMPAD_3', 'NUMPAD_5', 'NUMPAD_7', 'NUMPAD_9', 'NUMPAD_PERIOD', 'NUMPAD_SLASH', 'NUMPAD_ASTERIX', 'NUMPAD_0', 'NUMPAD_MINUS', 'NUMPAD_ENTER', 'NUMPAD_PLUS', 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12', 'F13', 'F14', 'F15', 'F16', 'F17', 'F18', 'F19', 'F20', 'F21', 'F22', 'F23', 'F24', 'PAUSE', 'INSERT', 'HOME', 'PAGE_UP', 'PAGE_DOWN', 'END', 'MEDIA_PLAY', 'MEDIA_STOP', 'MEDIA_FIRST', 'MEDIA_LAST', 'TEXTINPUT', 'WINDOW_DEACTIVATE', 'TIMER', 'TIMER0', 'TIMER1', 'TIMER2', 'TIMER_JOBS', 'TIMER_AUTOSAVE', 'TIMER_REPORT', 'TIMERREGION', 'NDOF_MOTION', 'NDOF_BUTTON_MENU', 'NDOF_BUTTON_FIT', 'NDOF_BUTTON_TOP', 'NDOF_BUTTON_BOTTOM', 'NDOF_BUTTON_LEFT', 'NDOF_BUTTON_RIGHT', 'NDOF_BUTTON_FRONT', 'NDOF_BUTTON_BACK', 'NDOF_BUTTON_ISO1', 'NDOF_BUTTON_ISO2', 'NDOF_BUTTON_ROLL_CW', 'NDOF_BUTTON_ROLL_CCW', 'NDOF_BUTTON_SPIN_CW', 'NDOF_BUTTON_SPIN_CCW', 'NDOF_BUTTON_TILT_CW', 'NDOF_BUTTON_TILT_CCW', 'NDOF_BUTTON_ROTATE', 'NDOF_BUTTON_PANZOOM', 'NDOF_BUTTON_DOMINANT', 'NDOF_BUTTON_PLUS', 'NDOF_BUTTON_MINUS', 'NDOF_BUTTON_ESC', 'NDOF_BUTTON_ALT', 'NDOF_BUTTON_SHIFT', 'NDOF_BUTTON_CTRL', 'NDOF_BUTTON_1', 'NDOF_BUTTON_2', 'NDOF_BUTTON_3', 'NDOF_BUTTON_4', 'NDOF_BUTTON_5', 'NDOF_BUTTON_6', 'NDOF_BUTTON_7', 'NDOF_BUTTON_8', 'NDOF_BUTTON_9', 'NDOF_BUTTON_10', 'NDOF_BUTTON_A', 'NDOF_BUTTON_B', 'NDOF_BUTTON_C', 'ACTIONZONE_AREA', 'ACTIONZONE_REGION', 'ACTIONZONE_FULLSCREEN', 'XR_ACTION']) –

  Type

  • NONE Undocumented.

  • LEFTMOUSE Left Mouse – LMB.

  • MIDDLEMOUSE Middle Mouse – MMB.

  • RIGHTMOUSE Right Mouse – RMB.

  • BUTTON4MOUSE Button4 Mouse – MB4.

  • BUTTON5MOUSE Button5 Mouse – MB5.

  • BUTTON6MOUSE Button6 Mouse – MB6.

  • BUTTON7MOUSE Button7 Mouse – MB7.

  • PEN Pen.

  • ERASER Eraser.

  • MOUSEMOVE Mouse Move – MsMov.

  • INBETWEEN_MOUSEMOVE In-between Move – MsSubMov.

  • TRACKPADPAN Mouse/Trackpad Pan – MsPan.

  • TRACKPADZOOM Mouse/Trackpad Zoom – MsZoom.

  • MOUSEROTATE Mouse/Trackpad Rotate – MsRot.

  • MOUSESMARTZOOM Mouse/Trackpad Smart Zoom – MsSmartZoom.

  • WHEELUPMOUSE Wheel Up – WhUp.

  • WHEELDOWNMOUSE Wheel Down – WhDown.

  • WHEELINMOUSE Wheel In – WhIn.

  • WHEELOUTMOUSE Wheel Out – WhOut.

  • EVT_TWEAK_L Tweak Left – TwkL.

  • EVT_TWEAK_M Tweak Middle – TwkM.

  • EVT_TWEAK_R Tweak Right – TwkR.

  • A A.

  • B B.

  • C C.

  • D D.

  • E E.

  • F F.

  • G G.

  • H H.

  • I I.

  • J J.

  • K K.

  • L L.

  • M M.

  • N N.

  • O O.

  • P P.

  • Q Q.

  • R R.

  • S S.

  • T T.

  • U U.

  • V V.

  • W W.

  • X X.

  • Y Y.

  • Z Z.

  • ZERO 0.

  • ONE 1.

  • TWO 2.

  • THREE 3.

  • FOUR 4.

  • FIVE 5.

  • SIX 6.

  • SEVEN 7.

  • EIGHT 8.

  • NINE 9.

  • LEFT_CTRL Left Ctrl – CtrlL.

  • LEFT_ALT Left Alt – AltL.

  • LEFT_SHIFT Left Shift – ShiftL.

  • RIGHT_ALT Right Alt – AltR.

  • RIGHT_CTRL Right Ctrl – CtrlR.

  • RIGHT_SHIFT Right Shift – ShiftR.

  • OSKEY OS Key – Cmd.

  • APP Application – App.

  • GRLESS Grless.

  • ESC Esc.

  • TAB Tab.

  • RET Return – Enter.

  • SPACE Spacebar – Space.

  • LINE_FEED Line Feed.

  • BACK_SPACE Backspace – BkSpace.

  • DEL Delete – Del.

  • SEMI_COLON ;.

  • PERIOD ..

  • COMMA ,.

  • QUOTE “.

  • ACCENT_GRAVE `.

  • MINUS -.

  • PLUS +.

  • SLASH /.

  • BACK_SLASH \.

  • EQUAL =.

  • LEFT_BRACKET [.

  • RIGHT_BRACKET ].

  • LEFT_ARROW Left Arrow – ←.

  • DOWN_ARROW Down Arrow – ↓.

  • RIGHT_ARROW Right Arrow – →.

  • UP_ARROW Up Arrow – ↑.

  • NUMPAD_2 Numpad 2 – Pad2.

  • NUMPAD_4 Numpad 4 – Pad4.

  • NUMPAD_6 Numpad 6 – Pad6.

  • NUMPAD_8 Numpad 8 – Pad8.

  • NUMPAD_1 Numpad 1 – Pad1.

  • NUMPAD_3 Numpad 3 – Pad3.

  • NUMPAD_5 Numpad 5 – Pad5.

  • NUMPAD_7 Numpad 7 – Pad7.

  • NUMPAD_9 Numpad 9 – Pad9.

  • NUMPAD_PERIOD Numpad . – Pad..

  • NUMPAD_SLASH Numpad / – Pad/.

  • NUMPAD_ASTERIX Numpad * – Pad*.

  • NUMPAD_0 Numpad 0 – Pad0.

  • NUMPAD_MINUS Numpad - – Pad-.

  • NUMPAD_ENTER Numpad Enter – PadEnter.

  • NUMPAD_PLUS Numpad + – Pad+.

  • F1 F1.

  • F2 F2.

  • F3 F3.

  • F4 F4.

  • F5 F5.

  • F6 F6.

  • F7 F7.

  • F8 F8.

  • F9 F9.

  • F10 F10.

  • F11 F11.

  • F12 F12.

  • F13 F13.

  • F14 F14.

  • F15 F15.

  • F16 F16.

  • F17 F17.

  • F18 F18.

  • F19 F19.

  • F20 F20.

  • F21 F21.

  • F22 F22.

  • F23 F23.

  • F24 F24.

  • PAUSE Pause.

  • INSERT Insert – Ins.

  • HOME Home.

  • PAGE_UP Page Up – PgUp.

  • PAGE_DOWN Page Down – PgDown.

  • END End.

  • MEDIA_PLAY Media Play/Pause – >/||.

  • MEDIA_STOP Media Stop – Stop.

  • MEDIA_FIRST Media First – |<<.

  • MEDIA_LAST Media Last – >>|.

  • TEXTINPUT Text Input – TxtIn.

  • WINDOW_DEACTIVATE Window Deactivate.

  • TIMER Timer – Tmr.

  • TIMER0 Timer 0 – Tmr0.

  • TIMER1 Timer 1 – Tmr1.

  • TIMER2 Timer 2 – Tmr2.

  • TIMER_JOBS Timer Jobs – TmrJob.

  • TIMER_AUTOSAVE Timer Autosave – TmrSave.

  • TIMER_REPORT Timer Report – TmrReport.

  • TIMERREGION Timer Region – TmrReg.

  • NDOF_MOTION NDOF Motion – NdofMov.

  • NDOF_BUTTON_MENU NDOF Menu – NdofMenu.

  • NDOF_BUTTON_FIT NDOF Fit – NdofFit.

  • NDOF_BUTTON_TOP NDOF Top – Ndof↑.

  • NDOF_BUTTON_BOTTOM NDOF Bottom – Ndof↓.

  • NDOF_BUTTON_LEFT NDOF Left – Ndof←.

  • NDOF_BUTTON_RIGHT NDOF Right – Ndof→.

  • NDOF_BUTTON_FRONT NDOF Front – NdofFront.

  • NDOF_BUTTON_BACK NDOF Back – NdofBack.

  • NDOF_BUTTON_ISO1 NDOF Isometric 1 – NdofIso1.

  • NDOF_BUTTON_ISO2 NDOF Isometric 2 – NdofIso2.

  • NDOF_BUTTON_ROLL_CW NDOF Roll CW – NdofRCW.

  • NDOF_BUTTON_ROLL_CCW NDOF Roll CCW – NdofRCCW.

  • NDOF_BUTTON_SPIN_CW NDOF Spin CW – NdofSCW.

  • NDOF_BUTTON_SPIN_CCW NDOF Spin CCW – NdofSCCW.

  • NDOF_BUTTON_TILT_CW NDOF Tilt CW – NdofTCW.

  • NDOF_BUTTON_TILT_CCW NDOF Tilt CCW – NdofTCCW.

  • NDOF_BUTTON_ROTATE NDOF Rotate – NdofRot.

  • NDOF_BUTTON_PANZOOM NDOF Pan/Zoom – NdofPanZoom.

  • NDOF_BUTTON_DOMINANT NDOF Dominant – NdofDom.

  • NDOF_BUTTON_PLUS NDOF Plus – Ndof+.

  • NDOF_BUTTON_MINUS NDOF Minus – Ndof-.

  • NDOF_BUTTON_ESC NDOF Esc – NdofEsc.

  • NDOF_BUTTON_ALT NDOF Alt – NdofAlt.

  • NDOF_BUTTON_SHIFT NDOF Shift – NdofShift.

  • NDOF_BUTTON_CTRL NDOF Ctrl – NdofCtrl.

  • NDOF_BUTTON_1 NDOF Button 1 – NdofB1.

  • NDOF_BUTTON_2 NDOF Button 2 – NdofB2.

  • NDOF_BUTTON_3 NDOF Button 3 – NdofB3.

  • NDOF_BUTTON_4 NDOF Button 4 – NdofB4.

  • NDOF_BUTTON_5 NDOF Button 5 – NdofB5.

  • NDOF_BUTTON_6 NDOF Button 6 – NdofB6.

  • NDOF_BUTTON_7 NDOF Button 7 – NdofB7.

  • NDOF_BUTTON_8 NDOF Button 8 – NdofB8.

  • NDOF_BUTTON_9 NDOF Button 9 – NdofB9.

  • NDOF_BUTTON_10 NDOF Button 10 – NdofB10.

  • NDOF_BUTTON_A NDOF Button A – NdofBA.

  • NDOF_BUTTON_B NDOF Button B – NdofBB.

  • NDOF_BUTTON_C NDOF Button C – NdofBC.

  • ACTIONZONE_AREA ActionZone Area – AZone Area.

  • ACTIONZONE_REGION ActionZone Region – AZone Region.

  • ACTIONZONE_FULLSCREEN ActionZone Fullscreen – AZone FullScr.

  • XR_ACTION XR Action.

• value (enum in ['ANY', 'PRESS', 'RELEASE', 'CLICK', 'DOUBLE_CLICK', 'CLICK_DRAG', 'NORTH', 'NORTH_EAST', 'EAST', 'SOUTH_EAST', 'SOUTH', 'SOUTH_WEST', 'WEST', 'NORTH_WEST', 'NOTHING']) – Value

• shift (boolean, (optional)) – Shift

• ctrl (boolean, (optional)) – Ctrl

• alt (boolean, (optional)) – Alt

• oskey (boolean, (optional)) – OS Key

Returns

Item, Added key map item

Return type

Event

classmethod bl_rna_get_subclass(id, default=None)

Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)

Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.type_recast bpy_struct.values

References

Context.window Window.parent

WindowManager.event_timer_add WindowManager.windows