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