guiRadioCtrl.h

Engine/source/gui/buttons/guiRadioCtrl.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
24#ifndef _GUIRADIOCTRL_H_
25#define _GUIRADIOCTRL_H_
26
27#ifndef _GUICHECKBOXCTRLL_H_
28#include "gui/buttons/guiCheckBoxCtrl.h"
29#endif
30
31// the radio button renders exactly the same as the check box
32// the only difference is it sends messages to its siblings to
33// turn themselves off.
34
35class GuiRadioCtrl : public GuiCheckBoxCtrl
36{
37   typedef GuiCheckBoxCtrl Parent;
38
39public:
40   DECLARE_CONOBJECT(GuiRadioCtrl);
41   DECLARE_DESCRIPTION( "A button control with a radio box and a text label.\n"
42                        "This control is used in groups where multiple radio buttons\n"
43                        "present a range of options out of which one can be chosen.\n"
44                        "A radio button automatically signals its siblings when it is\n"
45                        "toggled on." );
46   GuiRadioCtrl();
47};
48
49#endif //_GUI_RADIO_CTRL_H
50