x11 builds again.
[blender.git] / source / blender / windowmanager / WM_types.h
index 3f0c52f0f2ce5e89e1e86619bace8fa55f783376..8748703ad8e8aa97a02ced7d2db388d406a819b2 100644 (file)
@@ -1,5 +1,5 @@
-/**
- * $Id:
+/*
+ * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
@@ -15,7 +15,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2007 Blender Foundation.
  * All rights reserved.
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file blender/windowmanager/WM_types.h
+ *  \ingroup wm
+ */
+
 #ifndef WM_TYPES_H
 #define WM_TYPES_H
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 struct bContext;
 struct wmEvent;
 struct wmWindowManager;
+struct uiLayout;
+struct wmOperator;
+struct ImBuf;
 
-/* exported types for WM */
+#include "RNA_types.h"
+#include "DNA_listBase.h"
+#include "BKE_utildefines.h" /* FILE_MAX */
 
+/* exported types for WM */
 #include "wm_cursors.h"
 #include "wm_event_types.h"
 
@@ -45,6 +60,7 @@ struct wmWindowManager;
 #define OPTYPE_BLOCKING                4       /* let blender grab all input from the WM (X11) */
 #define OPTYPE_MACRO           8
 #define OPTYPE_GRAB_POINTER    16      /* */
+#define OPTYPE_PRESET          32      /* show preset menu */
 
 /* context to call operator in for WM_operator_name_call */
 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
@@ -52,11 +68,15 @@ enum {
        /* if there's invoke, call it, otherwise exec */
        WM_OP_INVOKE_DEFAULT,
        WM_OP_INVOKE_REGION_WIN,
+       WM_OP_INVOKE_REGION_CHANNELS,
+       WM_OP_INVOKE_REGION_PREVIEW,
        WM_OP_INVOKE_AREA,
        WM_OP_INVOKE_SCREEN,
        /* only call exec */
        WM_OP_EXEC_DEFAULT,
        WM_OP_EXEC_REGION_WIN,
+       WM_OP_EXEC_REGION_CHANNELS,
+       WM_OP_EXEC_REGION_PREVIEW,
        WM_OP_EXEC_AREA,
        WM_OP_EXEC_SCREEN
 };
