Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/widgets/checkbox.hpp @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_CHECKBOX_HPP
45 #define GCN_CHECKBOX_HPP
46
47 #include <string>
48
49 #include "guichan/keylistener.hpp"
50 #include "guichan/mouselistener.hpp"
51 #include "guichan/platform.hpp"
52 #include "guichan/widget.hpp"
53
54 namespace gcn
55 {
56 /**
57 * An implementation of a check box where a user can select or deselect
58 * the check box and where the status of the check box is displayed to the user.
59 * A check box is capable of displaying a caption.
60 *
61 * If a check box's state changes an action event will be sent to all action
62 * listeners of the check box.
63 */
64 class GCN_CORE_DECLSPEC CheckBox :
65 public Widget,
66 public MouseListener,
67 public KeyListener
68 {
69 public:
70
71 /**
72 * Contructor.
73 */
74 CheckBox();
75
76 /**
77 * Constructor. The check box will be automatically resized
78 * to fit the caption.
79 *
80 * @param caption The caption of the check box.
81 * @param marked True if the check box is selected, false otherwise.
82 */
83 CheckBox(const std::string &caption, bool selected = false);
84
85 /**
86 * Destructor.
87 */
88 virtual ~CheckBox() { }
89
90 /**
91 * Checks if the check box is selected.
92 *
93 * @return True if the check box is selected, false otherwise.
94 * @see setSelected
95 */
96 bool isSelected() const;
97
98 /**
99 * Sets the check box to be selected or not.
100 *
101 * @param selected True if the check box should be set as selected.
102 * @see isSelected
103 */
104 void setSelected(bool selected);
105
106 /**
107 * Gets the caption of the check box.
108 *
109 * @return The caption of the check box.
110 * @see setCaption
111 */
112 const std::string &getCaption() const;
113
114 /**
115 * Sets the caption of the check box. It's advisable to call
116 * adjustSize after setting of the caption to adjust the
117 * check box's size to fit the caption.
118 *
119 * @param caption The caption of the check box.
120 * @see getCaption, adjustSize
121 */
122 void setCaption(const std::string& caption);
123
124 /**
125 * Adjusts the check box's size to fit the caption.
126 */
127 void adjustSize();
128
129
130 // Inherited from Widget
131
132 virtual void draw(Graphics* graphics);
133
134
135 // Inherited from KeyListener
136
137 virtual void keyPressed(KeyEvent& keyEvent);
138
139
140 // Inherited from MouseListener
141
142 virtual void mouseClicked(MouseEvent& mouseEvent);
143
144 virtual void mouseDragged(MouseEvent& mouseEvent);
145
146
147 protected:
148 /**
149 * Draws the box of the check box.
150 *
151 * @param graphics A Graphics object to draw with.
152 */
153 virtual void drawBox(Graphics *graphics);
154
155 /**
156 * Toggles the check box between being selected and
157 * not being selected.
158 */
159 virtual void toggleSelected();
160
161 /**
162 * True if the check box is selected, false otherwise.
163 */
164 bool mSelected;
165
166 /**
167 * Holds the caption of the check box.
168 */
169 std::string mCaption;
170 };
171 }
172
173 #endif // end GCN_CHECKBOX_HPP