Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/widgets/imagebutton.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_IMAGEBUTTON_HPP
45 #define GCN_IMAGEBUTTON_HPP
46
47 #include "guichan/platform.hpp"
48 #include "guichan/widgets/button.hpp"
49
50 namespace gcn
51 {
52 class Image;
53
54 /**
55 * An implementation of a regular clickable button. Unlike a normal button an image
56 * button is capable of displaying an image instead of a simple text caption.
57 * Whenever an image button is clicked an action event will be sent to the action
58 * listener's of the image button.
59 *
60 * @see Button
61 */
62 class GCN_CORE_DECLSPEC ImageButton : public gcn::Button
63 {
64 public:
65 /**
66 * Default constructor.
67 */
68 ImageButton();
69
70 /**
71 * Constructor.
72 *
73 * @param filename The filename of the image to display.
74 */
75 ImageButton(const std::string& filename);
76
77 /**
78 * Constructor.
79 *
80 * @param image The image to display.
81 */
82 ImageButton(const Image* image);
83
84 /**
85 * Destructor.
86 */
87 virtual ~ImageButton();
88
89 /**
90 * Sets the image to display. Existing Image is freed automatically,
91 * if it was loaded internally.
92 *
93 * @param image The image to display.
94 */
95 void setImage(const Image* image);
96
97 /**
98 * Gets current image.
99 *
100 * @return The current image.
101 */
102 const Image* getImage() const;
103
104
105 // Inherited from Widget
106
107 void draw(gcn::Graphics* graphics);
108
109 protected:
110 /**
111 * The image to display.
112 */
113 const Image* mImage;
114
115 /**
116 * True if the image has been loaded internally, false otherwise.
117 * An image not loaded internally should not be deleted in the
118 * destructor.
119 */
120 bool mInternalImage;
121 };
122 }
123 #endif