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)

modal_operators

A list of currently running modal operators

Type

bpy_prop_collection of Operator, (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 Window Cursor Items) – cursor

cursor_modal_set(cursor)

Set the cursor, so the previous cursor can be restored

Parameters

cursor (enum in Window Cursor Items) – cursor

cursor_modal_restore()

Restore the previous cursor after calling cursor_modal_set

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

event_simulate

Parameters

  • type (enum in Event Type Items) – Type

  • value (enum in Event Value Items) – Value

  • shift (boolean, (optional)) – Shift

  • ctrl (boolean, (optional)) – Ctrl

  • alt (boolean, (optional)) – Alt

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

  • hyper (boolean, (optional)) – Hyper

Returns

Item, Added key map item

Return type

Event

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters

id (str) – 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 (str) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References