doxygen: add newline after \file
[blender.git] / source / blender / editors / include / ED_gizmo_utils.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup editors
19  *
20  * \name Generic Gizmo Utilities.
21  */
22
23 #ifndef __ED_GIZMO_UTILS_H__
24 #define __ED_GIZMO_UTILS_H__
25
26 struct bContext;
27 struct wmGizmoGroupType;
28
29 /** Wrapper function (operator name can't be guessed). */
30 bool ED_gizmo_poll_or_unlink_delayed_from_operator(
31         const struct bContext *C, struct wmGizmoGroupType *gzgt,
32         const char *idname);
33
34 bool ED_gizmo_poll_or_unlink_delayed_from_tool_ex(
35         const struct bContext *C, struct wmGizmoGroupType *gzgt,
36         const char *gzgt_idname);
37
38 /** Use this as poll function directly for: #wmGizmoGroupType.poll */
39 bool ED_gizmo_poll_or_unlink_delayed_from_tool(
40         const struct bContext *C, struct wmGizmoGroupType *gzgt);
41
42 #endif  /* __ED_GIZMO_UTILS_H__ */