IGUIButton.hpp

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in nirtcpp/nirtcpp.hpp
 
#ifndef NIRT_I_GUI_BUTTON_HPP_INCLUDED
#define NIRT_I_GUI_BUTTON_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IGUIElement.hpp>
 
namespace nirt
{
 
namespace video
{
    class ITexture;
} // end namespace video
 
namespace gui
{
    class IGUIFont;
    class IGUISpriteBank;
 
    enum EGUI_BUTTON_STATE
    {
        EGBS_BUTTON_UP=0,
        EGBS_BUTTON_DOWN,
        EGBS_BUTTON_MOUSE_OVER,
        EGBS_BUTTON_MOUSE_OFF,
        EGBS_BUTTON_FOCUSED,
        EGBS_BUTTON_NOT_FOCUSED,
        EGBS_BUTTON_DISABLED,
        EGBS_COUNT
    };
 
    const c8* const GUIButtonStateNames[EGBS_COUNT+1] =
    {
        "buttonUp",
        "buttonDown",
        "buttonMouseOver",
        "buttonMouseOff",
        "buttonFocused",
        "buttonNotFocused",
        "buttonDisabled",
        0   // count
    };
 
    enum EGUI_BUTTON_IMAGE_STATE
    {
        EGBIS_IMAGE_UP,
        EGBIS_IMAGE_UP_MOUSEOVER,
        EGBIS_IMAGE_UP_FOCUSED,
        EGBIS_IMAGE_UP_FOCUSED_MOUSEOVER,
        EGBIS_IMAGE_DOWN,
        EGBIS_IMAGE_DOWN_MOUSEOVER,
        EGBIS_IMAGE_DOWN_FOCUSED,
        EGBIS_IMAGE_DOWN_FOCUSED_MOUSEOVER,
        EGBIS_IMAGE_DISABLED,
        EGBIS_COUNT
    };
 
    const c8* const GUIButtonImageStateNames[EGBIS_COUNT+1] =
    {
        "Image",    // not "ImageUp" as it otherwise breaks serialization of old files
        "ImageUpOver",
        "ImageUpFocused",
        "ImageUpFocusedOver",
        "PressedImage", // not "ImageDown" as it otherwise breaks serialization of old files
        "ImageDownOver",
        "ImageDownFocused",
        "ImageDownFocusedOver",
        "ImageDisabled",
        0   // count
    };
 
 
    class IGUIButton : public IGUIElement
    {
    public:
 
        IGUIButton(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
            : IGUIElement(EGUIET_BUTTON, environment, parent, id, rectangle) {}
 
 
        virtual void setOverrideFont(IGUIFont* font=0) = 0;
 
 
        virtual IGUIFont* getOverrideFont(void) const = 0;
 
 
        virtual IGUIFont* getActiveFont() const = 0;
 
 
        virtual void setOverrideColor(video::SColor color) = 0;
 
 
        virtual video::SColor getOverrideColor(void) const = 0;
 
 
        virtual video::SColor getActiveColor() const = 0;
 
 
        virtual void enableOverrideColor(bool enable) = 0;
 
 
        virtual bool isOverrideColorEnabled(void) const = 0;
 
 
        virtual void setImage(EGUI_BUTTON_IMAGE_STATE state, video::ITexture* image=0, const core::rect<s32>& sourceRect=core::rect<s32>(0,0,0,0)) = 0;
 
 
        virtual void setImage(video::ITexture* image=0) = 0;
 
 
        virtual void setImage(video::ITexture* image, const core::rect<s32>& sourceRect) = 0;
 
 
        virtual void setPressedImage(video::ITexture* image=0) = 0;
 
 
        virtual void setPressedImage(video::ITexture* image, const core::rect<s32>& sourceRect) = 0;
 
 
 
        virtual void setSpriteBank(IGUISpriteBank* bank=0) = 0;
 
 
        virtual void setSprite(EGUI_BUTTON_STATE state, s32 index,
                video::SColor color=video::SColor(255,255,255,255), bool loop=false, bool scale=false) = 0;
 
        virtual s32 getSpriteIndex(EGUI_BUTTON_STATE state) const = 0;
 
        virtual video::SColor getSpriteColor(EGUI_BUTTON_STATE state) const = 0;
 
        virtual bool getSpriteLoop(EGUI_BUTTON_STATE state) const = 0;
 
        virtual bool getSpriteScale(EGUI_BUTTON_STATE state) const = 0;
 
 
        virtual void setIsPushButton(bool isPushButton=true) = 0;
 
        virtual void setPressed(bool pressed=true) = 0;
 
        virtual bool isPressed() const = 0;
 
        virtual void setUseAlphaChannel(bool useAlphaChannel=true) = 0;
 
        virtual bool isAlphaChannelUsed() const = 0;
 
        virtual bool isPushButton() const = 0;
 
        virtual void setDrawBorder(bool border=true) = 0;
 
        virtual bool isDrawingBorder() const = 0;
 
        virtual void setScaleImage(bool scaleImage=true) = 0;
 
        virtual bool isScalingImage() const = 0;
 
 
        virtual bool getClickShiftState() const = 0;
 
 
        virtual bool getClickControlState() const = 0;
    };
 
 
} // end namespace gui
} // end namespace nirt
 
#endif