code cleanup: use const events for modal and invoke operators.
[blender.git] / source / blender / editors / include / ED_numinput.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): none yet.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file ED_numinput.h
24  *  \ingroup editors
25  */
26
27 #ifndef __ED_NUMINPUT_H__
28 #define __ED_NUMINPUT_H__
29
30
31 /*
32  *  The ctrl value has different meaning:
33  *      0           : No value has been typed
34  *
35  *      otherwise, |value| - 1 is where the cursor is located after the period
36  *      Positive    : number is positive
37  *      Negative    : number is negative
38  */
39
40 typedef struct NumInput {
41         short  idx;
42         short  idx_max;
43         short  flag;        /* Different flags to indicate different behaviors                                */
44         char   inv[3];      /* If the value is inverted or not                                                */
45         float  val[3];      /* Direct value of the input                                                      */
46         int    ctrl[3];     /* Control to indicate what to do with the numbers that are typed                 */
47         float  increment;
48 } NumInput;
49
50 /* NUMINPUT FLAGS */
51 #define NUM_NULL_ONE        2
52 #define NUM_NO_NEGATIVE     4
53 #define NUM_NO_ZERO         8
54 #define NUM_NO_FRACTION     16
55 #define NUM_AFFECT_ALL      32
56
57 /*********************** NumInput ********************************/
58
59 void initNumInput(NumInput *n);
60 #define NUM_STR_REP_LEN 20 /* str must be NUM_STR_LEN * (idx_max + 1) length. */
61 void outputNumInput(NumInput *n, char *str);
62 short hasNumInput(NumInput *n);
63 void applyNumInput(NumInput *n, float *vec);
64 char handleNumInput(NumInput *n, const struct wmEvent *event);
65
66 #define NUM_MODAL_INCREMENT_UP   18
67 #define NUM_MODAL_INCREMENT_DOWN 19
68
69 #endif