guiPanel.h

Engine/source/gui/containers/guiPanel.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23#ifndef _GUI_PANEL_H_
24#define _GUI_PANEL_H_
25
26#ifndef _GUICONTROL_H_
27#include "gui/core/guiControl.h"
28#endif
29#ifndef _GUITICKCTRL_H_
30#include "gui/shiny/guiTickCtrl.h"
31#endif
32#ifndef _GUICONTAINER_H_
33#include "gui/containers/guiContainer.h"
34#endif
35
36
37/// The GuiPanel panel is a container that when opaque will
38/// draw a left to right gradient using its profile fill and
39/// fill highlight colors.
40///
41/// @addtogroup gui_container_group Containers
42///
43/// @ingroup gui_group Gui System
44/// @{
45class GuiPanel : public GuiContainer
46{
47private:
48   typedef GuiContainer Parent;
49
50public:
51   // Constructor/Destructor/ConObject Declaration
52   GuiPanel();
53   virtual ~GuiPanel();
54
55   DECLARE_CONOBJECT(GuiPanel);
56
57   // GuiControl
58   void onRender(Point2I offset, const RectI &updateRect);
59   void setVisible(bool value) { Parent::setVisible(value); setUpdateLayout( updateParent ); }
60};
61/// @}
62
63#endif // _GUI_PANEL_H_
64