Merge branch 'q3map2help' into 'master'
[xonotic/netradiant.git] / include / itoolbar.h
1 /*
2    Copyright (C) 1999-2006 Id Software, Inc. and contributors.
3    For a list of contributors, see the accompanying CONTRIBUTORS file.
4
5    This file is part of GtkRadiant.
6
7    GtkRadiant is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    GtkRadiant is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with GtkRadiant; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #if !defined( INCLUDED_IPLUGTOOLBAR_H )
23 #define INCLUDED_IPLUGTOOLBAR_H
24
25 #include <cstddef>
26 #include "generic/constant.h"
27
28 class IToolbarButton
29 {
30 public:
31 enum EType
32 {
33         eSpace,
34         eButton,
35         eToggleButton,
36 };
37
38 virtual const char* getImage() const = 0;
39 virtual const char* getText() const = 0;
40 virtual const char* getTooltip() const = 0;
41 virtual EType getType() const = 0;
42 virtual void activate() const = 0;
43 };
44
45 typedef std::size_t ( *PFN_TOOLBARBUTTONCOUNT )();
46 typedef const IToolbarButton* ( *PFN_GETTOOLBARBUTTON )( std::size_t index );
47
48 struct _QERPlugToolbarTable
49 {
50         INTEGER_CONSTANT( Version, 1 );
51         STRING_CONSTANT( Name, "toolbar" );
52
53         PFN_TOOLBARBUTTONCOUNT m_pfnToolbarButtonCount;
54         PFN_GETTOOLBARBUTTON m_pfnGetToolbarButton;
55 };
56
57 template<typename Type>
58 class Modules;
59 typedef Modules<_QERPlugToolbarTable> ToolbarModules;
60
61 template<typename Type>
62 class ModulesRef;
63 typedef ModulesRef<_QERPlugToolbarTable> ToolbarModulesRef;
64
65 #endif