1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
\r
2 // This file is part of the "Irrlicht Engine".
\r
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
\r
7 #include "IrrCompileConfig.h"
\r
9 #include "IGUIButton.h"
\r
10 #include "IGUISpriteBank.h"
\r
11 #include "ITexture.h"
\r
13 #include "guiSkin.h"
\r
15 using namespace irr;
\r
17 #if (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR <= 8)
\r
18 namespace irr { namespace gui {
\r
20 //! State of buttons used for drawing texture images.
\r
21 //! Note that only a single state is active at a time
\r
22 //! Also when no image is defined for a state it will use images from another state
\r
23 //! and if that state is not set from the replacement for that,etc.
\r
24 //! So in many cases setting EGBIS_IMAGE_UP and EGBIS_IMAGE_DOWN is sufficient.
\r
25 enum EGUI_BUTTON_IMAGE_STATE {
\r
26 //! When no other states have images they will all use this one.
\r
28 //! When not set EGBIS_IMAGE_UP is used.
\r
29 EGBIS_IMAGE_UP_MOUSEOVER,
\r
30 //! When not set EGBIS_IMAGE_UP_MOUSEOVER is used.
\r
31 EGBIS_IMAGE_UP_FOCUSED,
\r
32 //! When not set EGBIS_IMAGE_UP_FOCUSED is used.
\r
33 EGBIS_IMAGE_UP_FOCUSED_MOUSEOVER,
\r
34 //! When not set EGBIS_IMAGE_UP is used.
\r
36 //! When not set EGBIS_IMAGE_DOWN is used.
\r
37 EGBIS_IMAGE_DOWN_MOUSEOVER,
\r
38 //! When not set EGBIS_IMAGE_DOWN_MOUSEOVER is used.
\r
39 EGBIS_IMAGE_DOWN_FOCUSED,
\r
40 //! When not set EGBIS_IMAGE_DOWN_FOCUSED is used.
\r
41 EGBIS_IMAGE_DOWN_FOCUSED_MOUSEOVER,
\r
42 //! When not set EGBIS_IMAGE_UP or EGBIS_IMAGE_DOWN are used (depending on button state).
\r
43 EGBIS_IMAGE_DISABLED,
\r
44 //! not used, counts the number of enumerated items
\r
48 //! Names for gui button image states
\r
49 const c8 *const GUIButtonImageStateNames[EGBIS_COUNT + 1] =
\r
51 "Image", // not "ImageUp" as it otherwise breaks serialization of old files
\r
54 "ImageUpFocusedOver",
\r
55 "PressedImage", // not "ImageDown" as it otherwise breaks serialization of old files
\r
58 "ImageDownFocusedOver",
\r
67 class GUIButton : public gui::IGUIButton
\r
72 GUIButton(gui::IGUIEnvironment* environment, gui::IGUIElement* parent,
\r
73 s32 id, core::rect<s32> rectangle, bool noclip=false);
\r
76 virtual ~GUIButton();
\r
78 //! called if an event happened.
\r
79 virtual bool OnEvent(const SEvent& event) override;
\r
81 //! draws the element and its children
\r
82 virtual void draw() override;
\r
84 //! sets another skin independent font. if this is set to zero, the button uses the font of the skin.
\r
85 virtual void setOverrideFont(gui::IGUIFont* font=0) override;
\r
87 //! Gets the override font (if any)
\r
88 virtual gui::IGUIFont* getOverrideFont() const override;
\r
90 //! Get the font which is used right now for drawing
\r
91 virtual gui::IGUIFont* getActiveFont() const override;
\r
93 //! Sets another color for the button text.
\r
94 virtual void setOverrideColor(video::SColor color);
\r
96 //! Gets the override color
\r
97 virtual video::SColor getOverrideColor(void) const;
\r
99 //! Sets if the button text should use the override color or the color in the gui skin.
\r
100 virtual void enableOverrideColor(bool enable);
\r
102 //! Checks if an override color is enabled
\r
103 virtual bool isOverrideColorEnabled(void) const;
\r
105 //! Sets an image which should be displayed on the button when it is in the given state.
\r
106 virtual void setImage(gui::EGUI_BUTTON_IMAGE_STATE state,
\r
107 video::ITexture* image=0,
\r
108 const core::rect<s32>& sourceRect=core::rect<s32>(0,0,0,0));
\r
110 //! Sets an image which should be displayed on the button when it is in normal state.
\r
111 virtual void setImage(video::ITexture* image=0) override
\r
113 setImage(gui::EGBIS_IMAGE_UP, image);
\r
116 //! Sets an image which should be displayed on the button when it is in normal state.
\r
117 virtual void setImage(video::ITexture* image, const core::rect<s32>& pos) override
\r
119 setImage(gui::EGBIS_IMAGE_UP, image, pos);
\r
122 //! Sets an image which should be displayed on the button when it is in pressed state.
\r
123 virtual void setPressedImage(video::ITexture* image=0) override
\r
125 setImage(gui::EGBIS_IMAGE_DOWN, image);
\r
128 //! Sets an image which should be displayed on the button when it is in pressed state.
\r
129 virtual void setPressedImage(video::ITexture* image, const core::rect<s32>& pos) override
\r
131 setImage(gui::EGBIS_IMAGE_DOWN, image, pos);
\r
134 //! Sets the sprite bank used by the button
\r
135 virtual void setSpriteBank(gui::IGUISpriteBank* bank=0) override;
\r
137 //! Sets the animated sprite for a specific button state
\r
138 /** \param index: Number of the sprite within the sprite bank, use -1 for no sprite
\r
139 \param state: State of the button to set the sprite for
\r
140 \param index: The sprite number from the current sprite bank
\r
141 \param color: The color of the sprite
\r
143 virtual void setSprite(gui::EGUI_BUTTON_STATE state, s32 index,
\r
144 video::SColor color=video::SColor(255,255,255,255),
\r
145 bool loop=false, bool scale=false);
\r
147 #if (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR <= 8)
\r
148 void setSprite(gui::EGUI_BUTTON_STATE state, s32 index, video::SColor color, bool loop) override {
\r
149 setSprite(state, index, color, loop, false);
\r
153 //! Get the sprite-index for the given state or -1 when no sprite is set
\r
154 virtual s32 getSpriteIndex(gui::EGUI_BUTTON_STATE state) const;
\r
156 //! Get the sprite color for the given state. Color is only used when a sprite is set.
\r
157 virtual video::SColor getSpriteColor(gui::EGUI_BUTTON_STATE state) const;
\r
159 //! Returns if the sprite in the given state does loop
\r
160 virtual bool getSpriteLoop(gui::EGUI_BUTTON_STATE state) const;
\r
162 //! Returns if the sprite in the given state is scaled
\r
163 virtual bool getSpriteScale(gui::EGUI_BUTTON_STATE state) const;
\r
165 //! Sets if the button should behave like a push button. Which means it
\r
166 //! can be in two states: Normal or Pressed. With a click on the button,
\r
167 //! the user can change the state of the button.
\r
168 virtual void setIsPushButton(bool isPushButton=true) override;
\r
170 //! Checks whether the button is a push button
\r
171 virtual bool isPushButton() const override;
\r
173 //! Sets the pressed state of the button if this is a pushbutton
\r
174 virtual void setPressed(bool pressed=true) override;
\r
176 //! Returns if the button is currently pressed
\r
177 virtual bool isPressed() const override;
\r
179 //! Sets if the button should use the skin to draw its border
\r
180 virtual void setDrawBorder(bool border=true) override;
\r
182 //! Checks if the button face and border are being drawn
\r
183 virtual bool isDrawingBorder() const override;
\r
185 //! Sets if the alpha channel should be used for drawing images on the button (default is false)
\r
186 virtual void setUseAlphaChannel(bool useAlphaChannel=true) override;
\r
188 //! Checks if the alpha channel should be used for drawing images on the button
\r
189 virtual bool isAlphaChannelUsed() const override;
\r
191 //! Sets if the button should scale the button images to fit
\r
192 virtual void setScaleImage(bool scaleImage=true) override;
\r
194 //! Checks whether the button scales the used images
\r
195 virtual bool isScalingImage() const override;
\r
197 //! Get if the shift key was pressed in last EGET_BUTTON_CLICKED event
\r
198 virtual bool getClickShiftState() const
\r
200 return ClickShiftState;
\r
203 //! Get if the control key was pressed in last EGET_BUTTON_CLICKED event
\r
204 virtual bool getClickControlState() const
\r
206 return ClickControlState;
\r
209 //! Writes attributes of the element.
\r
210 virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options) const override;
\r
212 //! Reads attributes of the element
\r
213 virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options) override;
\r
217 void setColor(video::SColor color);
\r
220 //! Do not drop returned handle
\r
221 static GUIButton* addButton(gui::IGUIEnvironment *environment, const core::rect<s32>& rectangle,
\r
222 IGUIElement* parent, s32 id, const wchar_t* text, const wchar_t *tooltiptext=L"");
\r
225 void drawSprite(gui::EGUI_BUTTON_STATE state, u32 startTime, const core::position2di& center);
\r
226 gui::EGUI_BUTTON_IMAGE_STATE getImageState(bool pressed) const;
\r
230 struct ButtonSprite
\r
232 ButtonSprite() : Index(-1), Loop(false), Scale(false)
\r
236 bool operator==(const ButtonSprite& other) const
\r
238 return Index == other.Index && Color == other.Color && Loop == other.Loop && Scale == other.Scale;
\r
242 video::SColor Color;
\r
247 ButtonSprite ButtonSprites[gui::EGBS_COUNT];
\r
248 gui::IGUISpriteBank* SpriteBank;
\r
252 ButtonImage() : Texture(0), SourceRect(core::rect<s32>(0,0,0,0))
\r
256 ButtonImage(const ButtonImage& other) : Texture(0), SourceRect(core::rect<s32>(0,0,0,0))
\r
267 ButtonImage& operator=(const ButtonImage& other)
\r
269 if ( this == &other )
\r
273 other.Texture->grab();
\r
276 Texture = other.Texture;
\r
277 SourceRect = other.SourceRect;
\r
281 bool operator==(const ButtonImage& other) const
\r
283 return Texture == other.Texture && SourceRect == other.SourceRect;
\r
287 video::ITexture* Texture;
\r
288 core::rect<s32> SourceRect;
\r
291 ButtonImage ButtonImages[gui::EGBIS_COUNT];
\r
293 gui::IGUIFont* OverrideFont;
\r
295 bool OverrideColorEnabled;
\r
296 video::SColor OverrideColor;
\r
298 u32 ClickTime, HoverTime, FocusTime;
\r
300 bool ClickShiftState;
\r
301 bool ClickControlState;
\r
305 bool UseAlphaChannel;
\r
309 video::SColor Colors[4];
\r