Brecht Van Lommel
8036342ea8
* Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
330 lines
8.9 KiB
C++
330 lines
8.9 KiB
C++
/**
|
|
* $Id: interface.h 14444 2008-04-16 22:40:48Z hos $
|
|
*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
#ifndef INTERFACE_H
|
|
#define INTERFACE_H
|
|
|
|
#include "UI_resources.h"
|
|
#include "RNA_types.h"
|
|
|
|
struct ARegion;
|
|
struct bContext;
|
|
struct IDProperty;
|
|
struct uiHandleButtonData;
|
|
struct wmEvent;
|
|
struct wmWindow;
|
|
|
|
/* general defines */
|
|
|
|
#define UI_MAX_DRAW_STR 400
|
|
#define UI_MAX_NAME_STR 64
|
|
#define UI_ARRAY 29
|
|
|
|
/* panel limits */
|
|
#define UI_PANEL_MINX 100
|
|
#define UI_PANEL_MINY 70
|
|
|
|
/* uiBut->flag */
|
|
#define UI_SELECT 1
|
|
#define UI_MOUSE_OVER 2
|
|
#define UI_ACTIVE 4
|
|
#define UI_HAS_ICON 8
|
|
/* warn: rest of uiBut->flag in BIF_interface.c */
|
|
|
|
/* internal panel drawing defines */
|
|
#define PNL_GRID 4
|
|
#define PNL_DIST 8
|
|
#define PNL_SAFETY 8
|
|
#define PNL_HEADER 20
|
|
|
|
/* panel->flag */
|
|
#define PNL_SELECT 1
|
|
#define PNL_CLOSEDX 2
|
|
#define PNL_CLOSEDY 4
|
|
#define PNL_CLOSED 6
|
|
#define PNL_TABBED 8
|
|
#define PNL_OVERLAP 16
|
|
|
|
/* Button text selection:
|
|
* extension direction, selextend, inside ui_do_but_TEX */
|
|
#define EXTEND_LEFT 1
|
|
#define EXTEND_RIGHT 2
|
|
|
|
typedef struct {
|
|
short xim, yim;
|
|
unsigned int *rect;
|
|
short xofs, yofs;
|
|
} uiIconImage;
|
|
|
|
typedef struct {
|
|
void *xl, *large, *medium, *small;
|
|
} uiFont;
|
|
|
|
typedef struct uiLinkLine { /* only for draw/edit */
|
|
struct uiLinkLine *next, *prev;
|
|
|
|
short flag, pad;
|
|
|
|
struct uiBut *from, *to;
|
|
} uiLinkLine;
|
|
|
|
typedef struct {
|
|
void **poin; /* pointer to original pointer */
|
|
void ***ppoin; /* pointer to original pointer-array */
|
|
short *totlink; /* if pointer-array, here is the total */
|
|
|
|
short maxlink, pad;
|
|
short fromcode, tocode;
|
|
|
|
ListBase lines;
|
|
} uiLink;
|
|
|
|
struct uiBut {
|
|
struct uiBut *next, *prev;
|
|
short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
|
|
int flag;
|
|
|
|
char *str;
|
|
char strdata[UI_MAX_NAME_STR];
|
|
char drawstr[UI_MAX_DRAW_STR];
|
|
|
|
float x1, y1, x2, y2;
|
|
|
|
char *poin;
|
|
float min, max;
|
|
float a1, a2, hsv[3]; // hsv is temp memory for hsv buttons
|
|
float aspect;
|
|
|
|
uiButHandleFunc func;
|
|
void *func_arg1;
|
|
void *func_arg2;
|
|
|
|
void (*embossfunc)(int , int , float, float, float, float, float, int);
|
|
void (*sliderfunc)(int , float, float, float, float, float, float, int);
|
|
|
|
uiButCompleteFunc autocomplete_func;
|
|
void *autofunc_arg;
|
|
|
|
uiLink *link;
|
|
|
|
char *tip, *lockstr;
|
|
|
|
int themecol; /* themecolor id */
|
|
void *font;
|
|
|
|
BIFIconID icon;
|
|
short but_align; /* aligning buttons, horiz/vertical */
|
|
short lock, win;
|
|
short iconadd, dt;
|
|
|
|
/* IDPOIN data */
|
|
uiIDPoinFuncFP idpoin_func;
|
|
ID **idpoin_idpp;
|
|
|
|
/* BLOCK data */
|
|
uiBlockCreateFunc block_create_func;
|
|
|
|
/* HMENU data */
|
|
uiMenuCreateFunc menu_create_func;
|
|
|
|
/* RNA data */
|
|
struct PointerRNA rnapoin;
|
|
struct PropertyRNA *rnaprop;
|
|
int rnaindex;
|
|
|
|
/* Operator data */
|
|
const char *opname;
|
|
int opcontext;
|
|
struct IDProperty *opproperties;
|
|
struct PointerRNA *opptr;
|
|
|
|
/* active button data */
|
|
struct uiHandleButtonData *active;
|
|
|
|
char *editstr;
|
|
double *editval;
|
|
float *editvec;
|
|
void *editcoba;
|
|
void *editcumap;
|
|
|
|
/* pointer back */
|
|
uiBlock *block;
|
|
};
|
|
|
|
struct uiBlock {
|
|
uiBlock *next, *prev;
|
|
|
|
ListBase buttons;
|
|
Panel *panel;
|
|
uiBlock *oldblock;
|
|
|
|
char name[UI_MAX_NAME_STR];
|
|
|
|
float winmat[4][4];
|
|
|
|
float minx, miny, maxx, maxy;
|
|
float aspect;
|
|
|
|
uiButHandleFunc func;
|
|
void *func_arg1;
|
|
void *func_arg2;
|
|
|
|
uiMenuHandleFunc butm_func;
|
|
void *butm_func_arg;
|
|
|
|
uiBlockHandleFunc handle_func;
|
|
void *handle_func_arg;
|
|
|
|
/* extra draw function for custom blocks */
|
|
void (*drawextra)();
|
|
|
|
int themecol; /* themecolor id */
|
|
|
|
short font; /* indices */
|
|
int afterval, flag;
|
|
void *curfont;
|
|
|
|
short autofill, win, winq, direction, dt;
|
|
short auto_open, in_use, pad;
|
|
double auto_open_last;
|
|
|
|
int lock;
|
|
char *lockstr;
|
|
|
|
float xofs, yofs; // offset to parent button
|
|
int bounds, dobounds; // for doing delayed
|
|
int endblock; // uiEndBlock done?
|
|
|
|
rctf safety; // pulldowns, to detect outside, can differ per case how it is created
|
|
ListBase saferct; // uiSafetyRct list
|
|
|
|
uiPopupBlockHandle *handle; // handle
|
|
int tooltipdisabled; // to avoid tooltip after click
|
|
|
|
int handler; // for panels in other windows than buttonswin... just event code
|
|
int active; // to keep blocks while drawing and free them afterwards
|
|
};
|
|
|
|
typedef struct uiSafetyRct {
|
|
struct uiSafetyRct *next, *prev;
|
|
rctf parent;
|
|
rctf safety;
|
|
} uiSafetyRct;
|
|
|
|
/* interface.c */
|
|
|
|
extern int ui_translate_buttons(void);
|
|
extern int ui_translate_menus(void);
|
|
extern int ui_translate_tooltips(void);
|
|
|
|
extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
|
|
extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
|
|
extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
|
|
extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
|
|
extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
|
|
extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
|
|
|
|
extern double ui_get_but_val(uiBut *but);
|
|
extern void ui_set_but_val(uiBut *but, double value);
|
|
extern void ui_set_but_hsv(uiBut *but);
|
|
extern void ui_get_but_vectorf(uiBut *but, float *vec);
|
|
extern void ui_set_but_vectorf(uiBut *but, float *vec);
|
|
extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
|
|
extern void ui_set_but_string(uiBut *but, const char *str);
|
|
|
|
extern void ui_check_but(uiBut *but);
|
|
extern void ui_autofill(uiBlock *block);
|
|
extern int ui_is_but_float(uiBut *but);
|
|
extern void ui_update_block_buts_hsv(uiBlock *block, float *hsv);
|
|
|
|
extern void ui_bounds_block(uiBlock *block);
|
|
|
|
/* interface_regions.c */
|
|
|
|
struct uiPopupBlockHandle {
|
|
/* internal */
|
|
struct ARegion *region;
|
|
int towardsx, towardsy;
|
|
double towardstime;
|
|
int dotowards;
|
|
|
|
int popup;
|
|
void (*popup_func)(struct bContext *C, void *arg, int event);
|
|
void *popup_arg;
|
|
/* for operator menus */
|
|
struct wmOperator *op_arg;
|
|
const char *propname;
|
|
|
|
/* return values */
|
|
int butretval;
|
|
int menuretval;
|
|
float retvalue;
|
|
float retvec[3];
|
|
};
|
|
|
|
uiBlock *ui_block_func_MENU(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
|
|
uiBlock *ui_block_func_ICONROW(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
|
|
uiBlock *ui_block_func_ICONTEXTROW(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
|
|
uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
|
|
|
|
struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
|
|
void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
|
|
|
|
typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
|
|
|
|
uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
|
|
uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
|
|
uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
|
|
uiMenuCreateFunc create_func, void *arg);
|
|
void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
|
|
|
|
void ui_set_name_menu(uiBut *but, int value);
|
|
|
|
/* interface_panel.c */
|
|
extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
|
|
extern void ui_draw_panel(struct ARegion *ar, uiBlock *block);
|
|
|
|
/* interface_draw.c */
|
|
extern void ui_set_embossfunc(uiBut *but, int drawtype);
|
|
extern void ui_draw_but(uiBut *but);
|
|
extern void ui_rasterpos_safe(float x, float y, float aspect);
|
|
extern void ui_draw_tria_icon(float x, float y, float aspect, char dir);
|
|
extern void ui_draw_anti_x(float x1, float y1, float x2, float y2);
|
|
extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
|
|
|
|
extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
|
|
extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
|
|
extern void gl_round_box_vertical_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
|
|
|
|
/* interface_handlers.c */
|
|
extern void ui_button_active_cancel(const struct bContext *C, uiBut *but);
|
|
|
|
#endif
|
|
|