Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/widgets/tab.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_TAB_HPP
45 #define GCN_TAB_HPP
46
47 #include <map>
48 #include <string>
49
50 #include "guichan/basiccontainer.hpp"
51 #include "guichan/mouselistener.hpp"
52 #include "guichan/platform.hpp"
53
54 namespace gcn
55 {
56 class Label;
57 class TabbedArea;
58
59 /**
60 * An implementation of a simple tab to be used in a tabbed area.
61 *
62 * @see TabbedArea
63 */
64 class GCN_CORE_DECLSPEC Tab:
65 public BasicContainer,
66 public MouseListener
67 {
68 public:
69
70 /**
71 * Constructor.
72 */
73 Tab();
74
75 /**
76 * Destructor.
77 */
78 virtual ~Tab();
79
80 /**
81 * Adjusts the size of the tab fit the caption.
82 */
83 void adjustSize();
84
85 /**
86 * Sets the tabbed area the tab should be a part of.
87 *
88 * @param tabbedArea The tabbed area the tab should be a part of.
89 * @see getTabbedArea
90 */
91 void setTabbedArea(TabbedArea* tabbedArea);
92
93 /**
94 * Gets the tabbed are the tab is a part of.
95 *
96 * @return The tabbed are the tab is a part of.
97 * @see setTabbedArea
98 */
99 TabbedArea* getTabbedArea();
100
101 /**
102 * Sets the caption of the tab. It's advisable to call
103 * adjustSize after setting the caption to make the tab
104 * fit the caption.
105 *
106 * @param caption The caption of the tab.
107 * @see getCaption, adjustSize
108 */
109 void setCaption(const std::string& caption);
110
111 /**
112 * Gets the caption of the tab.
113 *
114 * @return The caption of the tab.
115 * @see setCaption
116 */
117 const std::string& getCaption() const;
118
119
120 // Inherited from Widget
121
122 virtual void draw(Graphics *graphics);
123
124
125 // Inherited from MouseListener
126
127 virtual void mouseEntered(MouseEvent& mouseEvent);
128
129 virtual void mouseExited(MouseEvent& mouseEvent);
130
131 protected:
132 /**
133 * Holds the label of the tab.
134 */
135 Label* mLabel;
136
137 /**
138 * True if the tab has the mouse, false otherwise.
139 */
140 bool mHasMouse;
141
142 /**
143 * Holds the tabbed area the tab is a part of.
144 */
145 TabbedArea* mTabbedArea;
146 };
147 }
148
149 #endif // end GCN_TABBEDAREA_HPP