| Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials |
GUI Button interface. More...
#include <IGUIButton.h>
Public Member Functions | |
| IGUIButton (IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle) | |
| constructor | |
| virtual bool | isAlphaChannelUsed () const =0 |
| Returns if the alpha channel should be used for drawing background images on the button. | |
| virtual bool | isDrawingBorder () const =0 |
| Returns if the border and button face are being drawn using the skin. | |
| virtual bool | isPressed () const =0 |
| Returns if the button is currently pressed. | |
| virtual bool | isPushButton () const =0 |
| Returns whether the button is a push button. | |
| virtual bool | isScalingImage () const =0 |
| Checks whether the button scales the used images. | |
| virtual void | setDrawBorder (bool border=true)=0 |
| Sets if the button should use the skin to draw its border and button face (default is true). | |
| virtual void | setImage (video::ITexture *image, const core::rect< s32 > &pos)=0 |
| Sets a background image for the button when it is in normal state. | |
| virtual void | setImage (video::ITexture *image=0)=0 |
| Sets an image which should be displayed on the button when it is in normal state. | |
| virtual void | setIsPushButton (bool isPushButton=true)=0 |
| Sets if the button should behave like a push button. | |
| virtual void | setOverrideFont (IGUIFont *font=0)=0 |
| Sets another skin independent font. | |
| virtual void | setPressed (bool pressed=true)=0 |
| Sets the pressed state of the button if this is a pushbutton. | |
| virtual void | setPressedImage (video::ITexture *image, const core::rect< s32 > &pos)=0 |
| Sets an image which should be displayed on the button when it is in pressed state. | |
| virtual void | setPressedImage (video::ITexture *image=0)=0 |
| Sets a background image for the button when it is in pressed state. | |
| virtual void | setScaleImage (bool scaleImage=true)=0 |
| Sets if the button should scale the button images to fit. | |
| virtual void | setSprite (EGUI_BUTTON_STATE state, s32 index, video::SColor color=video::SColor(255, 255, 255, 255), bool loop=false)=0 |
| Sets the animated sprite for a specific button state. | |
| virtual void | setSpriteBank (IGUISpriteBank *bank=0)=0 |
| Sets the sprite bank used by the button. | |
| virtual void | setUseAlphaChannel (bool useAlphaChannel=true)=0 |
| Sets if the alpha channel should be used for drawing background images on the button (default is false). | |
GUI Button interface.
Definition at line 53 of file IGUIButton.h.
| irr::gui::IGUIButton::IGUIButton | ( | IGUIEnvironment * | environment, | |
| IGUIElement * | parent, | |||
| s32 | id, | |||
| core::rect< s32 > | rectangle | |||
| ) | [inline] |
constructor
Definition at line 58 of file IGUIButton.h.
| virtual bool irr::gui::IGUIButton::isAlphaChannelUsed | ( | ) | const [pure virtual] |
Returns if the alpha channel should be used for drawing background images on the button.
| virtual bool irr::gui::IGUIButton::isDrawingBorder | ( | ) | const [pure virtual] |
Returns if the border and button face are being drawn using the skin.
| virtual bool irr::gui::IGUIButton::isPressed | ( | ) | const [pure virtual] |
Returns if the button is currently pressed.
| virtual bool irr::gui::IGUIButton::isPushButton | ( | ) | const [pure virtual] |
Returns whether the button is a push button.
| virtual bool irr::gui::IGUIButton::isScalingImage | ( | ) | const [pure virtual] |
Checks whether the button scales the used images.
| virtual void irr::gui::IGUIButton::setDrawBorder | ( | bool | border = true |
) | [pure virtual] |
Sets if the button should use the skin to draw its border and button face (default is true).
| virtual void irr::gui::IGUIButton::setImage | ( | video::ITexture * | image, | |
| const core::rect< s32 > & | pos | |||
| ) | [pure virtual] |
Sets a background image for the button when it is in normal state.
| image,: | Texture containing the image to be displayed | |
| pos,: | Position in the texture, where the image is located |
| virtual void irr::gui::IGUIButton::setImage | ( | video::ITexture * | image = 0 |
) | [pure virtual] |
Sets an image which should be displayed on the button when it is in normal state.
| image,: | Image to be displayed |
| virtual void irr::gui::IGUIButton::setIsPushButton | ( | bool | isPushButton = true |
) | [pure virtual] |
Sets if the button should behave like a push button.
Which means it can be in two states: Normal or Pressed. With a click on the button, the user can change the state of the button.
| virtual void irr::gui::IGUIButton::setOverrideFont | ( | IGUIFont * | font = 0 |
) | [pure virtual] |
Sets another skin independent font.
If this is set to zero, the button uses the font of the skin.
| font,: | New font to set. |
| virtual void irr::gui::IGUIButton::setPressed | ( | bool | pressed = true |
) | [pure virtual] |
Sets the pressed state of the button if this is a pushbutton.
| virtual void irr::gui::IGUIButton::setPressedImage | ( | video::ITexture * | image, | |
| const core::rect< s32 > & | pos | |||
| ) | [pure virtual] |
Sets an image which should be displayed on the button when it is in pressed state.
| image,: | Texture containing the image to be displayed | |
| pos,: | Position in the texture, where the image is located |
| virtual void irr::gui::IGUIButton::setPressedImage | ( | video::ITexture * | image = 0 |
) | [pure virtual] |
Sets a background image for the button when it is in pressed state.
If no images is specified for the pressed state via setPressedImage(), this image is also drawn in pressed state.
| image,: | Image to be displayed |
| virtual void irr::gui::IGUIButton::setScaleImage | ( | bool | scaleImage = true |
) | [pure virtual] |
Sets if the button should scale the button images to fit.
| virtual void irr::gui::IGUIButton::setSprite | ( | EGUI_BUTTON_STATE | state, | |
| s32 | index, | |||
| video::SColor | color = video::SColor(255, 255, 255, 255), |
|||
| bool | loop = false | |||
| ) | [pure virtual] |
Sets the animated sprite for a specific button state.
| index,: | Number of the sprite within the sprite bank, use -1 for no sprite | |
| state,: | State of the button to set the sprite for | |
| index,: | The sprite number from the current sprite bank | |
| color,: | The color of the sprite | |
| loop,: | True if the animation should loop, false if not |
| virtual void irr::gui::IGUIButton::setSpriteBank | ( | IGUISpriteBank * | bank = 0 |
) | [pure virtual] |
Sets the sprite bank used by the button.
| virtual void irr::gui::IGUIButton::setUseAlphaChannel | ( | bool | useAlphaChannel = true |
) | [pure virtual] |
Sets if the alpha channel should be used for drawing background images on the button (default is false).
| The Irrlicht
Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated
on Sun Feb 14 13:07:04 2010 by Doxygen
(1.6.2) |