guiRadioCtrl.cpp

Public Functions

ConsoleDocClass(GuiRadioCtrl )

IMPLEMENT_CONOBJECT(GuiRadioCtrl )

Public Functions

ConsoleDocClass(GuiRadioCtrl )

IMPLEMENT_CONOBJECT(GuiRadioCtrl )

 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#include "gui/buttons/guiRadioCtrl.h"
25
26#include "console/console.h"
27#include "console/consoleTypes.h"
28#include "console/engineAPI.h"
29#include "gfx/gfxDevice.h"
30#include "gui/core/guiCanvas.h"
31
32IMPLEMENT_CONOBJECT(GuiRadioCtrl);
33
34ConsoleDocClass( GuiRadioCtrl,
35   "@brief A button based around the radio concept.\n\n"
36   
37   "GuiRadioCtrl's functionality is based around GuiButtonBaseCtrl's ButtonTypeRadio type.\n\n"
38
39   "A button control with a radio box and a text label.\n"
40   "This control is used in groups where multiple radio buttons\n"
41   "present a range of options out of which one can be chosen.\n"
42   "A radio button automatically signals its siblings when it is\n"
43   "toggled on.\n\n"
44   
45   "@tsexample\n"
46   "// Create a GuiCheckBoxCtrl that calls randomFunction with its current value when clicked.\n"
47   "%radio = new GuiRadioCtrl()\n"
48   "{\n"
49   "   profile = \"GuiRadioProfile\";\n"
50   "};\n"
51   "@endtsexample\n\n"
52   
53   "@ingroup GuiButtons"
54);
55
56//-----------------------------------------------------------------------------
57
58GuiRadioCtrl::GuiRadioCtrl()
59{
60   mButtonType = ButtonTypeRadio;
61}
62
63