ScummVM API documentation
WidgetFrame.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program 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 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22/*
23 * Copyright (C) 2006-2010 - Frictional Games
24 *
25 * This file is part of HPL1 Engine.
26 */
27
28#ifndef HPL_WIDGET_FRAME_H
29#define HPL_WIDGET_FRAME_H
30
31#include "hpl1/engine/gui/Widget.h"
32
33namespace hpl {
34
35class cGuiSkinFont;
36
37class cWidgetFrame : public iWidget {
38public:
39 cWidgetFrame(cGuiSet *apSet, cGuiSkin *apSkin);
40 virtual ~cWidgetFrame();
41
42 void SetDrawFrame(bool abX) { mbDrawFrame = abX; }
43 bool GetDrawFrame() { return mbDrawFrame; }
44
45 void SetDrawBackground(bool abX) { mbDrawBackground = abX; }
46 bool GetDrawBackground() { return mbDrawBackground; }
47
48 void SetBackgroundZ(float afZ) { mfBackgroundZ = afZ; }
49 float GetBackgroundZ() { return mfBackgroundZ; }
50
51 void SetBackGroundColor(const cColor &aColor) { mBackGroundColor = aColor; }
52 const cColor &GetBackGroundColor() { return mBackGroundColor; }
53
54protected:
56 // Implemented functions
57 void OnLoadGraphics();
58
59 void OnDraw(float afTimeStep, cGuiClipRegion *apClipRegion);
60 void OnDrawAfterClip(float afTimeStep, cGuiClipRegion *apClipRegion);
61
62 bool OnMouseMove(cGuiMessageData &aData);
63 bool OnMouseDown(cGuiMessageData &aData);
64 bool OnMouseUp(cGuiMessageData &aData);
65 bool OnMouseEnter(cGuiMessageData &aData);
66 bool OnMouseLeave(cGuiMessageData &aData);
67
69 // Data
70 bool mbDrawFrame;
71 bool mbDrawBackground;
72 float mfBackgroundZ;
73 cColor mBackGroundColor;
74
75 cGuiGfxElement *mpGfxBackground;
76
77 cGuiGfxElement *mvGfxBorders[4];
78 cGuiGfxElement *mvGfxCorners[4];
79};
80
81} // namespace hpl
82
83#endif // HPL_WIDGET_FRAME_H
Definition: Color.h:37
Definition: GuiSet.h:96
Definition: GuiGfxElement.h:72
Definition: GuiSet.h:112
Definition: GuiSkin.h:59
Definition: WidgetFrame.h:37
Definition: Widget.h:65
Definition: GuiTypes.h:263