Blender V5.0
wmDragActiveDropState Struct Reference

#include <WM_types.hh>

Public Member Functions

 wmDragActiveDropState ()
 ~wmDragActiveDropState ()

Public Attributes

wmDropBoxactive_dropbox
ScrAreaarea_from
ARegionregion_from
std::unique_ptr< bContextStoreui_context
const char * disabled_info
bool free_disabled_info
std::string tooltip

Detailed Description

Definition at line 1289 of file WM_types.hh.

Constructor & Destructor Documentation

◆ wmDragActiveDropState()

wmDragActiveDropState::wmDragActiveDropState ( )
default

◆ ~wmDragActiveDropState()

wmDragActiveDropState::~wmDragActiveDropState ( )
default

Member Data Documentation

◆ active_dropbox

wmDropBox* wmDragActiveDropState::active_dropbox

Informs which dropbox is activated with the drag item. When this value changes, the #on_enter() and #on_exit() dropbox callbacks are triggered.

Definition at line 1297 of file WM_types.hh.

Referenced by view3d_geometry_nodes_drop_poll(), WM_drag_free(), wm_drags_check_ops(), wm_drags_draw(), and wm_drop_update_active().

◆ area_from

ScrArea* wmDragActiveDropState::area_from

If active_dropbox is set, the area it successfully polled in. To restore the context of it as needed.

Definition at line 1303 of file WM_types.hh.

Referenced by wm_drags_draw(), and wm_drop_update_active().

◆ disabled_info

const char* wmDragActiveDropState::disabled_info

Text to show when a dropbox poll succeeds (so the dropbox itself is available) but the operator poll fails. Typically the message the operator set with CTX_wm_operator_poll_msg_set().

Definition at line 1321 of file WM_types.hh.

Referenced by dropbox_active(), ui_view_drop_poll(), wm_drag_draw_tooltip(), and WM_drag_free().

◆ free_disabled_info

bool wmDragActiveDropState::free_disabled_info

Definition at line 1322 of file WM_types.hh.

Referenced by dropbox_active(), ui_view_drop_poll(), and WM_drag_free().

◆ region_from

ARegion* wmDragActiveDropState::region_from

If active_dropbox is set, the region it successfully polled in. To restore the context of it as needed.

Definition at line 1308 of file WM_types.hh.

Referenced by wm_drags_draw(), and wm_drop_update_active().

◆ tooltip

std::string wmDragActiveDropState::tooltip

Definition at line 1324 of file WM_types.hh.

Referenced by dropbox_active(), wm_drag_draw_tooltip(), and wm_drop_update_active().

◆ ui_context

std::unique_ptr<bContextStore> wmDragActiveDropState::ui_context

If active_dropbox is set, additional context provided by the active (i.e. hovered) button. Activated before context sensitive operations (polling, drawing, dropping).

Definition at line 1314 of file WM_types.hh.

Referenced by dropbox_active(), WM_drag_free(), wm_drags_draw(), wm_drop_prepare(), wm_drop_update_active(), and wm_dropbox_invoke().


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