Merge branch 'master' into blender2.8
[blender.git] / source / blender / windowmanager / WM_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/windowmanager/WM_types.h
28  *  \ingroup wm
29  */
30
31 #ifndef __WM_TYPES_H__
32 #define __WM_TYPES_H__
33
34 /**
35  * Overview of WM structs
36  * ======================
37  *
38  * <pre>
39  * > wmWindowManager    (window manager stores a list of windows)
40  * > > wmWindow         (window has an active screen)
41  * > > > bScreen        (link to ScrAreas via 'areabase')
42  * > > > > ScrArea      (stores multiple spaces via space links via 'spacedata')
43  * > > > > > SpaceLink  (base struct for space data for all different space types)
44  * > > > > ScrArea      (stores multiple regions via 'regionbase')
45  * > > > > > ARegion
46  * </pre>
47  *
48  * Window Layout
49  * =============
50  *
51  * <pre>
52  * wmWindow -> bScreen
53  * +----------------------------------------------------------+
54  * |+-----------------------------------------+-------------+ |
55  * ||ScrArea (links to 3D view)               |ScrArea      | |
56  * ||+-------++----------+-------------------+|(links to    | |
57  * |||ARegion||          |ARegion (quad view)|| properties) | |
58  * |||(tools)||          |                   ||             | |
59  * |||       ||          |                   ||             | |
60  * |||       ||          |                   ||             | |
61  * |||       ||          |                   ||             | |
62  * |||       |+----------+-------------------+|             | |
63  * |||       ||          |                   ||             | |
64  * |||       ||          |                   ||             | |
65  * |||       ||          |                   ||             | |
66  * |||       ||          |                   ||             | |
67  * |||       ||          |                   ||             | |
68  * ||+-------++----------+-------------------+|             | |
69  * |+-----------------------------------------+-------------+ |
70  * +----------------------------------------------------------+
71  * </pre>
72  *
73  * Space Data
74  * ==========
75  *
76  * <pre>
77  * ScrArea's store a list of space data (SpaceLinks), each of unique type.
78  * The first one is the displayed in the UI, others are added as needed.
79  *
80  * +----------------------------+  <-- sa->spacedata.first;
81  * |                            |
82  * |                            |---+  <-- other inactive SpaceLink's stored.
83  * |                            |   |
84  * |                            |   |---+
85  * |                            |   |   |
86  * |                            |   |   |
87  * |                            |   |   |
88  * |                            |   |   |
89  * +----------------------------+   |   |
90  *    |                             |   |
91  *    +-----------------------------+   |
92  *       |                              |
93  *       +------------------------------+
94  * </pre>
95  *
96  * A common way to get the space from the ScrArea:
97  * \code{.c}
98  * if (sa->spacetype == SPACE_VIEW3D) {
99  *     View3D *v3d = sa->spacedata.first;
100  *     ...
101  * }
102  * \endcode
103  */
104
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108
109 struct bContext;
110 struct wmEvent;
111 struct wmWindowManager;
112 struct wmMsgBus;
113 struct wmOperator;
114 struct ID;
115 struct ImBuf;
116
117 #include "RNA_types.h"
118 #include "DNA_listBase.h"
119 #include "DNA_vec_types.h"
120 #include "BLI_compiler_attrs.h"
121
122 /* exported types for WM */
123 #include "wm_cursors.h"
124 #include "wm_event_types.h"
125 #include "gizmo/WM_gizmo_types.h"
126
127 /* Include external gizmo API's */
128 #include "gizmo/WM_gizmo_api.h"
129
130 /* ************** wmOperatorType ************************ */
131
132 /* flag */
133 enum {
134         OPTYPE_REGISTER     = (1 << 0),  /* register operators in stack after finishing */
135         OPTYPE_UNDO         = (1 << 1),  /* do undo push after after */
136         OPTYPE_BLOCKING     = (1 << 2),  /* let blender grab all input from the WM (X11) */
137         OPTYPE_MACRO        = (1 << 3),
138         OPTYPE_GRAB_CURSOR  = (1 << 4),  /* grabs the cursor and optionally enables continuous cursor wrapping */
139         OPTYPE_PRESET       = (1 << 5),  /* show preset menu */
140
141         /* some operators are mainly for internal use
142          * and don't make sense to be accessed from the
143          * search menu, even if poll() returns true.
144          * currently only used for the search toolbox */
145         OPTYPE_INTERNAL     = (1 << 6),
146
147         OPTYPE_LOCK_BYPASS  = (1 << 7),  /* Allow operator to run when interface is locked */
148         OPTYPE_UNDO_GROUPED = (1 << 8),  /* Special type of undo which doesn't store itself multiple times */
149         OPTYPE_USE_EVAL_DATA = (1 << 9),  /* Need evaluated data (i.e. a valid, up-to-date depsgraph for current context) */
150 };
151
152 /* context to call operator in for WM_operator_name_call */
153 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
154 enum {
155         /* if there's invoke, call it, otherwise exec */
156         WM_OP_INVOKE_DEFAULT,
157         WM_OP_INVOKE_REGION_WIN,
158         WM_OP_INVOKE_REGION_CHANNELS,
159         WM_OP_INVOKE_REGION_PREVIEW,
160         WM_OP_INVOKE_AREA,
161         WM_OP_INVOKE_SCREEN,
162         /* only call exec */
163         WM_OP_EXEC_DEFAULT,
164         WM_OP_EXEC_REGION_WIN,
165         WM_OP_EXEC_REGION_CHANNELS,
166         WM_OP_EXEC_REGION_PREVIEW,
167         WM_OP_EXEC_AREA,
168         WM_OP_EXEC_SCREEN
169 };
170
171 /* property tags for RNA_OperatorProperties */
172 typedef enum eOperatorPropTags {
173         OP_PROP_TAG_ADVANCED = (1 << 0),
174 } eOperatorPropTags;
175 #define OP_PROP_TAG_ADVANCED ((eOperatorPropTags)OP_PROP_TAG_ADVANCED)
176
177 /* ************** wmKeyMap ************************ */
178
179 /* modifier */
180 #define KM_SHIFT        1
181 #define KM_CTRL         2
182 #define KM_ALT          4
183 #define KM_OSKEY        8
184         /* means modifier should be pressed 2nd */
185 #define KM_SHIFT2       16
186 #define KM_CTRL2        32
187 #define KM_ALT2         64
188 #define KM_OSKEY2       128
189
190 /* KM_MOD_ flags for wmKeyMapItem and wmEvent.alt/shift/oskey/ctrl  */
191 /* note that KM_ANY and KM_NOTHING are used with these defines too */
192 #define KM_MOD_FIRST  1
193 #define KM_MOD_SECOND 2
194
195 /* type: defined in wm_event_types.c */
196 #define KM_TEXTINPUT    -2
197
198 /* val */
199 #define KM_ANY          -1
200 #define KM_NOTHING      0
201 #define KM_PRESS        1
202 #define KM_RELEASE      2
203 #define KM_CLICK        3
204 #define KM_DBL_CLICK    4
205 #define KM_CLICK_DRAG   5
206
207
208 /* ************** UI Handler ***************** */
209
210 #define WM_UI_HANDLER_CONTINUE  0
211 #define WM_UI_HANDLER_BREAK             1
212
213 /* ************** Notifiers ****************** */
214
215 typedef struct wmNotifier {
216         struct wmNotifier *next, *prev;
217
218         struct wmWindowManager *wm;
219         struct wmWindow *window;
220
221         unsigned int category, data, subtype, action;
222
223         void *reference;
224
225 } wmNotifier;
226
227
228 /* 4 levels
229  *
230  * 0xFF000000; category
231  * 0x00FF0000; data
232  * 0x0000FF00; data subtype (unused?)
233  * 0x000000FF; action
234  */
235
236 /* category */
237 #define NOTE_CATEGORY           0xFF000000
238 #define NC_WM                           (1<<24)
239 #define NC_WINDOW                       (2<<24)
240 #define NC_SCREEN                       (3<<24)
241 #define NC_SCENE                        (4<<24)
242 #define NC_OBJECT                       (5<<24)
243 #define NC_MATERIAL                     (6<<24)
244 #define NC_TEXTURE                      (7<<24)
245 #define NC_LAMP                         (8<<24)
246 #define NC_GROUP                        (9<<24)
247 #define NC_IMAGE                        (10<<24)
248 #define NC_BRUSH                        (11<<24)
249 #define NC_TEXT                         (12<<24)
250 #define NC_WORLD                        (13<<24)
251 #define NC_ANIMATION            (14<<24)
252 #define NC_SPACE                        (15<<24)
253 #define NC_GEOM                         (16<<24)
254 #define NC_NODE                         (17<<24)
255 #define NC_ID                           (18<<24)
256 #define NC_LOGIC                        (19<<24)
257 #define NC_MOVIECLIP                    (20<<24)
258 #define NC_MASK                         (21<<24)
259 #define NC_GPENCIL                      (22<<24)
260 #define NC_LINESTYLE                    (23<<24)
261 #define NC_CAMERA                       (24<<24)
262 #define NC_LIGHTPROBE           (25<<24)
263
264 /* data type, 256 entries is enough, it can overlap */
265 #define NOTE_DATA                       0x00FF0000
266
267         /* NC_WM windowmanager */
268 #define ND_FILEREAD                     (1<<16)
269 #define ND_FILESAVE                     (2<<16)
270 #define ND_DATACHANGED          (3<<16)
271 #define ND_HISTORY                      (4<<16)
272 #define ND_JOB                          (5<<16)
273 #define ND_UNDO                         (6<<16)
274
275         /* NC_SCREEN */
276 #define ND_LAYOUTBROWSE         (1<<16)
277 #define ND_LAYOUTDELETE         (2<<16)
278 #define ND_ANIMPLAY                     (4<<16)
279 #define ND_GPENCIL                      (5<<16)
280 #define ND_EDITOR_CHANGED       (6<<16) /*sent to new editors after switching to them*/
281 #define ND_LAYOUTSET            (7<<16)
282 #define ND_SKETCH                       (8<<16)
283 #define ND_WORKSPACE_SET        (9<<16)
284 #define ND_WORKSPACE_DELETE (10<<16)
285
286         /* NC_SCENE Scene */
287 #define ND_SCENEBROWSE          (1<<16)
288 #define ND_MARKERS                      (2<<16)
289 #define ND_FRAME                        (3<<16)
290 #define ND_RENDER_OPTIONS       (4<<16)
291 #define ND_NODES                        (5<<16)
292 #define ND_SEQUENCER            (6<<16)
293 #define ND_OB_ACTIVE            (7<<16)
294 #define ND_OB_SELECT            (8<<16)
295 #define ND_OB_VISIBLE           (9<<16)
296 #define ND_OB_RENDER            (10<<16)
297 #define ND_MODE                         (11<<16)
298 #define ND_RENDER_RESULT        (12<<16)
299 #define ND_COMPO_RESULT         (13<<16)
300 #define ND_KEYINGSET            (14<<16)
301 #define ND_TOOLSETTINGS         (15<<16)
302 #define ND_LAYER                        (16<<16)
303 #define ND_FRAME_RANGE          (17<<16)
304 #define ND_TRANSFORM_DONE       (18<<16)
305 #define ND_WORLD                        (92<<16)
306 #define ND_LAYER_CONTENT        (101<<16)
307
308         /* NC_OBJECT Object */
309 #define ND_TRANSFORM            (18<<16)
310 #define ND_OB_SHADING           (19<<16)
311 #define ND_POSE                         (20<<16)
312 #define ND_BONE_ACTIVE          (21<<16)
313 #define ND_BONE_SELECT          (22<<16)
314 #define ND_DRAW                         (23<<16)
315 #define ND_MODIFIER                     (24<<16)
316 #define ND_KEYS                         (25<<16)
317 #define ND_CONSTRAINT           (26<<16)
318 #define ND_PARTICLE                     (27<<16)
319 #define ND_POINTCACHE           (28<<16)
320 #define ND_PARENT                       (29<<16)
321 #define ND_LOD                          (30<<16)
322 #define ND_DRAW_RENDER_VIEWPORT (31<<16)  /* for camera & sequencer viewport update, also /w NC_SCENE */
323
324         /* NC_MATERIAL Material */
325 #define ND_SHADING                      (30<<16)
326 #define ND_SHADING_DRAW         (31<<16)
327 #define ND_SHADING_LINKS        (32<<16)
328 #define ND_SHADING_PREVIEW      (33<<16)
329
330         /* NC_LAMP Lamp */
331 #define ND_LIGHTING                     (40<<16)
332 #define ND_LIGHTING_DRAW        (41<<16)
333 #define ND_SKY                          (42<<16)
334
335         /* NC_WORLD World */
336 #define ND_WORLD_DRAW           (45<<16)
337
338         /* NC_TEXT Text */
339 #define ND_CURSOR                       (50<<16)
340 #define ND_DISPLAY                      (51<<16)
341
342         /* NC_ANIMATION Animato */
343 #define ND_KEYFRAME                     (70<<16)
344 #define ND_KEYFRAME_PROP        (71<<16)
345 #define ND_ANIMCHAN                     (72<<16)
346 #define ND_NLA                          (73<<16)
347 #define ND_NLA_ACTCHANGE        (74<<16)
348 #define ND_FCURVES_ORDER        (75<<16)
349
350         /* NC_GPENCIL */
351 #define ND_GPENCIL_EDITMODE     (85<<16)
352
353         /* NC_GEOM Geometry */
354         /* Mesh, Curve, MetaBall, Armature, .. */
355 #define ND_SELECT                       (90<<16)
356 #define ND_DATA                         (91<<16)
357 #define ND_VERTEX_GROUP         (92<<16)
358
359         /* NC_NODE Nodes */
360
361         /* NC_SPACE */
362 #define ND_SPACE_CONSOLE                (1<<16) /* general redraw */
363 #define ND_SPACE_INFO_REPORT    (2<<16) /* update for reports, could specify type */
364 #define ND_SPACE_INFO                   (3<<16)
365 #define ND_SPACE_IMAGE                  (4<<16)
366 #define ND_SPACE_FILE_PARAMS    (5<<16)
367 #define ND_SPACE_FILE_LIST              (6<<16)
368 #define ND_SPACE_NODE                   (7<<16)
369 #define ND_SPACE_OUTLINER               (8<<16)
370 #define ND_SPACE_VIEW3D                 (9<<16)
371 #define ND_SPACE_PROPERTIES             (10<<16)
372 #define ND_SPACE_TEXT                   (11<<16)
373 #define ND_SPACE_TIME                   (12<<16)
374 #define ND_SPACE_GRAPH                  (13<<16)
375 #define ND_SPACE_DOPESHEET              (14<<16)
376 #define ND_SPACE_NLA                    (15<<16)
377 #define ND_SPACE_SEQUENCER              (16<<16)
378 #define ND_SPACE_NODE_VIEW              (17<<16)
379 #define ND_SPACE_CHANGED                (18<<16) /*sent to a new editor type after it's replaced an old one*/
380 #define ND_SPACE_CLIP                   (19<<16)
381 #define ND_SPACE_FILE_PREVIEW   (20<<16)
382
383 /* subtype, 256 entries too */
384 #define NOTE_SUBTYPE            0x0000FF00
385
386 /* subtype scene mode */
387 #define NS_MODE_OBJECT                  (1<<8)
388
389 #define NS_EDITMODE_MESH                (2<<8)
390 #define NS_EDITMODE_CURVE               (3<<8)
391 #define NS_EDITMODE_SURFACE             (4<<8)
392 #define NS_EDITMODE_TEXT                (5<<8)
393 #define NS_EDITMODE_MBALL               (6<<8)
394 #define NS_EDITMODE_LATTICE             (7<<8)
395 #define NS_EDITMODE_ARMATURE    (8<<8)
396 #define NS_MODE_POSE                    (9<<8)
397 #define NS_MODE_PARTICLE                (10<<8)
398
399 /* subtype 3d view editing */
400 #define NS_VIEW3D_GPU                   (16<<8)
401
402 /* action classification */
403 #define NOTE_ACTION                     (0x000000FF)
404 #define NA_EDITED                       1
405 #define NA_EVALUATED            2
406 #define NA_ADDED                        3
407 #define NA_REMOVED                      4
408 #define NA_RENAME                       5
409 #define NA_SELECTED                     6
410 #define NA_PAINTING                     7
411
412 /* ************** Gesture Manager data ************** */
413
414 /* wmGesture->type */
415 #define WM_GESTURE_TWEAK                0
416 #define WM_GESTURE_LINES                1
417 #define WM_GESTURE_RECT                 2
418 #define WM_GESTURE_CROSS_RECT   3
419 #define WM_GESTURE_LASSO                4
420 #define WM_GESTURE_CIRCLE               5
421 #define WM_GESTURE_STRAIGHTLINE 6
422
423 /* wmGesture is registered to window listbase, handled by operator callbacks */
424 /* tweak gesture is builtin feature */
425 typedef struct wmGesture {
426         struct wmGesture *next, *prev;
427         int event_type; /* event->type */
428         int type;               /* gesture type define */
429         rcti winrct;    /* bounds of region to draw gesture within */
430         int points;             /* optional, amount of points stored */
431         int points_alloc;       /* optional, maximum amount of points stored */
432         int modal_state;
433
434         /* For modal operators which may be running idle, waiting for an event to activate the gesture.
435          * Typically this is set when the user is click-dragging the gesture (border and circle select for eg). */
436         uint is_active : 1;
437         /* Use for gestures that support both immediate or delayed activation. */
438         uint wait_for_input : 1;
439
440         void *customdata;
441         /* customdata for border is a recti */
442         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
443         /* customdata for lasso is short array */
444         /* customdata for straight line is a recti: (xmin,ymin) is start, (xmax, ymax) is end */
445
446         /* free pointer to use for operator allocs (if set, its freed on exit)*/
447         void *userdata;
448         bool  userdata_free;
449 } wmGesture;
450
451 /* ************** wmEvent ************************ */
452
453 /* each event should have full modifier state */
454 /* event comes from eventmanager and from keymap */
455 typedef struct wmEvent {
456         struct wmEvent *next, *prev;
457
458         short type;                     /* event code itself (short, is also in keymap) */
459         short val;                      /* press, release, scrollvalue */
460         int x, y;                       /* mouse pointer position, screen coord */
461         int mval[2];            /* region mouse position, name convention pre 2.5 :) */
462         char utf8_buf[6];       /* from, ghost if utf8 is enabled for the platform,
463                                                  * BLI_str_utf8_size() must _always_ be valid, check
464                                                  * when assigning s we don't need to check on every access after */
465         char ascii;                     /* from ghost, fallback if utf8 isn't set */
466         char pad;
467
468         /* previous state, used for double click and the 'click' */
469         short prevtype;
470         short prevval;
471         int prevx, prevy;
472         double prevclicktime;
473         int prevclickx, prevclicky;
474
475         /* modifier states */
476         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
477         short keymodifier;                              /* rawkey modifier */
478
479         /* set in case a KM_PRESS went by unhandled */
480         char check_click;
481         char check_drag;
482         char is_motion_absolute;
483
484         /* keymap item, set by handler (weak?) */
485         const char *keymap_idname;
486
487         /* tablet info, only use when the tablet is active */
488         const struct wmTabletData *tablet_data;
489
490         /* custom data */
491         short custom;           /* custom data type, stylus, 6dof, see wm_event_types.h */
492         short customdatafree;
493         int pad2;
494         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
495
496 } wmEvent;
497
498 /* ************** custom wmEvent data ************** */
499 typedef struct wmTabletData {
500         int Active;                     /* 0=EVT_TABLET_NONE, 1=EVT_TABLET_STYLUS, 2=EVT_TABLET_ERASER */
501         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
502         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
503         float Ytilt;            /* as above */
504 } wmTabletData;
505
506 typedef enum {  /* motion progress, for modal handlers */
507         P_NOT_STARTED,
508         P_STARTING,    /* <-- */
509         P_IN_PROGRESS, /* <-- only these are sent for NDOF motion*/
510         P_FINISHING,   /* <-- */
511         P_FINISHED
512 } wmProgress;
513
514 #ifdef WITH_INPUT_NDOF
515 typedef struct wmNDOFMotionData {
516         /* awfully similar to GHOST_TEventNDOFMotionData... */
517         /* Each component normally ranges from -1 to +1, but can exceed that.
518          * These use blender standard view coordinates, with positive rotations being CCW about the axis. */
519         float tvec[3]; /* translation */
520         float rvec[3]; /* rotation: */
521         /* axis = (rx,ry,rz).normalized */
522         /* amount = (rx,ry,rz).magnitude [in revolutions, 1.0 = 360 deg] */
523         float dt; /* time since previous NDOF Motion event */
524         wmProgress progress; /* is this the first event, the last, or one of many in between? */
525 } wmNDOFMotionData;
526 #endif /* WITH_INPUT_NDOF */
527
528 typedef enum {  /* Timer flags */
529         WM_TIMER_NO_FREE_CUSTOM_DATA  = 1 << 0,  /* Do not attempt to free customdata pointer even if non-NULL. */
530 } wmTimerFlags;
531
532 typedef struct wmTimer {
533         struct wmTimer *next, *prev;
534
535         struct wmWindow *win;   /* window this timer is attached to (optional) */
536
537         double timestep;                /* set by timer user */
538         int event_type;                 /* set by timer user, goes to event system */
539         wmTimerFlags flags;             /* Various flags controlling timer options, see below. */
540         void *customdata;               /* set by timer user, to allow custom values */
541
542         double duration;                /* total running time in seconds */
543         double delta;                   /* time since previous step in seconds */
544
545         double ltime;                   /* internal, last time timer was activated */
546         double ntime;                   /* internal, next time we want to activate the timer */
547         double stime;                   /* internal, when the timer started */
548         bool sleep;                             /* internal, put timers to sleep when needed */
549 } wmTimer;
550
551 typedef struct wmOperatorType {
552         const char *name;               /* text for ui, undo */
553         const char *idname;             /* unique identifier */
554         const char *translation_context;
555         const char *description;        /* tooltips and python docs */
556         const char *undo_group; /* identifier to group operators together */
557
558         /* this callback executes the operator without any interactive input,
559          * parameters may be provided through operator properties. cannot use
560          * any interface code or input device state.
561          * - see defines below for return values */
562         int (*exec)(struct bContext *, struct wmOperator *) ATTR_WARN_UNUSED_RESULT;
563
564         /* this callback executes on a running operator whenever as property
565          * is changed. It can correct its own properties or report errors for
566          * invalid settings in exceptional cases.
567          * Boolean return value, True denotes a change has been made and to redraw */
568         bool (*check)(struct bContext *, struct wmOperator *);
569
570         /* for modal temporary operators, initially invoke is called. then
571          * any further events are handled in modal. if the operation is
572          * canceled due to some external reason, cancel is called
573          * - see defines below for return values */
574         int (*invoke)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
575
576         /* Called when a modal operator is canceled (not used often).
577          * Internal cleanup can be done here if needed. */
578         void (*cancel)(struct bContext *, struct wmOperator *);
579
580         /* Modal is used for operators which continuously run, eg:
581          * fly mode, knife tool, circle select are all examples of modal operators.
582          * Modal operators can handle events which would normally access other operators,
583          * they keep running until they don't return `OPERATOR_RUNNING_MODAL`. */
584         int (*modal)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
585
586         /* verify if the operator can be executed in the current context, note
587          * that the operator might still fail to execute even if this return true */
588         bool (*poll)(struct bContext *) ATTR_WARN_UNUSED_RESULT;
589
590         /* Use to check of properties should be displayed in auto-generated UI.
591          * Use 'check' callback to enforce refreshing. */
592         bool (*poll_property)(
593                 const struct bContext *C, struct wmOperator *op,
594                 const PropertyRNA *prop) ATTR_WARN_UNUSED_RESULT;
595
596         /* optional panel for redo and repeat, autogenerated if not set */
597         void (*ui)(struct bContext *, struct wmOperator *);
598
599         /* rna for properties */
600         struct StructRNA *srna;
601
602         /* previous settings - for initializing on re-use */
603         struct IDProperty *last_properties;
604
605         /* Default rna property to use for generic invoke functions.
606          * menus, enum search... etc. Example: Enum 'type' for a Delete menu */
607         PropertyRNA *prop;
608
609         /* struct wmOperatorTypeMacro */
610         ListBase macro;
611
612         /* pointer to modal keymap, do not free! */
613         struct wmKeyMap *modalkeymap;
614
615         /* python needs the operator type as well */
616         bool (*pyop_poll)(struct bContext *, struct wmOperatorType *ot) ATTR_WARN_UNUSED_RESULT;
617
618         /* RNA integration */
619         ExtensionRNA ext;
620
621         /* Flag last for padding */
622         short flag;
623
624 } wmOperatorType;
625
626 #ifdef WITH_INPUT_IME
627 /* *********** Input Method Editor (IME) *********** */
628
629 /* similar to GHOST_TEventImeData */
630 typedef struct wmIMEData {
631         size_t result_len, composite_len;
632
633         char *str_result;           /* utf8 encoding */
634         char *str_composite;        /* utf8 encoding */
635
636         int cursor_pos;             /* cursor position in the IME composition. */
637         int sel_start;              /* beginning of the selection */
638         int sel_end;                /* end of the selection */
639
640         bool is_ime_composing;
641 } wmIMEData;
642 #endif
643
644 /* **************** Paint Cursor ******************* */
645
646 typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
647
648 /* *************** Drag and drop *************** */
649
650 #define WM_DRAG_ID              0
651 #define WM_DRAG_RNA             1
652 #define WM_DRAG_PATH    2
653 #define WM_DRAG_NAME    3
654 #define WM_DRAG_VALUE   4
655 #define WM_DRAG_COLOR   5
656
657 typedef enum wmDragFlags {
658         WM_DRAG_NOP         = 0,
659         WM_DRAG_FREE_DATA   = 1,
660 } wmDragFlags;
661
662 /* note: structs need not exported? */
663
664 typedef struct wmDragID {
665         struct wmDragID  *next, *prev;
666         struct ID *id;
667         struct ID *from_parent;
668 } wmDragID;
669
670 typedef struct wmDrag {
671         struct wmDrag *next, *prev;
672
673         int icon, type;                                 /* type, see WM_DRAG defines above */
674         void *poin;
675         char path[1024]; /* FILE_MAX */
676         double value;
677
678         struct ImBuf *imb;                                              /* if no icon but imbuf should be drawn around cursor */
679         float scale;
680         int sx, sy;
681
682         char opname[200]; /* if set, draws operator name*/
683         unsigned int flags;
684
685         ListBase ids; /* List of wmDragIDs, all are guaranteed to have the same ID type. */
686 } wmDrag;
687
688 /* dropboxes are like keymaps, part of the screen/area/region definition */
689 /* allocation and free is on startup and exit */
690 typedef struct wmDropBox {
691         struct wmDropBox *next, *prev;
692
693         /* test if the dropbox is active, then can print optype name */
694         bool (*poll)(struct bContext *, struct wmDrag *, const wmEvent *, const char **);
695
696         /* before exec, this copies drag info to wmDrop properties */
697         void (*copy)(struct wmDrag *, struct wmDropBox *);
698
699         /* if poll survives, operator is called */
700         wmOperatorType *ot;                             /* not saved in file, so can be pointer */
701
702         struct IDProperty *properties;  /* operator properties, assigned to ptr->data and can be written to a file */
703         struct PointerRNA *ptr;                 /* rna pointer to access properties */
704
705         short opcontext;                                /* default invoke */
706
707 } wmDropBox;
708
709 /**
710  * Struct to store tool-tip timer and possible creation if the time is reached.
711  * Allows UI code to call #WM_tooltip_timer_init without each user having to handle the timer.
712  */
713 typedef struct wmTooltipState {
714         /** Create tooltip on this event. */
715         struct wmTimer *timer;
716         /** The region the tooltip is created in. */
717         struct ARegion *region_from;
718         /** The tooltip region. */
719         struct ARegion *region;
720         /** Create the tooltip region (assign to 'region'). */
721         struct ARegion *(*init)(struct bContext *, struct ARegion *, bool *r_exit_on_event);
722         /** Exit on any event, not needed for buttons since their highlight state is used. */
723         bool exit_on_event;
724 } wmTooltipState;
725
726 /* *************** migrated stuff, clean later? ************** */
727
728 typedef struct RecentFile {
729         struct RecentFile *next, *prev;
730         char *filepath;
731 } RecentFile;
732
733 /* Logging */
734 struct CLG_LogRef;
735 /* wm_init_exit.c */
736 extern struct CLG_LogRef *WM_LOG_OPERATORS;
737 extern struct CLG_LogRef *WM_LOG_HANDLERS;
738 extern struct CLG_LogRef *WM_LOG_EVENTS;
739 extern struct CLG_LogRef *WM_LOG_KEYMAPS;
740 extern struct CLG_LogRef *WM_LOG_TOOLS;
741 extern struct CLG_LogRef *WM_LOG_MSGBUS_PUB;
742 extern struct CLG_LogRef *WM_LOG_MSGBUS_SUB;
743
744
745 #ifdef __cplusplus
746 }
747 #endif
748
749 #endif /* __WM_TYPES_H__ */