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