IGUISkin.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_SKIN_H_INCLUDED__
#define __I_GUI_SKIN_H_INCLUDED__

#include "IAttributeExchangingObject.h"
#include "EGUIAlignment.h"
#include "SColor.h"
#include "rect.h"

namespace irr
{
namespace gui
{
        class IGUIFont;
        class IGUISpriteBank;
        class IGUIElement;


        enum EGUI_SKIN_TYPE
        {
                EGST_WINDOWS_CLASSIC=0,

                EGST_WINDOWS_METALLIC,

                EGST_BURNING_SKIN,

                EGST_UNKNOWN,

                EGST_COUNT
        };

        const c8* const GUISkinTypeNames[EGST_COUNT+1] =
        {
                "windowsClassic",
                "windowsMetallic",
                "burning",
                "unknown",
                0,
        };


        enum EGUI_DEFAULT_COLOR
        {
                EGDC_3D_DARK_SHADOW = 0,
                EGDC_3D_SHADOW,
                EGDC_3D_FACE,
                EGDC_3D_HIGH_LIGHT,
                EGDC_3D_LIGHT,
                EGDC_ACTIVE_BORDER,
                EGDC_ACTIVE_CAPTION,
                EGDC_APP_WORKSPACE,
                EGDC_BUTTON_TEXT,
                EGDC_GRAY_TEXT,
                EGDC_HIGH_LIGHT,
                EGDC_HIGH_LIGHT_TEXT,
                EGDC_INACTIVE_BORDER,
                EGDC_INACTIVE_CAPTION,
                EGDC_TOOLTIP,
                EGDC_TOOLTIP_BACKGROUND,
                EGDC_SCROLLBAR,
                EGDC_WINDOW,
                EGDC_WINDOW_SYMBOL,
                EGDC_ICON,
                EGDC_ICON_HIGH_LIGHT,
                EGDC_GRAY_WINDOW_SYMBOL,
                EGDC_EDITABLE,
                EGDC_GRAY_EDITABLE,
                EGDC_FOCUSED_EDITABLE,

                EGDC_COUNT
        };

        const c8* const GUISkinColorNames[EGDC_COUNT+1] =
        {
                "3DDarkShadow",
                "3DShadow",
                "3DFace",
                "3DHighlight",
                "3DLight",
                "ActiveBorder",
                "ActiveCaption",
                "AppWorkspace",
                "ButtonText",
                "GrayText",
                "Highlight",
                "HighlightText",
                "InactiveBorder",
                "InactiveCaption",
                "ToolTip",
                "ToolTipBackground",
                "ScrollBar",
                "Window",
                "WindowSymbol",
                "Icon",
                "IconHighlight",
                "GrayWindowSymbol",
                "Editable",
                "GrayEditable",
                "FocusedEditable",
                0,
        };

        enum EGUI_DEFAULT_SIZE
        {
                EGDS_SCROLLBAR_SIZE = 0,
                EGDS_MENU_HEIGHT,
                EGDS_WINDOW_BUTTON_WIDTH,
                EGDS_CHECK_BOX_WIDTH,
                EGDS_MESSAGE_BOX_WIDTH,
                EGDS_MESSAGE_BOX_HEIGHT,
                EGDS_BUTTON_WIDTH,
                EGDS_BUTTON_HEIGHT,
                EGDS_TEXT_DISTANCE_X,
                EGDS_TEXT_DISTANCE_Y,
                EGDS_TITLEBARTEXT_DISTANCE_X,
                EGDS_TITLEBARTEXT_DISTANCE_Y,
                EGDS_MESSAGE_BOX_GAP_SPACE,
                EGDS_MESSAGE_BOX_MIN_TEXT_WIDTH,
                EGDS_MESSAGE_BOX_MAX_TEXT_WIDTH,
                EGDS_MESSAGE_BOX_MIN_TEXT_HEIGHT,
                EGDS_MESSAGE_BOX_MAX_TEXT_HEIGHT,
                EGDS_BUTTON_PRESSED_IMAGE_OFFSET_X,
                EGDS_BUTTON_PRESSED_IMAGE_OFFSET_Y,
                EGDS_BUTTON_PRESSED_TEXT_OFFSET_X,
                EGDS_BUTTON_PRESSED_TEXT_OFFSET_Y,
                EGDS_BUTTON_PRESSED_SPRITE_OFFSET_X,
                EGDS_BUTTON_PRESSED_SPRITE_OFFSET_Y,

