wmDropBox Struct Reference

#include <WM_types.h>

Public Attributes
struct wmDropBox *	next
struct wmDropBox *	prev
bool(*	poll )(struct bContext *, struct wmDrag *, const wmEvent *, const char **)
void(*	copy )(struct wmDrag *, struct wmDropBox *)
void(*	cancel )(struct Main *, struct wmDrag *, struct wmDropBox *)
wmOperatorType *	ot
struct IDProperty *	properties
struct PointerRNA *	ptr
short	opcontext

Detailed Description

Dropboxes are like keymaps, part of the screen/area/region definition. Allocation and free is on startup and exit.

Definition at line 929 of file WM_types.h.

Member Data Documentation

cancel

void(* wmDropBox::cancel) (struct Main *, struct wmDrag *, struct wmDropBox *)

If the operator is cancelled (returns OPERATOR_CANCELLED), this can be used for cleanup of copy() resources.

Definition at line 942 of file WM_types.h.

Referenced by WM_dropbox_add().

copy

void(* wmDropBox::copy) (struct wmDrag *, struct wmDropBox *)

Before exec, this copies drag info to #wmDrop properties.

Definition at line 936 of file WM_types.h.

Referenced by WM_dropbox_add().

next

struct wmDropBox* wmDropBox::next

Definition at line 930 of file WM_types.h.

opcontext

short wmDropBox::opcontext

Default invoke.

Definition at line 956 of file WM_types.h.

Referenced by WM_dropbox_add().

ot

wmOperatorType* wmDropBox::ot

If poll succeeds, operator is called. Not saved in file, so can be pointer.

Definition at line 948 of file WM_types.h.

Referenced by WM_dropbox_add().

poll

bool(* wmDropBox::poll) (struct bContext *, struct wmDrag *, const wmEvent *, const char **)

Test if the dropbox is active, then can print optype name.

Definition at line 933 of file WM_types.h.

Referenced by WM_dropbox_add().

prev

struct wmDropBox * wmDropBox::prev

Definition at line 930 of file WM_types.h.

properties

struct IDProperty* wmDropBox::properties

Operator properties, assigned to ptr->data and can be written to a file.

Definition at line 951 of file WM_types.h.

Referenced by WM_dropbox_add().

ptr

struct PointerRNA* wmDropBox::ptr

RNA pointer to access properties.

Definition at line 953 of file WM_types.h.

Referenced by blend_file_drop_copy(), clip_drop_copy(), filepath_drop_copy(), id_drop_copy(), image_drop_copy(), node_group_drop_copy(), node_id_drop_copy(), node_id_path_drop_copy(), path_drop_copy(), sequencer_drop_copy(), text_drop_copy(), text_drop_paste(), UI_drop_color_copy(), view3d_collection_drop_copy(), view3d_id_drop_copy(), view3d_id_drop_copy_with_type(), view3d_id_path_drop_copy(), view3d_ob_drop_copy(), WM_drag_free_imported_drag_ID(), and WM_dropbox_add().

---

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

• WM_types.h