IGUITabControl.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_GUI_TAB_CONTROL_H_INCLUDED__
#define __I_GUI_TAB_CONTROL_H_INCLUDED__

#include "IGUIElement.h"
#include "SColor.h"
#include "IGUISkin.h"

namespace irr
{
namespace gui
{
        class IGUITab;


        class IGUITabControl : public IGUIElement
        {
        public:

                IGUITabControl(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
                        : IGUIElement(EGUIET_TAB_CONTROL, environment, parent, id, rectangle) {}

                virtual IGUITab* addTab(const wchar_t* caption, s32 id=-1) = 0;


                virtual s32 addTab(IGUITab* tab) = 0;


                virtual IGUITab* insertTab(s32 idx, const wchar_t* caption, s32 id=-1) = 0;


                virtual s32 insertTab(s32 idx, IGUITab* tab, bool serializationMode=false) = 0;

                virtual void removeTab(s32 idx) = 0;

                virtual void clear() = 0;

                virtual s32 getTabCount() const = 0;


                virtual IGUITab* getTab(s32 idx) const = 0;


                virtual s32 getTabIndex(const IGUIElement *tab) const = 0;


                virtual bool setActiveTab(s32 idx) = 0;


                virtual bool setActiveTab(IGUITab *tab) = 0;

                virtual s32 getActiveTab() const = 0;


                virtual s32 getTabAt(s32 xpos, s32 ypos) const = 0;

                virtual void setTabHeight( s32 height ) = 0;


                virtual s32 getTabHeight() const = 0;

                virtual void setTabMaxWidth(s32 width ) = 0;

                virtual s32 getTabMaxWidth() const = 0;


                virtual void setTabVerticalAlignment( gui::EGUI_ALIGNMENT alignment ) = 0;


                virtual gui::EGUI_ALIGNMENT getTabVerticalAlignment() const = 0;

                virtual void setTabExtraWidth( s32 extraWidth ) = 0;


                virtual s32 getTabExtraWidth() const = 0;
        };


        class IGUITab : public IGUIElement
        {
        public:

                IGUITab(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
                        : IGUIElement(EGUIET_TAB, environment, parent, id, rectangle) {}


                _IRR_DEPRECATED_ virtual s32 getNumber() const
                {
                        if (Parent && Parent->getType() == EGUIET_TAB_CONTROL)
                                return static_cast<IGUITabControl*>(Parent)->getTabIndex(this);
                        return -1;
                }

                virtual void setDrawBackground(bool draw=true) = 0;

                virtual void setBackgroundColor(video::SColor c) = 0;

                virtual bool isDrawingBackground() const = 0;

                virtual video::SColor getBackgroundColor() const = 0;

                virtual void setTextColor(video::SColor c) = 0;

                virtual video::SColor getTextColor() const = 0;
        };

} // end namespace gui
} // end namespace irr

#endif