Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
CGUIDummyObject.h
Go to the documentation of this file.
1/* Copyright (C) 2021 Wildfire Games.
2 * This file is part of 0 A.D.
3 *
4 * 0 A.D. is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18/*
19 * This is the top class of the whole GUI, all objects
20 * and settings are stored within this class.
21 */
22
23#ifndef INCLUDED_CGUIDUMMYOBJECT
24#define INCLUDED_CGUIDUMMYOBJECT
25
27
28/**
29 * Dummy object are used for the base object and objects of type "empty".
30 */
32{
34
35public:
37
38 virtual void Draw(CCanvas2D& UNUSED(canvas)) {}
39
40 /**
41 * Empty can never be hovered. It is only a category.
42 */
43 virtual bool IsMouseOver() const
44 {
45 return false;
46 }
47};
48
49#endif // INCLUDED_CGUIDUMMYOBJECT
#define GUI_OBJECT(obj)
Definition: IGUIObject.h:50
Definition: Canvas2D.h:36
Dummy object are used for the base object and objects of type "empty".
Definition: CGUIDummyObject.h:32
virtual void Draw(CCanvas2D &canvas)
Draws the object.
Definition: CGUIDummyObject.h:38
virtual bool IsMouseOver() const
Empty can never be hovered.
Definition: CGUIDummyObject.h:43
CGUIDummyObject(CGUI &pGUI)
Definition: CGUIDummyObject.h:36
The main object that represents a whole GUI page.
Definition: CGUI.h:61
GUI object such as a button or an input-box.
Definition: IGUIObject.h:60
#define UNUSED(param)
mark a function parameter as unused and avoid the corresponding compiler warning.
Definition: code_annotation.h:40