source/blender/windowmanager/WM_api.h

   1 /**
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  *
  20  * The Original Code is Copyright (C) 2007 Blender Foundation.
  21  * All rights reserved.
  22  *
  23  *
  24  * Contributor(s): Blender Foundation
  25  *
  26  * ***** END GPL LICENSE BLOCK *****
  27  */
  28 #ifndef WM_API_H
  29 #define WM_API_H
  30
  31 /* dna-savable wmStructs here */
  32 #include "DNA_windowmanager_types.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct bContext;
  39 struct IDProperty;
  40 struct wmEvent;
  41 struct wmEventHandler;
  42 struct wmGesture;
  43 struct wmJob;
  44 struct wmNotifier;
  45 struct wmOperatorType;
  46 struct wmOperator;
  47 struct rcti;
  48 struct PointerRNA;
  49 struct EnumPropertyItem;
  50 struct MenuType;
  51 struct wmDropBox;
  52 struct wmDrag;
  53 struct ImBuf;
  54
  55 typedef struct wmJob wmJob;
  56
  57 /* general API */
  58 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
  59 void            WM_setinitialstate_fullscreen(void);
  60 void            WM_setinitialstate_normal(void);
  61
  62 void            WM_init                         (struct bContext *C, int argc, char **argv);
  63 void            WM_exit                         (struct bContext *C);
  64 void            WM_main                         (struct bContext *C);
  65
  66 int             WM_init_game            (struct bContext *C);
  67 void            WM_init_splash          (struct bContext *C);
  68
  69
  70 void            WM_check                        (struct bContext *C);
  71
  72 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
  73
  74                         /* defines for 'type' WM_window_open_temp */
  75 #define WM_WINDOW_RENDER                0
  76 #define WM_WINDOW_USERPREFS             1
  77 #define WM_WINDOW_FILESEL               2
  78
  79 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
  80
  81
  82
  83                         /* files */
  84 int                     WM_read_homefile        (struct bContext *C, struct wmOperator *op);
  85 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
  86 void            WM_read_file            (struct bContext *C, const char *name, struct ReportList *reports);
  87 int                     WM_write_file           (struct bContext *C, const char *target, int fileflags, struct ReportList *reports, int copy);
  88 void            WM_read_autosavefile(struct bContext *C);
  89 void            WM_autosave_init        (struct wmWindowManager *wm);
  90
  91                         /* mouse cursors */
  92 void            WM_cursor_set           (struct wmWindow *win, int curs);
  93 void            WM_cursor_modal         (struct wmWindow *win, int curs);
  94 void            WM_cursor_restore       (struct wmWindow *win);
  95 void            WM_cursor_wait          (int val);
  96 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
  97 void            WM_cursor_ungrab(struct wmWindow *win);
  98 void            WM_timecursor           (struct wmWindow *win, int nr);
  99
 100 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
 101 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
 102
 103 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
 104
 105                         /* keyconfig and keymap */
 106 wmKeyConfig *WM_keyconfig_new   (struct wmWindowManager *wm, const char *idname);
 107 wmKeyConfig *WM_keyconfig_new_user(struct wmWindowManager *wm, const char *idname);
 108 void            WM_keyconfig_remove     (struct wmWindowManager *wm, struct wmKeyConfig *keyconf);
 109 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
 110 void            WM_keyconfig_userdef(void);
 111
 112 void            WM_keymap_init          (struct bContext *C);
 113 void            WM_keymap_free          (struct wmKeyMap *keymap);
 114
 115 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, const char *idname, int type,
 116                                                                  int val, int modifier, int keymodifier);
 117 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, const char *idname, int type,
 118                                                                  int val, int modifier, int keymodifier);
 119 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, const char *idname, int type,
 120                                                                  int val, int modifier, int keymodifier);
 121
 122 void            WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
 123 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
 124
 125 wmKeyMap        *WM_keymap_list_find(ListBase *lb, const char *idname, int spaceid, int regionid);
 126 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
 127 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, const char *idname, int spaceid, int regionid);
 128 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
 129 wmKeyMap        *WM_keymap_guess_opname(const struct bContext *C, const char *opname);
 130 int                      WM_keymap_user_init(struct wmWindowManager *wm, struct wmKeyMap *keymap);
 131 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
 132 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
 133 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi, struct IDProperty *properties);
 134 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
 135
 136 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
 137 int                     WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
 138 int                     WM_userdef_event_map(int kmitype);
 139
 140 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, const char *idname, struct EnumPropertyItem *items);
 141 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, const char *idname);
 142 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
 143 void            WM_modalkeymap_assign(struct wmKeyMap *km, const char *opname);
 144
 145 const char      *WM_key_event_string(short type);
 146 int                     WM_key_event_operator_id(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, int hotkey, struct wmKeyMap **keymap_r);
 147 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
 148
 149                         /* handlers */
 150
 151 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
 152                                                 /* boundbox, optional subwindow boundbox for offset */
 153 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
 154                                                 /* priority not implemented, it adds in begin */
 155 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
 156
 157 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
 158
 159 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
 160                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
 161                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
 162 void            WM_event_remove_ui_handler(ListBase *handlers,
 163                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
 164                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
 165 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
 166
 167 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
 168 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
 169
 170 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
 171
 172                         /* mouse */
 173 void            WM_event_add_mousemove(struct bContext *C);
 174 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
 175
 176                         /* notifiers */
 177 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
 178 void            WM_main_add_notifier(unsigned int type, void *reference);
 179
 180 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
 181
 182                         /* at maximum, every timestep seconds it triggers event_type events */
 183 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
 184 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
 185 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
 186
 187                 /* operator api, default callbacks */
 188                         /* invoke callback, uses enum property named "type" */
 189 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 190 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 191                         /* invoke callback, confirm menu + exec */
 192 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 193                 /* invoke callback, file selector "filepath" unset + exec */
 194 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 195                         /* poll callback, context checks */
 196 int                     WM_operator_winactive   (struct bContext *C);
 197                         /* invoke callback, exec + redo popup */
 198 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 199 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
 200 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
 201 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
 202
 203 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
 204
 205                 /* operator api */
 206 void            WM_operator_free                (struct wmOperator *op);
 207 void            WM_operator_stack_clear(struct bContext *C);
 208
 209 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
 210 struct wmOperatorType *WM_operatortype_first(void);
 211 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
 212 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
 213 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
 214 int                     WM_operatortype_remove(const char *idname);
 215
 216 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, int flag);
 217 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
 218
 219
 220 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
 221 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, int context);
 222 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
 223 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
 224 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
 225 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
 226 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
 227
 228 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
 229 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
 230 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
 231 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
 232 void            WM_operator_properties_free(struct PointerRNA *ptr);
 233 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag);
 234 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
 235 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
 236 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
 237
 238 /* MOVE THIS SOMEWHERE ELSE */
 239 #define SEL_TOGGLE              0
 240 #define SEL_SELECT              1
 241 #define SEL_DESELECT    2
 242 #define SEL_INVERT              3
 243
 244
 245 /* flags for WM_operator_properties_filesel */
 246 #define WM_FILESEL_RELPATH              (1 << 0)
 247
 248 #define WM_FILESEL_DIRECTORY    (1 << 1)
 249 #define WM_FILESEL_FILENAME             (1 << 2)
 250 #define WM_FILESEL_FILEPATH             (1 << 3)
 251
 252
 253                 /* operator as a python command (resultuing string must be free'd) */
 254 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
 255 void            WM_operator_bl_idname(char *to, const char *from);
 256 void            WM_operator_py_idname(char *to, const char *from);
 257
 258 /* *************** menu types ******************** */
 259 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
 260 int                                     WM_menutype_add(struct MenuType* mt);
 261 void                            WM_menutype_freelink(struct MenuType* mt);
 262 void                            WM_menutype_free(void);
 263
 264                         /* default operator callbacks for border/circle/lasso */
 265 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 266 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 267 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 268 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 269 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 270 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 271 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 272 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 273 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 274 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 275
 276                         /* default operator for arearegions, generates event */
 277 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
 278
 279                         /* Gesture manager API */
 280 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
 281 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
 282 void            WM_gestures_remove(struct bContext *C);
 283
 284                         /* radial control operator */
 285 int                     WM_radial_control_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 286 int                     WM_radial_control_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
 287 void            WM_OT_radial_control_partial(struct wmOperatorType *ot);
 288 void            WM_radial_control_string(struct wmOperator *op, char str[], int maxlen);
 289
 290                         /* fileselecting support */
 291 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
 292 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
 293
 294                         /* drag and drop */
 295 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
 296 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
 297
 298 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
 299                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
 300 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
 301
 302                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
 303 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
 304 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
 305
 306                         /* OpenGL utilities with safety check + working in modelview matrix mode */
 307 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
 308 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
 309 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
 310
 311                         /* utilities */
 312 void            WM_set_framebuffer_index_color(int index);
 313 int                     WM_framebuffer_to_index(unsigned int col);
 314
 315                         /* threaded Jobs Manager */
 316 #define WM_JOB_PRIORITY         1
 317 #define WM_JOB_EXCL_RENDER      2
 318 #define WM_JOB_PROGRESS         4
 319
 320 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag);
 321
 322 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
 323 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
 324 char            *WM_jobs_name(struct wmWindowManager *wm, void *owner);
 325
 326 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
 327 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
 328 void            WM_jobs_callbacks(struct wmJob *,
 329                                                           void (*startjob)(void *, short *, short *, float *),
 330                                                           void (*initjob)(void *),
 331                                                           void (*update)(void *),
 332                                                           void (*endjob)(void *));
 333
 334 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
 335 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
 336 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
 337 void            WM_jobs_stop_all(struct wmWindowManager *wm);
 338
 339                         /* clipboard */
 340 char            *WM_clipboard_text_get(int selection);
 341 void            WM_clipboard_text_set(char *buf, int selection);
 342
 343                         /* progress */
 344 void            WM_progress_set(struct wmWindow *win, float progress);
 345 void            WM_progress_clear(struct wmWindow *win);
 346
 347 #ifdef WIN32
 348                         /* Windows System Console */
 349 void            WM_toggle_console(struct bContext *C, short show);
 350 #endif
 351
 352 #ifdef __cplusplus
 353 }
 354 #endif
 355
 356 #endif /* WM_API_H */
 357