Blender V5.3
blender::wmDragActiveDropState Struct Reference

#include <WM_types.hh>

Public Member Functions

 wmDragActiveDropState ()
 ~wmDragActiveDropState ()

Public Attributes

wmDropBox * active_dropbox
ScrArea * area_from
ARegion * region_from
std::unique_ptr< bContextStore > ui_context
std::optional< std::string > disabled_info
std::string tooltip

Detailed Description

Definition at line 1383 of file WM_types.hh.

Constructor & Destructor Documentation

◆ wmDragActiveDropState()

blender::wmDragActiveDropState::wmDragActiveDropState ( )
default

◆ ~wmDragActiveDropState()

blender::wmDragActiveDropState::~wmDragActiveDropState ( )
default

Member Data Documentation

◆ active_dropbox

wmDropBox* blender::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 1391 of file WM_types.hh.

Referenced by blender::view3d_geometry_nodes_drop_poll(), blender::WM_drag_free(), blender::wm_dragdrop_free_timer(), blender::wm_drags_draw(), blender::wm_drags_handle_events(), and blender::wm_drop_update_active().

◆ area_from

ScrArea* blender::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 1397 of file WM_types.hh.

Referenced by blender::wm_drags_draw(), and blender::wm_drop_update_active().

◆ disabled_info

std::optional<std::string> blender::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 1415 of file WM_types.hh.

Referenced by blender::dropbox_active(), blender::ui::view_drop_poll(), blender::wm_drag_draw_tooltip(), and blender::wm_dropbox_active().

◆ region_from

ARegion* blender::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 1402 of file WM_types.hh.

Referenced by blender::wm_drags_draw(), blender::wm_drags_handle_events(), and blender::wm_drop_update_active().

◆ tooltip

std::string blender::wmDragActiveDropState::tooltip

◆ ui_context

std::unique_ptr<bContextStore> blender::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 1408 of file WM_types.hh.

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


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