                EGDS_COUNT
        };


        const c8* const GUISkinSizeNames[EGDS_COUNT+1] =
        {
                "ScrollBarSize",
                "MenuHeight",
                "WindowButtonWidth",
                "CheckBoxWidth",
                "MessageBoxWidth",
                "MessageBoxHeight",
                "ButtonWidth",
                "ButtonHeight",
                "TextDistanceX",
                "TextDistanceY",
                "TitleBarTextX",
                "TitleBarTextY",
                "MessageBoxGapSpace",
                "MessageBoxMinTextWidth",
                "MessageBoxMaxTextWidth",
                "MessageBoxMinTextHeight",
                "MessageBoxMaxTextHeight",
                "ButtonPressedImageOffsetX",
                "ButtonPressedImageOffsetY",
                "ButtonPressedTextOffsetX",
                "ButtonPressedTextOffsetY",
                "ButtonPressedSpriteOffsetX",
                "ButtonPressedSpriteOffsetY",
                0
        };


        enum EGUI_DEFAULT_TEXT
        {
                EGDT_MSG_BOX_OK = 0,
                EGDT_MSG_BOX_CANCEL,
                EGDT_MSG_BOX_YES,
                EGDT_MSG_BOX_NO,
                EGDT_WINDOW_CLOSE,
                EGDT_WINDOW_MAXIMIZE,
                EGDT_WINDOW_MINIMIZE,
                EGDT_WINDOW_RESTORE,

                EGDT_COUNT
        };

        const c8* const GUISkinTextNames[EGDT_COUNT+1] =
        {
                "MessageBoxOkay",
                "MessageBoxCancel",
                "MessageBoxYes",
                "MessageBoxNo",
                "WindowButtonClose",
                "WindowButtonMaximize",
                "WindowButtonMinimize",
                "WindowButtonRestore",
                0
        };

        enum EGUI_DEFAULT_ICON
        {
                EGDI_WINDOW_MAXIMIZE = 0,
                EGDI_WINDOW_RESTORE,
                EGDI_WINDOW_CLOSE,
                EGDI_WINDOW_MINIMIZE,
                EGDI_WINDOW_RESIZE,
                EGDI_CURSOR_UP,
                EGDI_CURSOR_DOWN,
                EGDI_CURSOR_LEFT,
                EGDI_CURSOR_RIGHT,
                EGDI_MENU_MORE,
                EGDI_CHECK_BOX_CHECKED,
                EGDI_DROP_DOWN,
                EGDI_SMALL_CURSOR_UP,
                EGDI_SMALL_CURSOR_DOWN,
                EGDI_RADIO_BUTTON_CHECKED,
                EGDI_MORE_LEFT,
                EGDI_MORE_RIGHT,
                EGDI_MORE_UP,
                EGDI_MORE_DOWN,
                EGDI_EXPAND,

                EGDI_COLLAPSE,
                EGDI_FILE,
                EGDI_DIRECTORY,

                EGDI_COUNT
        };

        const c8* const GUISkinIconNames[EGDI_COUNT+1] =
        {
                "windowMaximize",
                "windowRestore",
                "windowClose",
                "windowMinimize",
                "windowResize",
                "cursorUp",
                "cursorDown",
                "cursorLeft",
                "cursorRight",
                "menuMore",
                "checkBoxChecked",
                "dropDown",
                "smallCursorUp",
                "smallCursorDown",
                "radioButtonChecked",
                "moreLeft",
                "moreRight",
                "moreUp",
                "moreDown",
                "expand",
                "collapse",
                "file",
                "directory",
                0
        };

