source/blender/editors/interface/interface_intern.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) 2001-2002 by NaN Holding BV.
  21  * All rights reserved.
  22  *
  23  * The Original Code is: all of this file.
  24  *
  25  * Contributor(s): none yet.
  26  *
  27  * ***** END GPL LICENSE BLOCK *****
  28  */
  29
  30 #ifndef INTERFACE_H
  31 #define INTERFACE_H
  32
  33 #include "UI_resources.h"
  34 #include "RNA_types.h"
  35
  36 struct ARegion;
  37 struct bContext;
  38 struct IDProperty;
  39 struct uiHandleButtonData;
  40 struct wmEvent;
  41 struct wmOperatorType;
  42 struct wmWindow;
  43 struct uiStyle;
  44 struct uiWidgetColors;
  45 struct uiLayout;
  46 struct bContextStore;
  47 struct Scene;
  48 struct ID;
  49 struct ImBuf;
  50
  51 /* ****************** general defines ************** */
  52
  53 /* visual types for drawing */
  54 /* for time being separated from functional types */
  55 typedef enum {
  56         /* default */
  57         UI_WTYPE_REGULAR,
  58
  59         /* standard set */
  60         UI_WTYPE_LABEL,
  61         UI_WTYPE_TOGGLE,
  62         UI_WTYPE_OPTION,
  63         UI_WTYPE_RADIO,
  64         UI_WTYPE_NUMBER,
  65         UI_WTYPE_SLIDER,
  66         UI_WTYPE_EXEC,
  67
  68         /* strings */
  69         UI_WTYPE_NAME,
  70         UI_WTYPE_NAME_LINK,
  71         UI_WTYPE_POINTER_LINK,
  72         UI_WTYPE_FILENAME,
  73
  74         /* menus */
  75         UI_WTYPE_MENU_RADIO,
  76         UI_WTYPE_MENU_ICON_RADIO,
  77         UI_WTYPE_MENU_POINTER_LINK,
  78
  79         UI_WTYPE_PULLDOWN,
  80         UI_WTYPE_MENU_ITEM,
  81         UI_WTYPE_MENU_BACK,
  82
  83         /* specials */
  84         UI_WTYPE_ICON,
  85         UI_WTYPE_SWATCH,
  86         UI_WTYPE_RGB_PICKER,
  87         UI_WTYPE_NORMAL,
  88         UI_WTYPE_BOX,
  89         UI_WTYPE_SCROLL,
  90         UI_WTYPE_LISTITEM,
  91         UI_WTYPE_PROGRESSBAR,
  92
  93 } uiWidgetTypeEnum;
  94
  95
  96
  97 #define UI_MAX_DRAW_STR 400
  98 #define UI_MAX_NAME_STR 128
  99
 100 /* panel limits */
 101 #define UI_PANEL_MINX   100
 102 #define UI_PANEL_MINY   70
 103
 104 /* uiBut->flag */
 105 #define UI_SELECT               1 /* use when the button is pressed */
 106 /*#define UI_MOUSE_OVER 2*/  /*UNUSED, free flag*/
 107 #define UI_ACTIVE               4
 108 #define UI_HAS_ICON             8
 109 #define UI_TEXTINPUT    16
 110 #define UI_HIDDEN               32
 111 /* warn: rest of uiBut->flag in UI_interface.h */
 112
 113 /* internal panel drawing defines */
 114 #define PNL_GRID        4
 115 #define PNL_HEADER  20
 116
 117 /* panel->flag */
 118 #define PNL_SELECT      1
 119 #define PNL_CLOSEDX     2
 120 #define PNL_CLOSEDY     4
 121 #define PNL_CLOSED      6
 122 /*#define PNL_TABBED    8*/ /*UNUSED*/
 123 #define PNL_OVERLAP     16
 124
 125 /* Button text selection:
 126  * extension direction, selextend, inside ui_do_but_TEX */
 127 #define EXTEND_LEFT             1
 128 #define EXTEND_RIGHT    2
 129
 130 /* for scope resize zone */
 131 #define SCOPE_RESIZE_PAD        9
 132
 133 typedef struct {
 134         short xim, yim;
 135         unsigned int *rect;
 136         short xofs, yofs;
 137 } uiIconImage;
 138
 139
 140 typedef struct uiLinkLine {                             /* only for draw/edit */
 141         struct uiLinkLine *next, *prev;
 142
 143         short flag, pad;
 144
 145         struct uiBut *from, *to;
 146 } uiLinkLine;
 147
 148 typedef struct {
 149         void **poin;            /* pointer to original pointer */
 150         void ***ppoin;          /* pointer to original pointer-array */
 151         short *totlink;         /* if pointer-array, here is the total */
 152
 153         short maxlink, pad;
 154         short fromcode, tocode;
 155
 156         ListBase lines;
 157 } uiLink;
 158
 159 struct uiBut {
 160         struct uiBut *next, *prev;
 161         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
 162         short alignnr;
 163         int flag;
 164
 165         char *str;
 166         char strdata[UI_MAX_NAME_STR];
 167         char drawstr[UI_MAX_DRAW_STR];
 168
 169         float x1, y1, x2, y2;
 170
 171         char *poin;
 172         float hardmin, hardmax, softmin, softmax;
 173         float a1, a2;
 174         float aspect;
 175         char col[4];
 176
 177         uiButHandleFunc func;
 178         void *func_arg1;
 179         void *func_arg2;
 180         void *func_arg3;
 181
 182         uiButHandleNFunc funcN;
 183         void *func_argN;
 184
 185         struct bContextStore *context;
 186
 187         /* not ysed yet, was used in 2.4x for ui_draw_pulldown_round & friends */
 188         /*
 189         void (*embossfunc)(int , int , float, float, float, float, float, int);
 190         void (*sliderfunc)(int , float, float, float, float, float, float, int);
 191         */
 192
 193         uiButCompleteFunc autocomplete_func;
 194         void *autofunc_arg;
 195
 196         uiButSearchFunc search_func;
 197         void *search_arg;
 198
 199         uiButHandleRenameFunc rename_func;
 200         void *rename_arg1;
 201         void *rename_orig;
 202
 203         uiLink *link;
 204         short linkto[2];
 205
 206         const char *tip, *lockstr;
 207
 208         BIFIconID icon;
 209         char lock;
 210         char dt;
 211         char changed; /* could be made into a single flag */
 212         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
 213         short modifier_key;
 214         short iconadd;
 215
 216         /* IDPOIN data */
 217         uiIDPoinFuncFP idpoin_func;
 218         ID **idpoin_idpp;
 219
 220         /* BLOCK data */
 221         uiBlockCreateFunc block_create_func;
 222
 223         /* PULLDOWN/MENU data */
 224         uiMenuCreateFunc menu_create_func;
 225
 226         /* RNA data */
 227         struct PointerRNA rnapoin;
 228         struct PropertyRNA *rnaprop;
 229         int rnaindex;
 230
 231         struct PointerRNA rnasearchpoin;
 232         struct PropertyRNA *rnasearchprop;
 233
 234         /* Operator data */
 235         struct wmOperatorType *optype;
 236         struct IDProperty *opproperties;
 237         struct PointerRNA *opptr;
 238         short opcontext;
 239         unsigned char menu_key; /* 'a'-'z', always lower case */
 240
 241         /* Draggable data, type is WM_DRAG_... */
 242         char dragtype;
 243         void *dragpoin;
 244         struct ImBuf *imb;
 245         float imb_scale;
 246
 247         /* active button data */
 248         struct uiHandleButtonData *active;
 249
 250         char *editstr;
 251         double *editval;
 252         float *editvec;
 253         void *editcoba;
 254         void *editcumap;
 255
 256                 /* pointer back */
 257         uiBlock *block;
 258 };
 259
 260 struct uiBlock {
 261         uiBlock *next, *prev;
 262
 263         ListBase buttons;
 264         Panel *panel;
 265         uiBlock *oldblock;
 266
 267         ListBase layouts;
 268         struct uiLayout *curlayout;
 269
 270         ListBase contexts;
 271
 272         char name[UI_MAX_NAME_STR];
 273
 274         float winmat[4][4];
 275
 276         float minx, miny, maxx, maxy;
 277         float aspect;
 278
 279         short alignnr;
 280
 281         uiButHandleFunc func;
 282         void *func_arg1;
 283         void *func_arg2;
 284
 285         uiButHandleNFunc funcN;
 286         void *func_argN;
 287
 288         uiMenuHandleFunc butm_func;
 289         void *butm_func_arg;
 290
 291         uiBlockHandleFunc handle_func;
 292         void *handle_func_arg;
 293
 294         /* custom extra handling */
 295         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
 296
 297         /* extra draw function for custom blocks */
 298         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
 299         void *drawextra_arg1;
 300         void *drawextra_arg2;
 301
 302         int flag;
 303         char direction, dt;
 304         short auto_open;
 305         double auto_open_last;
 306
 307         const char *lockstr;
 308
 309         char lock;
 310         char active;                                    // to keep blocks while drawing and free them afterwards
 311         char tooltipdisabled;                   // to avoid tooltip after click
 312         char endblock;                                  // uiEndBlock done?
 313
 314         float xofs, yofs;                               // offset to parent button
 315         int dobounds, mx, my;                   // for doing delayed
 316         int bounds, minbounds;                  // for doing delayed
 317
 318         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
 319         ListBase saferct;                       // uiSafetyRct list
 320
 321         uiPopupBlockHandle *handle;     // handle
 322
 323         int puphash;                            // popup menu hash for memory
 324
 325         void *evil_C;                           // XXX hack for dynamic operator enums
 326
 327         float _hsv[3];                          // XXX, only access via ui_block_hsv_get()
 328         char color_profile;                             // color profile for correcting linear colors for display
 329 };
 330
 331 typedef struct uiSafetyRct {
 332         struct uiSafetyRct *next, *prev;
 333         rctf parent;
 334         rctf safety;
 335 } uiSafetyRct;
 336
 337 /* interface.c */
 338
 339 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
 340
 341 extern int ui_translate_buttons(void);
 342 extern int ui_translate_menus(void);
 343 extern int ui_translate_tooltips(void);
 344
 345 void ui_fontscale(short *points, float aspect);
 346
 347 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
 348 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
 349 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
 350 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
 351 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
 352 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
 353
 354 extern double ui_get_but_val(uiBut *but);
 355 extern void ui_set_but_val(uiBut *but, double value);
 356 extern void ui_set_but_hsv(uiBut *but);
 357 extern void ui_get_but_vectorf(uiBut *but, float *vec);
 358 extern void ui_set_but_vectorf(uiBut *but, float *vec);
 359
 360 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
 361
 362 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
 363 extern void ui_convert_to_unit_alt_name(uiBut *but, char *str, int maxlen);
 364 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
 365 extern int ui_get_but_string_max_length(uiBut *but);
 366
 367 extern void ui_set_but_default(struct bContext *C, uiBut *but);
 368
 369 extern void ui_set_but_soft_range(uiBut *but, double value);
 370
 371 extern void ui_check_but(uiBut *but);
 372 extern int  ui_is_but_float(uiBut *but);
 373 extern int  ui_is_but_unit(uiBut *but);
 374
 375 extern void ui_bounds_block(uiBlock *block);
 376 extern void ui_block_translate(uiBlock *block, int x, int y);
 377 extern void ui_block_do_align(uiBlock *block);
 378
 379 /* interface_regions.c */
 380
 381 struct uiPopupBlockHandle {
 382         /* internal */
 383         struct ARegion *region;
 384         int towardsx, towardsy;
 385         double towardstime;
 386         int dotowards;
 387
 388         int popup;
 389         void (*popup_func)(struct bContext *C, void *arg, int event);
 390         void (*cancel_func)(void *arg);
 391         void *popup_arg;
 392
 393         /* for operator popups */
 394         struct wmOperatorType *optype;
 395         int opcontext;
 396         ScrArea *ctx_area;
 397         ARegion *ctx_region;
 398
 399         /* return values */
 400         int butretval;
 401         int menuretval;
 402         float retvalue;
 403         float retvec[4];
 404 };
 405
 406 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
 407 void ui_block_func_ICONROW(struct bContext *C, uiLayout *layout, void *arg_but);
 408 void ui_block_func_ICONTEXTROW(struct bContext *C, uiLayout *layout, void *arg_but);
 409
 410 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
 411 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
 412
 413 uiBut *ui_popup_menu_memory(uiBlock *block, uiBut *but);
 414
 415 float *ui_block_hsv_get(uiBlock *block);
 416
 417 /* searchbox for string button */
 418 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
 419 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
 420 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
 421 void ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
 422 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
 423 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
 424 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
 425 void ui_but_search_test(uiBut *but);
 426
 427 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
 428
 429 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
 430         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
 431 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
 432         uiMenuCreateFunc create_func, void *arg, char *str);
 433
 434 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
 435
 436 void ui_set_name_menu(uiBut *but, int value);
 437 int ui_step_name_menu(uiBut *but, int step);
 438
 439 struct AutoComplete;
 440
 441 /* interface_panel.c */
 442 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
 443 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, rcti *rect);
 444
 445 /* interface_draw.c */
 446 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
 447
 448 void ui_draw_gradient(rcti *rect, float *hsv, int type, float alpha);
 449
 450 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 451 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 452 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 453 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 454 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 455 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 456 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
 457
 458 /* interface_handlers.c */
 459 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
 460 extern void ui_button_active_free(const struct bContext *C, uiBut *but);
 461 extern int ui_button_is_active(struct ARegion *ar);
 462
 463 /* interface_widgets.c */
 464 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
 465 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
 466 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
 467 int ui_link_bezier_points(rcti *rect, float coord_array[][2], int resol);
 468 void ui_draw_link_bezier(rcti *rect);
 469
 470 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
 471                 /* theme color init */
 472 struct ThemeUI;
 473 void ui_widget_color_init(struct ThemeUI *tui);
 474
 475 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
 476 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
 477
 478 /* interface_style.c */
 479 void uiStyleInit(void);
 480
 481 /* interface_icons.c */
 482 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
 483
 484 /* resources.c */
 485 void init_userdef_do_versions(void);
 486 void ui_theme_init_default(void);
 487 void ui_resources_init(void);
 488 void ui_resources_free(void);
 489
 490 /* interface_layout.c */
 491 void ui_layout_add_but(uiLayout *layout, uiBut *but);
 492 int ui_but_can_align(uiBut *but);
 493 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
 494
 495 /* interface_anim.c */
 496 void ui_but_anim_flag(uiBut *but, float cfra);
 497 void ui_but_anim_insert_keyframe(struct bContext *C);
 498 void ui_but_anim_delete_keyframe(struct bContext *C);
 499 void ui_but_anim_add_driver(struct bContext *C);
 500 void ui_but_anim_remove_driver(struct bContext *C);
 501 void ui_but_anim_copy_driver(struct bContext *C);
 502 void ui_but_anim_paste_driver(struct bContext *C);
 503 void ui_but_anim_add_keyingset(struct bContext *C);
 504 void ui_but_anim_remove_keyingset(struct bContext *C);
 505 int ui_but_anim_expression_get(uiBut *but, char *str, int maxlen);
 506 int ui_but_anim_expression_set(uiBut *but, const char *str);
 507 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
 508
 509 #endif
 510