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