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