WindowManager(ID)

base classes — bpy_struct, ID

class bpy.types.WindowManager(ID)

Window manager datablock defining open windows and other user interface data

addon_filter

Filter addons by category

Type :enum in [], default ‘’

Search within the selected filter

Type :string, default “”, (never None)
addon_support

Display support level

  • OFFICIAL Official, Officially supported.
  • COMMUNITY Community, Maintained by community developers.
  • TESTING Testing, Newly contributed scripts (excluded from release builds).
Type :enum set in {‘OFFICIAL’, ‘COMMUNITY’, ‘TESTING’}, default {‘OFFICIAL’, ‘COMMUNITY’}
clipboard
Type :string, default “”, (never None)
keyconfigs

Registered key configurations

Type :KeyConfigurations bpy_prop_collection of KeyConfig, (readonly)
operators

Operator registry

Type :bpy_prop_collection of Operator, (readonly)
windows

Open windows

Type :bpy_prop_collection of Window, (readonly)
classmethod fileselect_add(operator)

Opens a file selector with an operator. The string properties ‘filepath’, ‘filename’, ‘directory’ and a ‘files’ collection are assigned when present in the operator

Parameters:operator (Operator) – Operator to call
classmethod modal_handler_add(operator)

modal_handler_add

Parameters:operator (Operator) – Operator to call
Return type:boolean
event_timer_add(time_step, window=None)

event_timer_add

Parameters:
  • time_step (float in [0, inf]) – Time Step, Interval in seconds between timer events
  • window (Window, (optional)) – Window to attach the timer to or None
Return type:

Timer

event_timer_remove(timer)

event_timer_remove

progress_begin(min, max)

progress_begin

Parameters:
  • min (float in [-inf, inf]) – min
  • max (float in [-inf, inf]) – max
progress_update(value)

progress_update

Parameters:value (float in [-inf, inf]) – value, any value between min and max as set in progress_init()
progress_end()

progress_end

classmethod invoke_props_popup(operator, event)

Operator popup invoke

Parameters:
  • operator (Operator) – Operator to call
  • event (Event) – Event
Returns:

result

  • RUNNING_MODAL Running Modal, Keep the operator running with blender.
  • CANCELLED Cancelled, When no action has been taken, operator exits.
  • FINISHED Finished, When the operator is complete, operator exits.
  • PASS_THROUGH Pass Through, Do nothing and pass the event on.

Return type:

enum set in {‘RUNNING_MODAL’, ‘CANCELLED’, ‘FINISHED’, ‘PASS_THROUGH’}

classmethod invoke_props_dialog(operator, width=300, height=20)

Operator dialog (non-autoexec popup) invoke

Parameters:
  • operator (Operator) – Operator to call
  • width (int in [0, inf], (optional)) – Width of the popup
  • height (int in [0, inf], (optional)) – Height of the popup
Returns:

result

  • RUNNING_MODAL Running Modal, Keep the operator running with blender.
  • CANCELLED Cancelled, When no action has been taken, operator exits.
  • FINISHED Finished, When the operator is complete, operator exits.
  • PASS_THROUGH Pass Through, Do nothing and pass the event on.

Return type:

enum set in {‘RUNNING_MODAL’, ‘CANCELLED’, ‘FINISHED’, ‘PASS_THROUGH’}

classmethod invoke_search_popup(operator)

invoke_search_popup

Parameters:operator (Operator) – Operator to call
classmethod invoke_popup(operator, width=300, height=20)

Operator popup invoke

Parameters:
  • operator (Operator) – Operator to call
  • width (int in [0, inf], (optional)) – Width of the popup
  • height (int in [0, inf], (optional)) – Height of the popup
Returns:

result

  • RUNNING_MODAL Running Modal, Keep the operator running with blender.
  • CANCELLED Cancelled, When no action has been taken, operator exits.
  • FINISHED Finished, When the operator is complete, operator exits.
  • PASS_THROUGH Pass Through, Do nothing and pass the event on.

Return type:

enum set in {‘RUNNING_MODAL’, ‘CANCELLED’, ‘FINISHED’, ‘PASS_THROUGH’}

classmethod invoke_confirm(operator, event)

Operator confirmation

Parameters:
  • operator (Operator) – Operator to call
  • event (Event) – Event
Returns:

result

  • RUNNING_MODAL Running Modal, Keep the operator running with blender.
  • CANCELLED Cancelled, When no action has been taken, operator exits.
  • FINISHED Finished, When the operator is complete, operator exits.
  • PASS_THROUGH Pass Through, Do nothing and pass the event on.

Return type:

enum set in {‘RUNNING_MODAL’, ‘CANCELLED’, ‘FINISHED’, ‘PASS_THROUGH’}

Inherited Properties

Inherited Functions

References

Previous topic

Window(bpy_struct)

Next topic

WipeSequence(EffectSequence)