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