guiSeparatorCtrl.h

Public Functions

DefineEnumType(GuiSeparatorType )

 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 _GUISEPARATORCTRL_H_
24#define _GUISEPARATORCTRL_H_
25
26#ifndef _GUICONTROL_H_
27   #include "gui/core/guiControl.h"
28#endif
29#ifndef _DYNAMIC_CONSOLETYPES_H_
30   #include "console/dynamicTypes.h"
31#endif
32
33
34/// Renders a separator line with optional text.
35class GuiSeparatorCtrl : public GuiControl
36{
37private:
38   typedef GuiControl Parent;
39
40public:
41   bool  mInvisible;
42   String mText;
43   S32   mTextLeftMargin;
44   S32   mMargin;
45   S32   mSeparatorType;
46
47   enum separatorTypeOptions
48   {
49      separatorTypeVertical = 0, ///< Draw Vertical Separator
50      separatorTypeHorizontal    ///< Horizontal Separator
51   };
52
53   //creation methods
54   DECLARE_CONOBJECT(GuiSeparatorCtrl);
55   DECLARE_CATEGORY( "Gui Other" );
56   DECLARE_DESCRIPTION( "A control that renders a horizontal or vertical separator with\n"
57      "an optional text label (horizontal only). ");
58   GuiSeparatorCtrl();
59
60   static void initPersistFields();
61
62   void onRender(Point2I offset, const RectI &updateRect);
63};
64
65typedef GuiSeparatorCtrl::separatorTypeOptions GuiSeparatorType;
66DefineEnumType( GuiSeparatorType );
67
68#endif
69