source/blender/editors/interface/interface.h

   1 /**
   2  * $Id: interface.h 14444 2008-04-16 22:40:48Z hos $
   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 uiHandleButtonData;
  37 struct wmWindow;
  38 struct ARegion;
  39 struct bContext;
  40
  41 /* general defines */
  42
  43 #define UI_MAX_DRAW_STR 400
  44 #define UI_MAX_NAME_STR 64
  45 #define UI_ARRAY        29
  46
  47 /* panel limits */
  48 #define UI_PANEL_MINX   100
  49 #define UI_PANEL_MINY   70
  50
  51 /* uiBut->flag */
  52 #define UI_SELECT               1
  53 #define UI_MOUSE_OVER   2
  54 #define UI_ACTIVE               4
  55 #define UI_HAS_ICON             8
  56 /* warn: rest of uiBut->flag in BIF_interface.c */
  57
  58 /* internal panel drawing defines */
  59 #define PNL_GRID        4
  60 #define PNL_DIST        8
  61 #define PNL_SAFETY      8
  62 #define PNL_HEADER  20
  63
  64 /* panel->flag */
  65 #define PNL_SELECT      1
  66 #define PNL_CLOSEDX     2
  67 #define PNL_CLOSEDY     4
  68 #define PNL_CLOSED      6
  69 #define PNL_TABBED      8
  70 #define PNL_OVERLAP     16
  71
  72 /* Button text selection:
  73  * extension direction, selextend, inside ui_do_but_TEX */
  74 #define EXTEND_LEFT             1
  75 #define EXTEND_RIGHT    2
  76
  77 typedef struct {
  78         short xim, yim;
  79         unsigned int *rect;
  80         short xofs, yofs;
  81 } uiIconImage;
  82
  83 typedef struct {
  84         short mval[2];
  85         short qual, val;
  86         int event;
  87 } uiEvent;
  88
  89 typedef struct {
  90         void *xl, *large, *medium, *small;
  91 } uiFont;
  92
  93 typedef struct uiLinkLine {                             /* only for draw/edit */
  94         struct uiLinkLine *next, *prev;
  95
  96         short flag, pad;
  97
  98         struct uiBut *from, *to;
  99 } uiLinkLine;
 100
 101 typedef struct {
 102         void **poin;            /* pointer to original pointer */
 103         void ***ppoin;          /* pointer to original pointer-array */
 104         short *totlink;         /* if pointer-array, here is the total */
 105
 106         short maxlink, pad;
 107         short fromcode, tocode;
 108
 109         ListBase lines;
 110 } uiLink;
 111
 112 struct uiBut {
 113         struct uiBut *next, *prev;
 114         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
 115         int flag;
 116
 117         char *str;
 118         char strdata[UI_MAX_NAME_STR];
 119         char drawstr[UI_MAX_DRAW_STR];
 120
 121         float x1, y1, x2, y2;
 122
 123         char *poin;
 124         float min, max;
 125         float a1, a2, hsv[3];   // hsv is temp memory for hsv buttons
 126         float aspect;
 127
 128         void (*func)(struct bContext*, void *, void *);
 129         void *func_arg1;
 130         void *func_arg2;
 131
 132         void (*handle_func)(struct bContext*, void *arg, int event);
 133         void *handle_func_arg;
 134
 135         void (*embossfunc)(int , int , float, float, float, float, float, int);
 136         void (*sliderfunc)(int , float, float, float, float, float, float, int);
 137
 138         void (*autocomplete_func)(struct bContext*, char *, void *);
 139         void *autofunc_arg;
 140
 141         uiLink *link;
 142
 143         char *tip, *lockstr;
 144
 145         int themecol;   /* themecolor id */
 146         void *font;
 147
 148         BIFIconID icon;
 149         short but_align;        /* aligning buttons, horiz/vertical */
 150         short lock, win;
 151         short iconadd, dt;
 152
 153                 /* IDPOIN data */
 154         uiIDPoinFuncFP idpoin_func;
 155         ID **idpoin_idpp;
 156
 157                 /* BLOCK data */
 158         uiBlockFuncFP block_func;
 159
 160                 /* RNA */
 161         struct PointerRNA rnapoin;
 162         struct PropertyRNA *rnaprop;
 163         int rnaindex;
 164
 165                 /* activation button data */
 166         struct uiHandleButtonData *active;
 167
 168         char *editstr;
 169         double *editval;
 170         float *editvec;
 171         void *editcoba;
 172         void *editcumap;
 173
 174                 /* pointer back */
 175         uiBlock *block;
 176 };
 177
 178 struct uiBlock {
 179         uiBlock *next, *prev;
 180
 181         ListBase buttons;
 182         Panel *panel;
 183         uiBlock *oldblock;
 184
 185         char name[UI_MAX_NAME_STR];
 186
 187         float winmat[4][4];
 188
 189         float minx, miny, maxx, maxy;
 190         float aspect;
 191
 192         void (*func)(struct bContext*, void *arg1, void *arg2);
 193         void *func_arg1;
 194         void *func_arg2;
 195
 196         void (*butm_func)(struct bContext*, void *arg, int but_a2);
 197         void *butm_func_arg;
 198
 199         void (*handle_func)(struct bContext*, void *arg, int event);
 200         void *handle_func_arg;
 201
 202         /* extra draw function for custom blocks */
 203         void (*drawextra)();
 204
 205         int themecol;   /* themecolor id */
 206
 207         short font;     /* indices */
 208         int afterval, flag;
 209         void *curfont;
 210
 211         short autofill, win, winq, direction, dt;
 212         short auto_open, in_use, pad;
 213         double auto_open_last;
 214
 215         int lock;
 216         char *lockstr;
 217
 218         float xofs, yofs;                       // offset to parent button
 219
 220         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
 221         ListBase saferct;                       // uiSafetyRct list
 222
 223         uiMenuBlockHandle *handle;      // handle
 224         int tooltipdisabled;            // to avoid tooltip after click
 225 };
 226
 227 typedef struct uiSafetyRct {
 228         struct uiSafetyRct *next, *prev;
 229         rctf parent;
 230         rctf safety;
 231 } uiSafetyRct;
 232
 233 /* interface.c */
 234
 235 extern int ui_translate_buttons(void);
 236 extern int ui_translate_menus(void);
 237 extern int ui_translate_tooltips(void);
 238
 239 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
 240 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
 241 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
 242 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
 243 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
 244 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
 245
 246 extern double ui_get_but_val(uiBut *but);
 247 extern void ui_set_but_val(uiBut *but, double value);
 248 extern void ui_set_but_hsv(uiBut *but);
 249 extern void ui_get_but_vectorf(uiBut *but, float *vec);
 250 extern void ui_set_but_vectorf(uiBut *but, float *vec);
 251 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
 252 extern void ui_set_but_string(uiBut *but, const char *str);
 253
 254 extern void ui_check_but(uiBut *but);
 255 extern void ui_autofill(uiBlock *block);
 256 extern int  ui_is_but_float(uiBut *but);
 257 extern void ui_update_block_buts_hsv(uiBlock *block, float *hsv);
 258
 259 /* interface_regions.c */
 260 uiBlock *ui_block_func_MENU(struct bContext *C, uiMenuBlockHandle *handle, void *arg_but);
 261 uiBlock *ui_block_func_ICONROW(struct bContext *C, uiMenuBlockHandle *handle, void *arg_but);
 262 uiBlock *ui_block_func_ICONTEXTROW(struct bContext *C, uiMenuBlockHandle *handle, void *arg_but);
 263 uiBlock *ui_block_func_COL(struct bContext *C, uiMenuBlockHandle *handle, void *arg_but);
 264
 265 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
 266 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
 267
 268 uiMenuBlockHandle *ui_menu_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
 269         uiBlockFuncFP block_func, void *arg);
 270 void ui_menu_block_free(struct bContext *C, uiMenuBlockHandle *handle);
 271
 272 void ui_set_name_menu(uiBut *but, int value);
 273
 274 /* interface_panel.c */
 275 extern void ui_draw_panel(uiBlock *block);
 276 extern void ui_do_panel(uiBlock *block, uiEvent *uevent);
 277 extern void ui_scale_panel(uiBlock *block);
 278 extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
 279 extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
 280
 281 /* interface_draw.c */
 282 extern void ui_set_embossfunc(uiBut *but, int drawtype);
 283 extern void ui_draw_but(uiBut *but);
 284 extern void ui_rasterpos_safe(float x, float y, float aspect);
 285 extern void ui_draw_tria_icon(float x, float y, float aspect, char dir);
 286 extern void ui_draw_anti_x(float x1, float y1, float x2, float y2);
 287 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
 288
 289 /* interface_handlers.c */
 290 extern void ui_button_active_cancel(const struct bContext *C, uiBut *but);
 291
 292 #endif
 293