Engine directory for ticket #1

Engine/source/gui/buttons/guiRadioCtrl.h

@@ -0,0 +1,48 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifndef _GUIRADIOCTRL_H_
+#define _GUIRADIOCTRL_H_
+
+#ifndef _GUICHECKBOXCTRLL_H_
+#include "gui/buttons/guiCheckBoxCtrl.h"
+#endif
+
+// the radio button renders exactly the same as the check box
+// the only difference is it sends messages to its siblings to
+// turn themselves off.
+
+class GuiRadioCtrl : public GuiCheckBoxCtrl
+{
+   typedef GuiCheckBoxCtrl Parent;
+
+public:
+   DECLARE_CONOBJECT(GuiRadioCtrl);
+   DECLARE_DESCRIPTION( "A button control with a radio box and a text label.\n"
+                        "This control is used in groups where multiple radio buttons\n"
+                        "present a range of options out of which one can be chosen.\n"
+                        "A radio button automatically signals its siblings when it is\n"
+                        "toggled on." );
+   GuiRadioCtrl();
+};
+
+#endif //_GUI_RADIO_CTRL_H