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 ImBuf;
115
116 #include "RNA_types.h"
117 #include "DNA_listBase.h"
118 #include "DNA_vec_types.h"
119 #include "BLI_compiler_attrs.h"
120
121 /* exported types for WM */
122 #include "wm_cursors.h"
123 #include "wm_event_types.h"
124 #include "manipulators/WM_manipulator_types.h"
125
126 /* Include external manipulator API's */
127 #include "manipulators/WM_manipulator_api.h"
128
129 /* ************** wmOperatorType ************************ */
130
131 /* flag */
132 enum {
133         OPTYPE_REGISTER     = (1 << 0),  /* register operators in stack after finishing */
134         OPTYPE_UNDO         = (1 << 1),  /* do undo push after after */
135         OPTYPE_BLOCKING     = (1 << 2),  /* let blender grab all input from the WM (X11) */
136         OPTYPE_MACRO        = (1 << 3),
137         OPTYPE_GRAB_CURSOR  = (1 << 4),  /* grabs the cursor and optionally enables continuous cursor wrapping */
138         OPTYPE_PRESET       = (1 << 5),  /* show preset menu */
139
140         /* some operators are mainly for internal use
141          * and don't make sense to be accessed from the
142          * search menu, even if poll() returns true.
143          * currently only used for the search toolbox */
144         OPTYPE_INTERNAL     = (1 << 6),
145
146         OPTYPE_LOCK_BYPASS  = (1 << 7),  /* Allow operator to run when interface is locked */
147         OPTYPE_UNDO_GROUPED = (1 << 8),  /* Special type of undo which doesn't store itself multiple times */
148 };
149
150 /* context to call operator in for WM_operator_name_call */
151 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
152 enum {
153         /* if there's invoke, call it, otherwise exec */
154         WM_OP_INVOKE_DEFAULT,
155         WM_OP_INVOKE_REGION_WIN,
156         WM_OP_INVOKE_REGION_CHANNELS,
157         WM_OP_INVOKE_REGION_PREVIEW,
158         WM_OP_INVOKE_AREA,
159         WM_OP_INVOKE_SCREEN,
160         /* only call exec */
161         WM_OP_EXEC_DEFAULT,
162         WM_OP_EXEC_REGION_WIN,
163         WM_OP_EXEC_REGION_CHANNELS,
164         WM_OP_EXEC_REGION_PREVIEW,
165         WM_OP_EXEC_AREA,
166         WM_OP_EXEC_SCREEN
167 };
168
169 /* property tags for RNA_OperatorProperties */
170 typedef enum eOperatorPropTags {
171         OP_PROP_TAG_ADVANCED = (1 << 0),
172 } eOperatorPropTags;
173 #define OP_PROP_TAG_ADVANCED ((eOperatorPropTags)OP_PROP_TAG_ADVANCED)
174
175 /* ************** wmKeyMap ************************ */
176
177 /* modifier */
178 #define KM_SHIFT        1
179 #define KM_CTRL         2
180 #define KM_ALT          4
181 #define KM_OSKEY        8
182         /* means modifier should be pressed 2nd */
183 #define KM_SHIFT2       16
184 #define KM_CTRL2        32
185 #define KM_ALT2         64
186 #define KM_OSKEY2       128
187
188 /* KM_MOD_ flags for wmKeyMapItem and wmEvent.alt/shift/oskey/ctrl  */
189 /* note that KM_ANY and KM_NOTHING are used with these defines too */
190 #define KM_MOD_FIRST  1
191 #define KM_MOD_SECOND 2
192
193 /* type: defined in wm_event_types.c */
194 #define KM_TEXTINPUT    -2
195
196 /* val */
197 #define KM_ANY          -1
198 #define KM_NOTHING      0
199 #define KM_PRESS        1
200 #define KM_RELEASE      2
201 #define KM_CLICK        3
202 #define KM_DBL_CLICK    4
203 #define KM_CLICK_DRAG   5
204
205
206 /* ************** UI Handler ***************** */
207
208 #define WM_UI_HANDLER_CONTINUE  0
209 #define WM_UI_HANDLER_BREAK             1
210
211 /* ************** Notifiers ****************** */
212
213 typedef struct wmNotifier {
214         struct wmNotifier *next, *prev;
215
216         struct wmWindowManager *wm;
217         struct wmWindow *window;
218
219         unsigned int category, data, subtype, action;
220
221         void *reference;
222
223 } wmNotifier;
224
225
226 /* 4 levels
227  *
228  * 0xFF000000; category
229  * 0x00FF0000; data
230  * 0x0000FF00; data subtype (unused?)
231  * 0x000000FF; action
232  */
233
234 /* category */
235 #define NOTE_CATEGORY           0xFF000000
236 #define NC_WM                           (1<<24)
237 #define NC_WINDOW                       (2<<24)
238 #define NC_SCREEN                       (3<<24)
239 #define NC_SCENE                        (4<<24)
240 #define NC_OBJECT                       (5<<24)
241 #define NC_MATERIAL                     (6<<24)
242 #define NC_TEXTURE                      (7<<24)
243 #define NC_LAMP                         (8<<24)
244 #define NC_GROUP                        (9<<24)
245 #define NC_IMAGE                        (10<<24)
246 #define NC_BRUSH                        (11<<24)
247 #define NC_TEXT                         (12<<24)
248 #define NC_WORLD                        (13<<24)
249 #define NC_ANIMATION            (14<<24)
250 #define NC_SPACE                        (15<<24)
251 #define NC_GEOM                         (16<<24)
252 #define NC_NODE                         (17<<24)
253 #define NC_ID                           (18<<24)
254 #define NC_LOGIC                        (19<<24)
255 #define NC_MOVIECLIP                    (20<<24)
256 #define NC_MASK                         (21<<24)
257 #define NC_GPENCIL                      (22<<24)
258 #define NC_LINESTYLE                    (23<<24)
259 #define NC_CAMERA                       (24<<24)
260
261 /* data type, 256 entries is enough, it can overlap */
262 #define NOTE_DATA                       0x00FF0000
263
264         /* NC_WM windowmanager */
265 #define ND_FILEREAD                     (1<<16)
266 #define ND_FILESAVE                     (2<<16)
267 #define ND_DATACHANGED          (3<<16)
268 #define ND_HISTORY                      (4<<16)
269 #define ND_JOB                          (5<<16)
270 #define ND_UNDO                         (6<<16)
271
272         /* NC_SCREEN */
273 #define ND_LAYOUTBROWSE         (1<<16)
274 #define ND_LAYOUTDELETE         (2<<16)
275 #define ND_SCREENCAST           (3<<16)
276 #define ND_ANIMPLAY                     (4<<16)
277 #define ND_GPENCIL                      (5<<16)
278 #define ND_EDITOR_CHANGED       (6<<16) /*sent to new editors after switching to them*/
279 #define ND_LAYOUTSET            (7<<16)
280 #define ND_SKETCH                       (8<<16)
281 #define ND_WORKSPACE_SET        (9<<16)
282 #define ND_WORKSPACE_DELETE (10<<16)
283
284         /* NC_SCENE Scene */
285 #define ND_SCENEBROWSE          (1<<16)
286 #define ND_MARKERS                      (2<<16)
287 #define ND_FRAME                        (3<<16)
288 #define ND_RENDER_OPTIONS       (4<<16)
289 #define ND_NODES                        (5<<16)
290 #define ND_SEQUENCER            (6<<16)
291 #define ND_OB_ACTIVE            (7<<16)
292 #define ND_OB_SELECT            (8<<16)
293 #define ND_OB_VISIBLE           (9<<16)
294 #define ND_OB_RENDER            (10<<16)
295 #define ND_MODE                         (11<<16)
296 #define ND_RENDER_RESULT        (12<<16)
297 #define ND_COMPO_RESULT         (13<<16)
298 #define ND_KEYINGSET            (14<<16)
299 #define ND_TOOLSETTINGS         (15<<16)
300 #define ND_LAYER                        (16<<16)
301 #define ND_FRAME_RANGE          (17<<16)
302 #define ND_TRANSFORM_DONE       (18<<16)
303 #define ND_WORLD                        (92<<16)
304 #define ND_LAYER_CONTENT        (101<<16)
305
306         /* NC_OBJECT Object */
307 #define ND_TRANSFORM            (18<<16)
308 #define ND_OB_SHADING           (19<<16)
309 #define ND_POSE                         (20<<16)
310 #define ND_BONE_ACTIVE          (21<<16)
311 #define ND_BONE_SELECT          (22<<16)
312 #define ND_DRAW                         (23<<16)
313 #define ND_MODIFIER                     (24<<16)
314 #define ND_KEYS                         (25<<16)
315 #define ND_CONSTRAINT           (26<<16)
316 #define ND_PARTICLE                     (27<<16)
317 #define ND_POINTCACHE           (28<<16)
318 #define ND_PARENT                       (29<<16)
319 #define ND_LOD                          (30<<16)
320 #define ND_DRAW_RENDER_VIEWPORT (31<<16)  /* for camera & sequencer viewport update, also /w NC_SCENE */
321
322         /* NC_MATERIAL Material */
323 #define ND_SHADING                      (30<<16)
324 #define ND_SHADING_DRAW         (31<<16)
325 #define ND_SHADING_LINKS        (32<<16)
326 #define ND_SHADING_PREVIEW      (33<<16)
327
328         /* NC_LAMP Lamp */
329 #define ND_LIGHTING                     (40<<16)
330 #define ND_LIGHTING_DRAW        (41<<16)
331 #define ND_SKY                          (42<<16)
332
333         /* NC_WORLD World */
334 #define ND_WORLD_DRAW           (45<<16)
335
336         /* NC_TEXT Text */
337 #define ND_CURSOR                       (50<<16)
338 #define ND_DISPLAY                      (51<<16)
339
340         /* NC_ANIMATION Animato */
341 #define ND_KEYFRAME                     (70<<16)
342 #define ND_KEYFRAME_PROP        (71<<16)
343 #define ND_ANIMCHAN                     (72<<16)
344 #define ND_NLA                          (73<<16)
345 #define ND_NLA_ACTCHANGE        (74<<16)
346 #define ND_FCURVES_ORDER        (75<<16)
347
348         /* NC_GPENCIL */
349 #define ND_GPENCIL_EDITMODE     (85<<16)
350
351         /* NC_GEOM Geometry */
352         /* Mesh, Curve, MetaBall, Armature, .. */
353 #define ND_SELECT                       (90<<16)
354 #define ND_DATA                         (91<<16)
355 #define ND_VERTEX_GROUP         (92<<16)
356
357         /* NC_NODE Nodes */
358
359         /* NC_SPACE */
360 #define ND_SPACE_CONSOLE                (1<<16) /* general redraw */
361 #define ND_SPACE_INFO_REPORT    (2<<16) /* update for reports, could specify type */
362 #define ND_SPACE_INFO                   (3<<16)
363 #define ND_SPACE_IMAGE                  (4<<16)
364 #define ND_SPACE_FILE_PARAMS    (5<<16)
365 #define ND_SPACE_FILE_LIST              (6<<16)
366 #define ND_SPACE_NODE                   (7<<16)
367 #define ND_SPACE_OUTLINER               (8<<16)
368 #define ND_SPACE_VIEW3D                 (9<<16)
369 #define ND_SPACE_PROPERTIES             (10<<16)
370 #define ND_SPACE_TEXT                   (11<<16)
371 #define ND_SPACE_TIME                   (12<<16)
372 #define ND_SPACE_GRAPH                  (13<<16)
373 #define ND_SPACE_DOPESHEET              (14<<16)
374 #define ND_SPACE_NLA                    (15<<16)
375 #define ND_SPACE_SEQUENCER              (16<<16)
376 #define ND_SPACE_NODE_VIEW              (17<<16)
377 #define ND_SPACE_CHANGED                (18<<16) /*sent to a new editor type after it's replaced an old one*/
378 #define ND_SPACE_CLIP                   (19<<16)
379 #define ND_SPACE_FILE_PREVIEW   (20<<16)
380
381 /* subtype, 256 entries too */
382 #define NOTE_SUBTYPE            0x0000FF00
383
384 /* subtype scene mode */
385 #define NS_MODE_OBJECT                  (1<<8)
386
387 #define NS_EDITMODE_MESH                (2<<8)
388 #define NS_EDITMODE_CURVE               (3<<8)
389 #define NS_EDITMODE_SURFACE             (4<<8)
390 #define NS_EDITMODE_TEXT                (5<<8)
391 #define NS_EDITMODE_MBALL               (6<<8)
392 #define NS_EDITMODE_LATTICE             (7<<8)
393 #define NS_EDITMODE_ARMATURE    (8<<8)
394 #define NS_MODE_POSE                    (9<<8)
395 #define NS_MODE_PARTICLE                (10<<8)
396
397 /* subtype 3d view editing */
398 #define NS_VIEW3D_GPU                   (16<<8)
399
400 /* action classification */
401 #define NOTE_ACTION                     (0x000000FF)
402 #define NA_EDITED                       1
403 #define NA_EVALUATED            2
404 #define NA_ADDED                        3
405 #define NA_REMOVED                      4
406 #define NA_RENAME                       5
407 #define NA_SELECTED                     6
408 #define NA_PAINTING                     7
409
410 /* ************** Gesture Manager data ************** */
411
412 /* wmGesture->type */
413 #define WM_GESTURE_TWEAK                0
414 #define WM_GESTURE_LINES                1
415 #define WM_GESTURE_RECT                 2
416 #define WM_GESTURE_CROSS_RECT   3
417 #define WM_GESTURE_LASSO                4
418 #define WM_GESTURE_CIRCLE               5
419 #define WM_GESTURE_STRAIGHTLINE 6
420
421 /* wmGesture is registered to window listbase, handled by operator callbacks */
422 /* tweak gesture is builtin feature */
423 typedef struct wmGesture {
424         struct wmGesture *next, *prev;
425         int event_type; /* event->type */
426         int type;               /* gesture type define */
427         rcti winrct;    /* bounds of region to draw gesture within */
428         int points;             /* optional, amount of points stored */
429         int points_alloc;       /* optional, maximum amount of points stored */
430         int modal_state;
431
432         /* For modal operators which may be running idle, waiting for an event to activate the gesture.
433          * Typically this is set when the user is click-dragging the gesture (border and circle select for eg). */
434         uint is_active : 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 /* ************** custom wmEvent data ************** */
497 typedef struct wmTabletData {
498         int Active;                     /* 0=EVT_TABLET_NONE, 1=EVT_TABLET_STYLUS, 2=EVT_TABLET_ERASER */
499         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
500         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
501         float Ytilt;            /* as above */
502 } wmTabletData;
503
504 typedef enum {  /* motion progress, for modal handlers */
505         P_NOT_STARTED,
506         P_STARTING,    /* <-- */
507         P_IN_PROGRESS, /* <-- only these are sent for NDOF motion*/
508         P_FINISHING,   /* <-- */
509         P_FINISHED
510 } wmProgress;
511
512 #ifdef WITH_INPUT_NDOF
513 typedef struct wmNDOFMotionData {
514         /* awfully similar to GHOST_TEventNDOFMotionData... */
515         /* Each component normally ranges from -1 to +1, but can exceed that.
516          * These use blender standard view coordinates, with positive rotations being CCW about the axis. */
517         float tvec[3]; /* translation */
518         float rvec[3]; /* rotation: */
519         /* axis = (rx,ry,rz).normalized */
520         /* amount = (rx,ry,rz).magnitude [in revolutions, 1.0 = 360 deg] */
521         float dt; /* time since previous NDOF Motion event */
522         wmProgress progress; /* is this the first event, the last, or one of many in between? */
523 } wmNDOFMotionData;
524 #endif /* WITH_INPUT_NDOF */
525
526 typedef enum {  /* Timer flags */
527         WM_TIMER_NO_FREE_CUSTOM_DATA  = 1 << 0,  /* Do not attempt to free customdata pointer even if non-NULL. */
528 } wmTimerFlags;
529
530 typedef struct wmTimer {
531         struct wmTimer *next, *prev;
532
533         struct wmWindow *win;   /* window this timer is attached to (optional) */
534
535         double timestep;                /* set by timer user */
536         int event_type;                 /* set by timer user, goes to event system */
537         wmTimerFlags flags;             /* Various flags controlling timer options, see below. */
538         void *customdata;               /* set by timer user, to allow custom values */
539
540         double duration;                /* total running time in seconds */
541         double delta;                   /* time since previous step in seconds */
542
543         double ltime;                   /* internal, last time timer was activated */
544         double ntime;                   /* internal, next time we want to activate the timer */
545         double stime;                   /* internal, when the timer started */
546         bool sleep;                             /* internal, put timers to sleep when needed */
547 } wmTimer;
548
549 typedef struct wmOperatorType {
550         const char *name;               /* text for ui, undo */
551         const char *idname;             /* unique identifier */
552         const char *translation_context;
553         const char *description;        /* tooltips and python docs */
554         const char *undo_group; /* identifier to group operators together */
555
556         /* this callback executes the operator without any interactive input,
557          * parameters may be provided through operator properties. cannot use
558          * any interface code or input device state.
559          * - see defines below for return values */
560         int (*exec)(struct bContext *, struct wmOperator *) ATTR_WARN_UNUSED_RESULT;
561
562         /* this callback executes on a running operator whenever as property
563          * is changed. It can correct its own properties or report errors for
564          * invalid settings in exceptional cases.
565          * Boolean return value, True denotes a change has been made and to redraw */
566         bool (*check)(struct bContext *, struct wmOperator *);
567
568         /* for modal temporary operators, initially invoke is called. then
569          * any further events are handled in modal. if the operation is
570          * canceled due to some external reason, cancel is called
571          * - see defines below for return values */
572         int (*invoke)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
573
574         /* Called when a modal operator is canceled (not used often).
575          * Internal cleanup can be done here if needed. */
576         void (*cancel)(struct bContext *, struct wmOperator *);
577
578         /* Modal is used for operators which continuously run, eg:
579          * fly mode, knife tool, circle select are all examples of modal operators.
580          * Modal operators can handle events which would normally access other operators,
581          * they keep running until they don't return `OPERATOR_RUNNING_MODAL`. */
582         int (*modal)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
583
584         /* verify if the operator can be executed in the current context, note
585          * that the operator might still fail to execute even if this return true */
586         int (*poll)(struct bContext *) ATTR_WARN_UNUSED_RESULT;
587
588         /* optional panel for redo and repeat, autogenerated if not set */
589         void (*ui)(struct bContext *, struct wmOperator *);
590
591         /* rna for properties */
592         struct StructRNA *srna;
593
594         /* previous settings - for initializing on re-use */
595         struct IDProperty *last_properties;
596
597         /* Default rna property to use for generic invoke functions.
598          * menus, enum search... etc. Example: Enum 'type' for a Delete menu */
599         PropertyRNA *prop;
600
601         /* struct wmOperatorTypeMacro */
602         ListBase macro;
603
604         /* pointer to modal keymap, do not free! */
605         struct wmKeyMap *modalkeymap;
606
607         /* python needs the operator type as well */
608         int (*pyop_poll)(struct bContext *, struct wmOperatorType *ot) ATTR_WARN_UNUSED_RESULT;
609
610         /* RNA integration */
611         ExtensionRNA ext;
612
613         /* Flag last for padding */
614         short flag;
615
616 } wmOperatorType;
617
618 #ifdef WITH_INPUT_IME
619 /* *********** Input Method Editor (IME) *********** */
620
621 /* similar to GHOST_TEventImeData */
622 typedef struct wmIMEData {
623         size_t result_len, composite_len;
624
625         char *str_result;           /* utf8 encoding */
626         char *str_composite;        /* utf8 encoding */
627
628         int cursor_pos;             /* cursor position in the IME composition. */
629         int sel_start;              /* beginning of the selection */
630         int sel_end;                /* end of the selection */
631
632         bool is_ime_composing;
633 } wmIMEData;
634 #endif
635
636 /* **************** Paint Cursor ******************* */
637
638 typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
639
640 /* *************** Drag and drop *************** */
641
642 #define WM_DRAG_ID              0
643 #define WM_DRAG_RNA             1
644 #define WM_DRAG_PATH    2
645 #define WM_DRAG_NAME    3
646 #define WM_DRAG_VALUE   4
647 #define WM_DRAG_COLOR   5
648
649 typedef enum wmDragFlags {
650         WM_DRAG_NOP         = 0,
651         WM_DRAG_FREE_DATA   = 1,
652 } wmDragFlags;
653
654 /* note: structs need not exported? */
655
656 typedef struct wmDrag {
657         struct wmDrag *next, *prev;
658
659         int icon, type;                                 /* type, see WM_DRAG defines above */
660         void *poin;
661         char path[1024]; /* FILE_MAX */
662         double value;
663
664         struct ImBuf *imb;                                              /* if no icon but imbuf should be drawn around cursor */
665         float scale;
666         int sx, sy;
667
668         char opname[200]; /* if set, draws operator name*/
669         unsigned int flags;
670 } wmDrag;
671
672 /* dropboxes are like keymaps, part of the screen/area/region definition */
673 /* allocation and free is on startup and exit */
674 typedef struct wmDropBox {
675         struct wmDropBox *next, *prev;
676
677         /* test if the dropbox is active, then can print optype name */
678         int (*poll)(struct bContext *, struct wmDrag *, const wmEvent *);
679
680         /* before exec, this copies drag info to wmDrop properties */
681         void (*copy)(struct wmDrag *, struct wmDropBox *);
682
683         /* if poll survives, operator is called */
684         wmOperatorType *ot;                             /* not saved in file, so can be pointer */
685
686         struct IDProperty *properties;  /* operator properties, assigned to ptr->data and can be written to a file */
687         struct PointerRNA *ptr;                 /* rna pointer to access properties */
688
689         short opcontext;                                /* default invoke */
690
691 } wmDropBox;
692
693 /**
694  * Struct to store tool-tip timer and possible creation if the time is reached.
695  * Allows UI code to call #WM_tooltip_timer_init without each user having to handle the timer.
696  */
697 typedef struct wmTooltipState {
698         /** Create tooltip on this event. */
699         struct wmTimer *timer;
700         /** The region the tooltip is created in. */
701         struct ARegion *region_from;
702         /** The tooltip region. */
703         struct ARegion *region;
704         /** Create the tooltip region (assign to 'region'). */
705         struct ARegion *(*init)(struct bContext *, struct ARegion *, bool *r_exit_on_event);
706         /** Exit on any event, not needed for buttons since their highlight state is used. */
707         bool exit_on_event;
708 } wmTooltipState;
709
710 /* *************** migrated stuff, clean later? ************** */
711
712 typedef struct RecentFile {
713         struct RecentFile *next, *prev;
714         char *filepath;
715 } RecentFile;
716
717 /* Logging */
718 struct CLG_LogRef;
719 /* wm_init_exit.c */
720 extern struct CLG_LogRef *WM_LOG_OPERATORS;
721 extern struct CLG_LogRef *WM_LOG_HANDLERS;
722 extern struct CLG_LogRef *WM_LOG_EVENTS;
723 extern struct CLG_LogRef *WM_LOG_KEYMAPS;
724 extern struct CLG_LogRef *WM_LOG_TOOLS;
725 extern struct CLG_LogRef *WM_LOG_MSGBUS_PUB;
726 extern struct CLG_LogRef *WM_LOG_MSGBUS_SUB;
727
728
729 #ifdef __cplusplus
730 }
731 #endif
732
733 #endif /* __WM_TYPES_H__ */
734