5d6d03ece6052a18f4bfbf4b4223e1f180b2eae0
[blender.git] / source / blender / editors / interface / interface_query.c
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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/editors/interface/interface_query.c
22  *  \ingroup edinterface
23  *
24  * Utilities to inspect the interface, extract information.
25  */
26
27 #include "BLI_utildefines.h"
28
29 #include "DNA_screen_types.h"
30
31 #include "UI_interface.h"
32
33 #include "interface_intern.h"
34
35 /* -------------------------------------------------------------------- */
36 /** \name Button (uiBut)
37  * \{ */
38
39 bool ui_but_is_editable(const uiBut *but)
40 {
41         return !ELEM(but->type,
42                      UI_BTYPE_LABEL, UI_BTYPE_SEPR, UI_BTYPE_SEPR_LINE,
43                      UI_BTYPE_ROUNDBOX, UI_BTYPE_LISTBOX, UI_BTYPE_PROGRESS_BAR);
44 }
45
46 bool ui_but_is_editable_as_text(const uiBut *but)
47 {
48         return  ELEM(but->type,
49                      UI_BTYPE_TEXT, UI_BTYPE_NUM, UI_BTYPE_NUM_SLIDER,
50                      UI_BTYPE_SEARCH_MENU);
51
52 }
53
54 bool ui_but_is_toggle(const uiBut *but)
55 {
56         return ELEM(
57                 but->type,
58                 UI_BTYPE_BUT_TOGGLE,
59                 UI_BTYPE_TOGGLE,
60                 UI_BTYPE_ICON_TOGGLE,
61                 UI_BTYPE_ICON_TOGGLE_N,
62                 UI_BTYPE_TOGGLE_N,
63                 UI_BTYPE_CHECKBOX,
64                 UI_BTYPE_CHECKBOX_N,
65                 UI_BTYPE_ROW
66         );
67 }
68
69 /** \} */
70
71 /* -------------------------------------------------------------------- */
72 /** \name Block (uiBlock)
73  * \{ */
74
75 bool ui_block_is_menu(const uiBlock *block)
76 {
77         return (((block->flag & UI_BLOCK_LOOP) != 0) &&
78                 /* non-menu popups use keep-open, so check this is off */
79                 ((block->flag & UI_BLOCK_KEEP_OPEN) == 0));
80 }
81
82 bool ui_block_is_pie_menu(const uiBlock *block)
83 {
84         return ((block->flag & UI_BLOCK_RADIAL) != 0);
85 }
86
87 bool UI_block_is_empty(const uiBlock *block)
88 {
89         for (const uiBut *but = block->buttons.first; but; but = but->next) {
90                 if (!ELEM(but->type, UI_BTYPE_SEPR, UI_BTYPE_SEPR_LINE)) {
91                         return false;
92                 }
93         }
94         return true;
95 }
96
97 /** \} */