@@ -83,6 +103,7 @@ enum {
 #define KM_PRESS       1
 #define KM_RELEASE     2
 #define KM_CLICK       3
+#define KM_DBL_CLICK   4
 
 
 /* ************** UI Handler ***************** */
@@ -101,7 +122,7 @@ typedef struct wmNotifier {
        struct wmWindowManager *wm;
        struct wmWindow *window;
        
-       int swinid;
+       int swinid;                     /* can't rely on this, notifiers can be added without context, swinid of 0 */
        unsigned int category, data, subtype, action;
        
        void *reference;
@@ -136,6 +157,8 @@ typedef struct wmNotifier {
 #define NC_SPACE                       (15<<24)
 #define        NC_GEOM                         (16<<24)
 #define NC_NODE                                (17<<24)
+#define NC_ID                          (18<<24)
+#define NC_LOGIC                       (19<<24)
 
 /* data type, 256 entries is enough, it can overlap */
 #define NOTE_DATA                      0x00FF0000
@@ -144,6 +167,8 @@ typedef struct wmNotifier {
 #define ND_FILEREAD                    (1<<16)
 #define ND_FILESAVE                    (2<<16)
 #define ND_DATACHANGED         (3<<16)
+#define ND_HISTORY                     (4<<16)
+#define ND_JOB                         (5<<16)
 
        /* NC_SCREEN screen */
 #define ND_SCREENBROWSE                (1<<16)
@@ -151,6 +176,10 @@ typedef struct wmNotifier {
 #define ND_SCREENCAST          (3<<16)
 #define ND_ANIMPLAY                    (4<<16)
 #define ND_GPENCIL                     (5<<16)
+#define ND_EDITOR_CHANGED      (6<<16) /*sent to new editors after switching to them*/
+#define ND_SCREENSET           (7<<16)
+#define ND_SKETCH                      (8<<16)
+#define ND_SUBWINACTIVE                (9<<16)
 
        /* NC_SCENE Scene */
 #define ND_SCENEBROWSE         (1<<16)
@@ -161,25 +190,32 @@ typedef struct wmNotifier {
 #define        ND_SEQUENCER            (6<<16)
 #define ND_OB_ACTIVE           (7<<16)
 #define ND_OB_SELECT           (8<<16)
-#define ND_MODE                                (9<<16)
-#define ND_RENDER_RESULT       (10<<16)
-#define ND_COMPO_RESULT                (11<<16)
-#define ND_KEYINGSET           (12<<16)
-#define ND_SCENEDELETE         (13<<16)
-#define ND_LAYER                       (14<<16)
+#define ND_OB_VISIBLE          (9<<16)
+#define ND_OB_RENDER           (10<<16)
+#define ND_MODE                                (11<<16)
+#define ND_RENDER_RESULT       (12<<16)
+#define ND_COMPO_RESULT                (13<<16)
+#define ND_KEYINGSET           (14<<16)
+#define ND_TOOLSETTINGS                (15<<16)
+#define ND_LAYER                       (16<<16)
+#define ND_FRAME_RANGE         (17<<16)
+#define ND_TRANSFORM_DONE      (18<<16)
+#define ND_WORLD                       (92<<16)
+#define ND_LAYER_CONTENT       (101<<16)
 
        /* NC_OBJECT Object */
-#define        ND_TRANSFORM            (16<<16)
-#define ND_OB_SHADING          (17<<16)
-#define ND_POSE                                (18<<16)
-#define ND_BONE_ACTIVE         (19<<16)
-#define ND_BONE_SELECT         (20<<16)
-#define ND_DRAW                                (21<<16)
-#define ND_MODIFIER                    (22<<16) /* modifiers edited */
-#define ND_KEYS                                (23<<16)
-#define ND_CONSTRAINT          (24<<16) /* constraints edited */
-#define ND_PARTICLE_DATA       (25<<16) /* particles edited */
-#define ND_PARTICLE_SELECT     (26<<16) /* particles selecting change */
+#define        ND_TRANSFORM            (18<<16)
+#define ND_OB_SHADING          (19<<16)
+#define ND_POSE                                (20<<16)
+#define ND_BONE_ACTIVE         (21<<16)
+#define ND_BONE_SELECT         (22<<16)
+#define ND_DRAW                                (23<<16)
+#define ND_MODIFIER                    (24<<16)
+#define ND_KEYS                                (25<<16)
+#define ND_CONSTRAINT          (26<<16)
+#define ND_PARTICLE                    (27<<16)
+#define ND_POINTCACHE          (28<<16)
+#define ND_PARENT                      (29<<16)
 
        /* NC_MATERIAL Material */
 #define        ND_SHADING                      (30<<16)
@@ -192,65 +228,65 @@ typedef struct wmNotifier {
 
        /* NC_WORLD World */
 #define        ND_WORLD_DRAW           (45<<16)
+#define        ND_WORLD_STARS          (46<<16)
 
        /* NC_TEXT Text */
 #define ND_CURSOR                      (50<<16)
 #define ND_DISPLAY                     (51<<16)
        
        /* NC_ANIMATION Animato */
-#define ND_KEYFRAME_SELECT     (70<<16)
-#define ND_KEYFRAME_EDIT       (71<<16)
-#define ND_KEYFRAME_PROP       (72<<16)
-#define ND_ANIMCHAN_SELECT     (73<<16)
-#define ND_ANIMCHAN_EDIT       (74<<16)
-#define ND_NLA_SELECT          (75<<16)
-#define ND_NLA_EDIT                    (76<<16)
-#define ND_NLA_ACTCHANGE       (77<<16)
+#define ND_KEYFRAME                    (70<<16)
+#define ND_KEYFRAME_PROP       (71<<16)
+#define ND_ANIMCHAN                    (72<<16)
+#define ND_NLA                         (73<<16)
+#define ND_NLA_ACTCHANGE       (74<<16)
+#define ND_FCURVES_ORDER       (75<<16)
 
        /* NC_GEOM Geometry */
        /* Mesh, Curve, MetaBall, Armature, .. */
-#define ND_SELECT                      (80<<16)
-#define ND_DATA                                (81<<16)
+#define ND_SELECT                      (90<<16)
+#define ND_DATA                                (91<<16)
 
        /* NC_NODE Nodes */
-#define ND_NODE_SELECT                 (1<<16)
-
 
        /* NC_SPACE */
 #define ND_SPACE_CONSOLE               (1<<16) /* general redraw */
-#define ND_SPACE_CONSOLE_REPORT        (2<<16) /* update for reports, could specify type */
-#define ND_SPACE_INFO                  (2<<16)
-#define ND_SPACE_IMAGE                 (3<<16)
-#define ND_SPACE_FILE_PARAMS   (4<<16)
-#define ND_SPACE_FILE_LIST             (5<<16)
-#define ND_SPACE_NODE                  (6<<16)
-#define ND_SPACE_OUTLINER              (7<<16)
-#define ND_SPACE_VIEW3D                        (8<<16)
-#define ND_SPACE_PROPERTIES            (9<<16)
-#define ND_SPACE_TEXT                  (10<<16)
-#define ND_SPACE_TIME                  (11<<16)
-#define ND_SPACE_GRAPH                 (12<<16)
-#define ND_SPACE_DOPESHEET             (13<<16)
-#define ND_SPACE_NLA                   (14<<16)
-#define ND_SPACE_SEQUENCER             (15<<16)
-#define ND_SPACE_NODE_VIEW             (16<<16)
+#define ND_SPACE_INFO_REPORT   (2<<16) /* update for reports, could specify type */
+#define ND_SPACE_INFO                  (3<<16)
+#define ND_SPACE_IMAGE                 (4<<16)
+#define ND_SPACE_FILE_PARAMS   (5<<16)
+#define ND_SPACE_FILE_LIST             (6<<16)
+#define ND_SPACE_NODE                  (7<<16)
+#define ND_SPACE_OUTLINER              (8<<16)
+#define ND_SPACE_VIEW3D                        (9<<16)
+#define ND_SPACE_PROPERTIES            (10<<16)
+#define ND_SPACE_TEXT                  (11<<16)
+#define ND_SPACE_TIME                  (12<<16)
+#define ND_SPACE_GRAPH                 (13<<16)
+#define ND_SPACE_DOPESHEET             (14<<16)
+#define ND_SPACE_NLA                   (15<<16)
+#define ND_SPACE_SEQUENCER             (16<<16)
+#define ND_SPACE_NODE_VIEW             (17<<16)
+#define ND_SPACE_CHANGED               (18<<16) /*sent to a new editor type after it's replaced an old one*/
 
 /* subtype, 256 entries too */
 #define NOTE_SUBTYPE           0x0000FF00
 
 /* subtype scene mode */
-#define NS_MODE_OBJECT         (1<<8)
-
-#define NS_EDITMODE_MESH       (2<<8)
-#define NS_EDITMODE_CURVE      (3<<8)
-#define NS_EDITMODE_SURFACE    (4<<8)
-#define NS_EDITMODE_TEXT       (5<<8)
-#define NS_EDITMODE_MBALL      (6<<8)
-#define NS_EDITMODE_LATTICE    (7<<8)
+#define NS_MODE_OBJECT                 (1<<8)
+
+#define NS_EDITMODE_MESH               (2<<8)
+#define NS_EDITMODE_CURVE              (3<<8)
+#define NS_EDITMODE_SURFACE            (4<<8)
+#define NS_EDITMODE_TEXT               (5<<8)
+#define NS_EDITMODE_MBALL              (6<<8)
+#define NS_EDITMODE_LATTICE            (7<<8)
 #define NS_EDITMODE_ARMATURE   (8<<8)
-#define NS_MODE_POSE           (9<<8)
-#define NS_MODE_PARTICLE       (10<<8)
+#define NS_MODE_POSE                   (9<<8)
+#define NS_MODE_PARTICLE               (10<<8)
 
+/* subtype 3d view editing */
+#define NS_VIEW3D_GPU                  (16<<8)
 
 /* action classification */
 #define NOTE_ACTION                    (0x000000FF)
@@ -258,7 +294,8 @@ typedef struct wmNotifier {
 #define NA_EVALUATED           2
 #define NA_ADDED                       3
 #define NA_REMOVED                     4
-
+#define NA_RENAME                      5
+#define NA_SELECTED                    6
 
 /* ************** Gesture Manager data ************** */
 
@@ -269,6 +306,7 @@ typedef struct wmNotifier {
 #define WM_GESTURE_CROSS_RECT  3
 #define WM_GESTURE_LASSO               4
 #define WM_GESTURE_CIRCLE              5
+#define WM_GESTURE_STRAIGHTLINE        6
 
 /* wmGesture is registered to window listbase, handled by operator callbacks */
 /* tweak gesture is builtin feature */
@@ -279,13 +317,54 @@ typedef struct wmGesture {
        int type;               /* gesture type define */
        int swinid;             /* initial subwindow id where it started */
        int points;             /* optional, amount of points stored */
+       int size;               /* optional, maximum amount of points stored */
        
        void *customdata;
        /* customdata for border is a recti */
        /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
        /* customdata for lasso is short array */
+       /* customdata for straight line is a recti: (xmin,ymin) is start, (xmax, ymax) is end */
 } wmGesture;
 
+/* ************** wmEvent ************************ */
+
+/* each event should have full modifier state */
+/* event comes from eventmanager and from keymap */
+typedef struct wmEvent {
+       struct wmEvent *next, *prev;
+       
+       short type;                     /* event code itself (short, is also in keymap) */
+       short val;                      /* press, release, scrollvalue */
+       short x, y;                     /* mouse pointer position, screen coord */
+       short mval[2];          /* region mouse position, name convention pre 2.5 :) */
+       short unicode;          /* future, ghost? */
+       char ascii;                     /* from ghost */
+       char pad;
+
+       /* previous state */
+       short prevtype;
+       short prevval;
+       short prevx, prevy;
+       double prevclicktime;
+       short prevclickx, prevclicky;
+       
+       /* modifier states */
+       short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
+       short keymodifier;                              /* rawkey modifier */
+       
+       short pad1;
+       
+       /* keymap item, set by handler (weak?) */
+       const char *keymap_idname;
+       
+       /* custom data */
+       short custom;           /* custom data type, stylus, 6dof, see wm_event_types.h */
+       short customdatafree;
+       int pad2;
+       void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
+       
+} wmEvent;
+
 /* ************** custom wmEvent data ************** */
 typedef struct wmTabletData {
        int Active;                     /* 0=EVT_TABLET_NONE, 1=EVT_TABLET_STYLUS, 2=EVT_TABLET_ERASER */
@@ -313,6 +392,64 @@ typedef struct wmTimer {
 } wmTimer;
 
 
+typedef struct wmOperatorType {
+       struct wmOperatorType *next, *prev;
+
+       const char *name;               /* text for ui, undo */
+       const char *idname;             /* unique identifier */
+       const char *description;        /* tooltips and python docs */
+
+       /* this callback executes the operator without any interactive input,
+        * parameters may be provided through operator properties. cannot use
+        * any interface code or input device state.
+        * - see defines below for return values */
+       int (*exec)(struct bContext *, struct wmOperator *);
+       
+       /* this callback executes on a running operator whenever as property
+        * is changed. It can correct its own properties or report errors for
+        * invalid settings in exceptional cases.
+        * Boolean return value, True denotes a change has been made and to redraw */
+       int (*check)(struct bContext *, struct wmOperator *);
+
+       /* for modal temporary operators, initially invoke is called. then
+        * any further events are handled in modal. if the operation is
+        * cancelled due to some external reason, cancel is called
+        * - see defines below for return values */
+       int (*invoke)(struct bContext *, struct wmOperator *, struct wmEvent *);
+       int (*cancel)(struct bContext *, struct wmOperator *);
+       int (*modal)(struct bContext *, struct wmOperator *, struct wmEvent *);
+
+       /* verify if the operator can be executed in the current context, note
+        * that the operator might still fail to execute even if this return true */
+       int (*poll)(struct bContext *);
+
+       /* optional panel for redo and repeat, autogenerated if not set */
+       void (*ui)(struct bContext *, struct wmOperator *);
+
+       /* rna for properties */
+       struct StructRNA *srna;
+
+       /* rna property to use for generic invoke functions.
+        * menus, enum search... etc */
+       PropertyRNA *prop;
+
+       /* struct wmOperatorTypeMacro */
+       ListBase macro;
+
+       short flag;
+
+       /* pointer to modal keymap, do not free! */
+       struct wmKeyMap *modalkeymap;
+
+       /* only used for operators defined with python
+        * use to store pointers to python functions */
+       void *pyop_data;
+       int (*pyop_poll)(struct bContext *, struct wmOperatorType *ot);
+
+       /* RNA integration */
+       ExtensionRNA ext;
+} wmOperatorType;
+
 /* **************** Paint Cursor ******************* */
 
 typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
@@ -332,18 +469,67 @@ enum {
 
 typedef struct wmReport {
        struct wmReport *next, *prev;
-       int type;
        const char *typestr;
        char *message;
+       int type;
 } wmReport;
 
-/* *************** migrated stuff, clean later? ******************************** */
+/* *************** Drag and drop *************** */
+
+#define WM_DRAG_ID             0
+#define WM_DRAG_RNA            1
+#define WM_DRAG_PATH   2
+#define WM_DRAG_NAME   3
+#define WM_DRAG_VALUE  4
+
+/* note: structs need not exported? */
+
+typedef struct wmDrag {
+       struct wmDrag *next, *prev;
+       
+       int icon, type;                                 /* type, see WM_DRAG defines above */
+       void *poin;
+       char path[240]; /* FILE_MAX */
+       double value;
+       
+       struct ImBuf *imb;                                              /* if no icon but imbuf should be drawn around cursor */
+       float scale;
+       short sx, sy;
+       
+       char opname[240]; /* FILE_MAX */                        /* if set, draws operator name*/
+} wmDrag;
+
+/* dropboxes are like keymaps, part of the screen/area/region definition */
+/* allocation and free is on startup and exit */
+typedef struct wmDropBox {
+       struct wmDropBox *next, *prev;
+       
+       /* test if the dropbox is active, then can print optype name */
+       int (*poll)(struct bContext *, struct wmDrag *, wmEvent *);
+
+       /* before exec, this copies drag info to wmDrop properties */
+       void (*copy)(struct wmDrag *, struct wmDropBox *);
+       
+       /* if poll survives, operator is called */
+       wmOperatorType *ot;                             /* not saved in file, so can be pointer */
+       short opcontext;                                /* default invoke */
+       
+       struct IDProperty *properties;                  /* operator properties, assigned to ptr->data and can be written to a file */
+       struct PointerRNA *ptr;                 /* rna pointer to access properties */
+
+} wmDropBox;
+
+/* *************** migrated stuff, clean later? ************** */
 
 typedef struct RecentFile {
        struct RecentFile *next, *prev;
-       char *filename;
+       char *filepath;
 } RecentFile;
 
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* WM_TYPES_H */