blender::bke::WindowManagerRuntime Struct Reference

#include <BKE_wm_runtime.hh>

Public Member Functions
	WindowManagerRuntime ()
	~WindowManagerRuntime ()

Public Attributes
wmWindow *	windrawable = nullptr
wmWindow *	winactive = nullptr
bool	is_interface_locked = false
ReportList	reports
ListBase	notifier_queue = {nullptr, nullptr}
GSet *	notifier_queue_set = nullptr
const wmNotifier *	notifier_current = nullptr
ListBase	operators = {nullptr, nullptr}
ListBase	paintcursors = {nullptr, nullptr}
ListBase	keyconfigs = {nullptr, nullptr}
ListBase	timers = {nullptr, nullptr}
ListBase	jobs = {nullptr, nullptr}
ListBase	drags = {nullptr, nullptr}
wmKeyConfig *	defaultconf = nullptr
wmKeyConfig *	addonconf = nullptr
wmKeyConfig *	userconf = nullptr
UndoStack *	undo_stack = nullptr
wmMsgBus *	message_bus = nullptr

Detailed Description

Definition at line 26 of file BKE_wm_runtime.hh.

Constructor & Destructor Documentation

WindowManagerRuntime()

blender::bke::WindowManagerRuntime::WindowManagerRuntime

(

)

Definition at line 22 of file wm_runtime.cc.

References BKE_reports_init(), reports, and RPT_STORE.

~WindowManagerRuntime()

blender::bke::WindowManagerRuntime::~WindowManagerRuntime

(

)

Definition at line 27 of file wm_runtime.cc.

References BKE_reports_free(), BKE_undosys_stack_destroy(), BLI_freelistN(), BLI_gset_free(), BLI_pophead(), drags, keyconfigs, MEM_freeN(), message_bus, notifier_queue, notifier_queue_set, operators, paintcursors, reports, timer, timers, undo_stack, WM_drag_free_list(), WM_event_timer_free_data(), WM_keyconfig_free(), WM_msgbus_destroy(), and WM_operator_free().

Member Data Documentation

addonconf

wmKeyConfig* blender::bke::WindowManagerRuntime::addonconf = nullptr

Addon configuration.

Definition at line 84 of file BKE_wm_runtime.hh.

defaultconf

wmKeyConfig* blender::bke::WindowManagerRuntime::defaultconf = nullptr

Default configuration.

Definition at line 81 of file BKE_wm_runtime.hh.

drags

ListBase blender::bke::WindowManagerRuntime::drags = {nullptr, nullptr}

Active dragged items.

Definition at line 78 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

is_interface_locked

bool blender::bke::WindowManagerRuntime::is_interface_locked = false

Indicates whether interface is locked for user interaction.

Definition at line 38 of file BKE_wm_runtime.hh.

jobs

ListBase blender::bke::WindowManagerRuntime::jobs = {nullptr, nullptr}

Threaded jobs manager.

Definition at line 75 of file BKE_wm_runtime.hh.

keyconfigs

ListBase blender::bke::WindowManagerRuntime::keyconfigs = {nullptr, nullptr}

Known key configurations. This includes all the wmKeyConfig members (defaultconf, addonconf, etc).

Definition at line 69 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

message_bus

wmMsgBus* blender::bke::WindowManagerRuntime::message_bus = nullptr

Definition at line 92 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

notifier_current

const wmNotifier* blender::bke::WindowManagerRuntime::notifier_current = nullptr

The current notifier in the notifier_queue being handled (clear instead of freeing).

Definition at line 57 of file BKE_wm_runtime.hh.

notifier_queue

ListBase blender::bke::WindowManagerRuntime::notifier_queue = {nullptr, nullptr}

Refresh/redraw wmNotifier structs.

Note

Once in the queue, notifiers should be considered read-only. With the exception of clearing notifiers for data which has been removed, see: NOTE_CATEGORY_TAG_CLEARED.

Definition at line 49 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

notifier_queue_set

GSet* blender::bke::WindowManagerRuntime::notifier_queue_set = nullptr

For duplicate detection.

Note

keep in sync with notifier_queue adding/removing elements must also update this set.

Definition at line 54 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

operators

ListBase blender::bke::WindowManagerRuntime::operators = {nullptr, nullptr}

Operator registry.

Definition at line 60 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

paintcursors

ListBase blender::bke::WindowManagerRuntime::paintcursors = {nullptr, nullptr}

Extra overlay cursors to draw, like circles.

Definition at line 63 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

reports

ReportList blender::bke::WindowManagerRuntime::reports

Information and error reports.

Definition at line 41 of file BKE_wm_runtime.hh.

Referenced by WindowManagerRuntime(), and ~WindowManagerRuntime().

timers

ListBase blender::bke::WindowManagerRuntime::timers = {nullptr, nullptr}

Active timers.

Definition at line 72 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

undo_stack

UndoStack* blender::bke::WindowManagerRuntime::undo_stack = nullptr

All undo history.

Definition at line 90 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

userconf

wmKeyConfig* blender::bke::WindowManagerRuntime::userconf = nullptr

User configuration.

Definition at line 87 of file BKE_wm_runtime.hh.

winactive

wmWindow* blender::bke::WindowManagerRuntime::winactive = nullptr

Note

CTX_wm_window(C) is usually preferred. Avoid relying on this where possible as this may become NULL during when handling events that close or replace windows (e.g. opening a file). While this happens rarely in practice, it can cause difficult to reproduce bugs.

Definition at line 35 of file BKE_wm_runtime.hh.

windrawable

wmWindow* blender::bke::WindowManagerRuntime::windrawable = nullptr

Separate active from drawable.

Definition at line 28 of file BKE_wm_runtime.hh.

---

The documentation for this struct was generated from the following files:

• BKE_wm_runtime.hh
• wm_runtime.cc