source/blender/windowmanager/WM_api.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 #ifndef __WM_API_H__
  27 #define __WM_API_H__
  28
  29 /** \file WM_api.h
  30  *  \ingroup wm
  31  *
  32  *  \page wmpage windowmanager
  33  *  \section wmabout About windowmanager
  34  *  \ref wm handles events received from \ref GHOST and manages
  35  *  the screens, areas and input for Blender
  36  *  \section wmnote NOTE
  37  *  \todo document
  38  */
  39
  40 /* dna-savable wmStructs here */
  41 #include "DNA_windowmanager_types.h"
  42 #include "WM_keymap.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 struct bContext;
  49 struct IDProperty;
  50 struct wmEvent;
  51 struct wmEventHandler;
  52 struct wmGesture;
  53 struct wmJob;
  54 struct wmNotifier;
  55 struct wmOperatorType;
  56 struct wmOperator;
  57 struct rcti;
  58 struct PointerRNA;
  59 struct EnumPropertyItem;
  60 struct MenuType;
  61 struct wmDropBox;
  62 struct wmDrag;
  63 struct ImBuf;
  64
  65 typedef struct wmJob wmJob;
  66
  67 /* general API */
  68 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
  69 void            WM_setinitialstate_fullscreen(void);
  70 void            WM_setinitialstate_normal(void);
  71
  72 void            WM_init                         (struct bContext *C, int argc, const char **argv);
  73 void            WM_exit_ext                     (struct bContext *C, const short do_python);
  74 void            WM_exit                         (struct bContext *C);
  75 void            WM_main                         (struct bContext *C);
  76
  77 int             WM_init_game            (struct bContext *C);
  78 void            WM_init_splash          (struct bContext *C);
  79
  80
  81 void            WM_check                        (struct bContext *C);
  82
  83 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
  84
  85                         /* defines for 'type' WM_window_open_temp */
  86 #define WM_WINDOW_RENDER                0
  87 #define WM_WINDOW_USERPREFS             1
  88 #define WM_WINDOW_FILESEL               2
  89
  90 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
  91
  92
  93
  94                         /* files */
  95 int                     WM_read_homefile_exec(struct bContext *C, struct wmOperator *op);
  96 int                     WM_read_homefile        (struct bContext *C, struct ReportList *reports, short from_memory);
  97 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
  98 void            WM_read_file            (struct bContext *C, const char *filepath, struct ReportList *reports);
  99 int                     WM_write_file           (struct bContext *C, const char *target, int fileflags, struct ReportList *reports, int copy);
 100 void            WM_read_autosavefile(struct bContext *C);
 101 void            WM_autosave_init        (struct wmWindowManager *wm);
 102
 103                         /* mouse cursors */
 104 void            WM_cursor_set           (struct wmWindow *win, int curs);
 105 void            WM_cursor_modal         (struct wmWindow *win, int curs);
 106 void            WM_cursor_restore       (struct wmWindow *win);
 107 void            WM_cursor_wait          (int val);
 108 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
 109 void            WM_cursor_ungrab(struct wmWindow *win);
 110 void            WM_timecursor           (struct wmWindow *win, int nr);
 111
 112 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
 113 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
 114
 115 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
 116
 117                         /* event map */
 118 int                     WM_userdef_event_map(int kmitype);
 119
 120                         /* handlers */
 121
 122 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
 123                                                 /* boundbox, optional subwindow boundbox for offset */
 124 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
 125                                                 /* priority not implemented, it adds in begin */
 126 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
 127
 128 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
 129
 130 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
 131                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
 132                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
 133 void            WM_event_remove_ui_handler(ListBase *handlers,
 134                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
 135                         void (*remove)(struct bContext *C, void *userdata), void *userdata, int postpone);
 136 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
 137
 138 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
 139 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
 140
 141 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
 142
 143                         /* mouse */
 144 void            WM_event_add_mousemove(struct bContext *C);
 145 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
 146
 147                         /* notifiers */
 148 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
 149 void            WM_main_add_notifier(unsigned int type, void *reference);
 150
 151 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
 152
 153                         /* at maximum, every timestep seconds it triggers event_type events */
 154 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
 155 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
 156 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
 157
 158                 /* operator api, default callbacks */
 159                         /* invoke callback, uses enum property named "type" */
 160 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 161 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 162                         /* invoke callback, confirm menu + exec */
 163 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 164                 /* invoke callback, file selector "filepath" unset + exec */
 165 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 166                         /* poll callback, context checks */
 167 int                     WM_operator_winactive   (struct bContext *C);
 168                         /* invoke callback, exec + redo popup */
 169 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 170 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
 171 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
 172 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
 173
 174 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
 175
 176                 /* operator api */
 177 void            WM_operator_free                (struct wmOperator *op);
 178 void            WM_operator_stack_clear(struct wmWindowManager *wm);
 179
 180 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
 181 struct GHashIterator *WM_operatortype_iter(void);
 182 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
 183 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
 184 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
 185 int                     WM_operatortype_remove(const char *idname);
 186
 187 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, int flag);
 188 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
 189
 190
 191 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
 192 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, int context);
 193 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
 194 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
 195 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
 196 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
 197 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
 198 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
 199
 200 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
 201 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
 202 void        WM_operator_properties_reset(struct wmOperator *op);
 203 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
 204 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
 205 void            WM_operator_properties_free(struct PointerRNA *ptr);
 206 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display);
 207 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
 208 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
 209 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
 210
 211 int         WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
 212 wmOperator *WM_operator_last_redo(const struct bContext *C);
 213
 214 /* MOVE THIS SOMEWHERE ELSE */
 215 #define SEL_TOGGLE              0
 216 #define SEL_SELECT              1
 217 #define SEL_DESELECT    2
 218 #define SEL_INVERT              3
 219
 220
 221 /* flags for WM_operator_properties_filesel */
 222 #define WM_FILESEL_RELPATH              (1 << 0)
 223
 224 #define WM_FILESEL_DIRECTORY    (1 << 1)
 225 #define WM_FILESEL_FILENAME             (1 << 2)
 226 #define WM_FILESEL_FILEPATH             (1 << 3)
 227 #define WM_FILESEL_FILES                (1 << 4)
 228
 229
 230                 /* operator as a python command (resultuing string must be free'd) */
 231 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
 232 void            WM_operator_bl_idname(char *to, const char *from);
 233 void            WM_operator_py_idname(char *to, const char *from);
 234
 235 /* *************** menu types ******************** */
 236 void                            WM_menutype_init(void);
 237 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
 238 int                                     WM_menutype_add(struct MenuType* mt);
 239 void                            WM_menutype_freelink(struct MenuType* mt);
 240 void                            WM_menutype_free(void);
 241
 242                         /* default operator callbacks for border/circle/lasso */
 243 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 244 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 245 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
 246 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 247 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 248 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
 249 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 250 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 251 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
 252 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 253 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 254 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
 255 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 256 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 257 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
 258
 259                         /* default operator for arearegions, generates event */
 260 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
 261
 262                         /* Gesture manager API */
 263 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
 264 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
 265 void            WM_gestures_remove(struct bContext *C);
 266
 267                         /* fileselecting support */
 268 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
 269 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
 270 #ifndef NDEBUG
 271 void            WM_event_print(struct wmEvent *event);
 272 #endif
 273
 274                         /* drag and drop */
 275 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
 276 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
 277
 278 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
 279                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
 280 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
 281
 282                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
 283 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
 284 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
 285
 286                         /* OpenGL utilities with safety check + working in modelview matrix mode */
 287 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
 288 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
 289 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
 290
 291                         /* utilities */
 292 void            WM_set_framebuffer_index_color(int index);
 293 int                     WM_framebuffer_to_index(unsigned int col);
 294
 295                         /* threaded Jobs Manager */
 296 #define WM_JOB_PRIORITY         1
 297 #define WM_JOB_EXCL_RENDER      2
 298 #define WM_JOB_PROGRESS         4
 299 #define WM_JOB_SUSPEND          8
 300
 301 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag);
 302
 303 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
 304 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
 305 char            *WM_jobs_name(struct wmWindowManager *wm, void *owner);
 306
 307 int             WM_jobs_is_running(struct wmJob *);
 308 void*           WM_jobs_get_customdata(struct wmJob *);
 309 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
 310 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
 311 void            WM_jobs_callbacks(struct wmJob *,
 312                                                           void (*startjob)(void *, short *, short *, float *),
 313                                                           void (*initjob)(void *),
 314                                                           void (*update)(void *),
 315                                                           void (*endjob)(void *));
 316
 317 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
 318 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
 319 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
 320 void            WM_jobs_stop_all(struct wmWindowManager *wm);
 321
 322 int                     WM_jobs_has_running(struct wmWindowManager *wm);
 323
 324                         /* clipboard */
 325 char            *WM_clipboard_text_get(int selection);
 326 void            WM_clipboard_text_set(char *buf, int selection);
 327
 328                         /* progress */
 329 void            WM_progress_set(struct wmWindow *win, float progress);
 330 void            WM_progress_clear(struct wmWindow *win);
 331
 332 #ifdef WIN32
 333                         /* Windows System Console */
 334 void            WM_console_toggle(struct bContext *C, short show);
 335 #endif
 336
 337                         /* Draw (for screenshot) */
 338 void            WM_redraw_windows(struct bContext *C);
 339
 340 /* debugging only, convenience function to write on crash */
 341 int write_crash_blend(void);
 342
 343 #ifdef __cplusplus
 344 }
 345 #endif
 346
 347 #endif /* __WM_API_H__ */
 348