1 /*      _______   __   __   __   ______   __   __   _______   __   __
2  *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
3  *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4  *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
5  *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
6  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8  *
9  * Copyright (c) 2004, 2005 darkbits                        Js_./
10  * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
11  * Olof Naess�n a.k.a jansem/yakslem                _asww7!uY`>  )\a//
12  *                                                 _Qhm`] _f "'c  1!5m
13  * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
14  *                                               .)j(] .d_/ '-(  P .   S
15  * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
16  * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
17  * binary forms, with or without                 )4d[#7r, .   '     )d`)[
18  * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
19  * that the following conditions are met:       j<<WP+k/);.        _W=j f
20  * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
21  *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
22  *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
23  *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
24  * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
25  *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
26  *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
27  *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
28  *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
29  *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
30  * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
31  *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
32  *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
33  *    from this software without specific        (js, \[QQW$QWW#?!V"".
34  *    prior written permission.                    ]y:.<\..          .
35  *                                                 -]n w/ '         [.
36  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
37  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
38  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
39  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
40  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
41  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
42  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
43  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
44  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
45  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
46  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
49  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
50  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
51  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
52  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53  */
54 
55 #ifndef GCN_CHECKBOX_HPP
56 #define GCN_CHECKBOX_HPP
57 
58 #include <string>
59 
60 #include "guichan/keylistener.h"
61 #include "guichan/mouselistener.h"
62 #include "guichan/platform.h"
63 #include "guichan/widget.h"
64 
65 namespace gcn
66 {
67     /**
68      * A regular CheckBox. It can be checked and unchecked.
69      */
70     class GCN_CORE_DECLSPEC CheckBox :
71         public Widget,
72         public MouseListener,
73         public KeyListener
74     {
75     public:
76 
77         /**
78          * Contructor.
79          */
80         CheckBox();
81 
82         /**
83          * Constructor.
84          *
85          * @param caption the CheckBox caption.
86          * @param marked true if the CheckBox should be marked.
87          */
88         CheckBox(const std::string &caption, bool marked=false);
89 
90         /**
91          * Destructor.
92          */
~CheckBox()93         virtual ~CheckBox() { }
94 
95         /**
96          * Draws the box i.a not the caption.
97          *
98          * @param graphics a Graphics object to draw with.
99          */
100         virtual void drawBox(Graphics *graphics);
101 
102         /**
103          * Checks if the CheckBox is marked.
104          *
105          * @return true if the CheckBox is marked.
106          */
107         virtual bool isMarked() const;
108 
109         /**
110          * Sets the CheckBox to be marked.
111          *
112          * @param marked true if the CheckBox should be marked.
113          */
114         virtual void setMarked(bool marked);
115 
116         /**
117          * Gets the CheckBox caption.
118          *
119          * @return the CheckBox caption.
120          */
121         virtual const std::string &getCaption() const;
122 
123         /**
124          * Sets the CheckBox caption.
125          *
126          * @param caption the CheckBox caption.
127          */
128         virtual void setCaption(const std::string &caption);
129 
130         /**
131          * Adjusts the CheckBox size to fit the font size.
132          */
133         virtual void adjustSize();
134 
135 
136         // Inherited from Widget
137 
138         virtual void draw(Graphics* graphics);
139 
140         virtual void drawBorder(Graphics* graphics);
141 
142 
143         // Inherited from KeyListener
144 
145         virtual bool keyPress(const Key& key);
146 
147 
148         // Inherited from MouseListener
149 
150         virtual void mouseClick(int x, int y, int button, int count);
151 
152 
153     protected:
154         /**
155          * Toggles between marked and unmarked.
156          */
157         virtual void toggle();
158 
159         bool mMarked;
160         std::string mCaption;
161     };
162 }
163 
164 #endif // end GCN_CHECKBOX_HPP
165