Mercurial > fife-parpg

comparison ext/guichan-0.8.2/include/guichan/widgets/label.hpp @ 378:64738befdf3b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children
comparison
equal deleted inserted replaced
377:fe6fb0e0ed23 378:64738befdf3b
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_LABEL_HPP
45 #define GCN_LABEL_HPP
46
47 #include <string>
48
49 #include "guichan/graphics.hpp"
50 #include "guichan/platform.hpp"
51 #include "guichan/widget.hpp"
52
53 namespace gcn
54 {
55 /**
56 * Implementation of a label capable of displaying a caption.
57 */
58 class GCN_CORE_DECLSPEC Label: public Widget
59 {
60 public:
61 /**
62 * Constructor.
63 */
64 Label();
65
66 /**
67 * Constructor. The label will be automatically resized
68 * to fit the caption.
69 *
70 * @param caption The caption of the label.
71 */
72 Label(const std::string& caption);
73
74 /**
75 * Gets the caption of the label.
76 *
77 * @return The caption of the label.
78 * @see setCaption
79 */
80 const std::string &getCaption() const;
81
82 /**
83 * Sets the caption of the label. It's advisable to call
84 * adjustSize after setting of the caption to adjust the
85 * label's size to fit the caption.
86 *
87 * @param caption The caption of the label.
88 * @see getCaption, adjustSize
89 */
90 void setCaption(const std::string& caption);
91
92 /**
93 * Sets the alignment of the caption. The alignment is relative
94 * to the center of the label.
95 *
96 * @param alignemnt The alignment of the caption of the label.
97 * @see getAlignment, Graphics
98 */
99 void setAlignment(Graphics::Alignment alignment);
100
101 /**
102 * Gets the alignment of the caption. The alignment is relative to
103 * the center of the label.
104 *
105 * @return The alignment of caption of the label.
106 * @see setAlignmentm Graphics
107 */
108 Graphics::Alignment getAlignment() const;
109
110 /**
111 * Adjusts the label's size to fit the caption.
112 */
113 void adjustSize();
114
115
116 // Inherited from Widget
117
118 virtual void draw(Graphics* graphics);
119
120 protected:
121 /**
122 * Holds the caption of the label.
123 */
124 std::string mCaption;
125
126 /**
127 * Holds the alignment of the caption.
128 */
129 Graphics::Alignment mAlignment;
130 };
131 }
132
133 #endif // end GCN_LABEL_HPP