        // Customizable fonts
        enum EGUI_DEFAULT_FONT
        {
                EGDF_DEFAULT=0,
                EGDF_BUTTON,
                EGDF_WINDOW,
                EGDF_MENU,
                EGDF_TOOLTIP,
                EGDF_COUNT
        };

        const c8* const GUISkinFontNames[EGDF_COUNT+1] =
        {
                "defaultFont",
                "buttonFont",
                "windowFont",
                "menuFont",
                "tooltipFont",
                0
        };

        class IGUISkin : public virtual io::IAttributeExchangingObject
        {
        public:

                virtual video::SColor getColor(EGUI_DEFAULT_COLOR color) const = 0;

                virtual void setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor) = 0;

                virtual s32 getSize(EGUI_DEFAULT_SIZE size) const = 0;


                virtual const wchar_t* getDefaultText(EGUI_DEFAULT_TEXT text) const = 0;


                virtual void setDefaultText(EGUI_DEFAULT_TEXT which, const wchar_t* newText) = 0;

                virtual void setSize(EGUI_DEFAULT_SIZE which, s32 size) = 0;

                virtual IGUIFont* getFont(EGUI_DEFAULT_FONT which=EGDF_DEFAULT) const = 0;

                virtual void setFont(IGUIFont* font, EGUI_DEFAULT_FONT which=EGDF_DEFAULT) = 0;

                virtual IGUISpriteBank* getSpriteBank() const = 0;

                virtual void setSpriteBank(IGUISpriteBank* bank) = 0;


                virtual u32 getIcon(EGUI_DEFAULT_ICON icon) const = 0;


                virtual void setIcon(EGUI_DEFAULT_ICON icon, u32 index) = 0;


                virtual void draw3DButtonPaneStandard(IGUIElement* element,
                        const core::rect<s32>& rect,
                        const core::rect<s32>* clip=0) = 0;


                virtual void draw3DButtonPanePressed(IGUIElement* element,
                        const core::rect<s32>& rect,
                        const core::rect<s32>* clip=0) = 0;


                virtual void draw3DSunkenPane(IGUIElement* element,
                        video::SColor bgcolor, bool flat, bool fillBackGround,
                        const core::rect<s32>& rect,
                        const core::rect<s32>* clip=0) = 0;


                virtual core::rect<s32> draw3DWindowBackground(IGUIElement* element,
                        bool drawTitleBar, video::SColor titleBarColor,
                        const core::rect<s32>& rect,
                        const core::rect<s32>* clip=0,
                        core::rect<s32>* checkClientArea=0) = 0;


                virtual void draw3DMenuPane(IGUIElement* element,
                        const core::rect<s32>& rect,
                        const core::rect<s32>* clip=0) = 0;


                virtual void draw3DToolBar(IGUIElement* element,
                        const core::rect<s32>& rect,
                        const core::rect<s32>* clip=0) = 0;


                virtual void draw3DTabButton(IGUIElement* element, bool active,
                        const core::rect<s32>& rect, const core::rect<s32>* clip=0, gui::EGUI_ALIGNMENT alignment=EGUIA_UPPERLEFT) = 0;


                virtual void draw3DTabBody(IGUIElement* element, bool border, bool background,
                        const core::rect<s32>& rect, const core::rect<s32>* clip=0, s32 tabHeight=-1, gui::EGUI_ALIGNMENT alignment=EGUIA_UPPERLEFT ) = 0;


                virtual void drawIcon(IGUIElement* element, EGUI_DEFAULT_ICON icon,
                        const core::position2di position, u32 starttime=0, u32 currenttime=0,
                        bool loop=false, const core::rect<s32>* clip=0) = 0;


                virtual void draw2DRectangle(IGUIElement* element, const video::SColor &color,
                        const core::rect<s32>& pos, const core::rect<s32>* clip = 0) = 0;

                virtual EGUI_SKIN_TYPE getType() const { return EGST_UNKNOWN; }
        };


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

#endif