IGUIListBox.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_LIST_BOX_H_INCLUDED__
#define __I_GUI_LIST_BOX_H_INCLUDED__

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

namespace irr
{
namespace gui
{
    class IGUISpriteBank;

    enum EGUI_LISTBOX_COLOR
    {
        EGUI_LBC_TEXT=0,
        EGUI_LBC_TEXT_HIGHLIGHT,
        EGUI_LBC_ICON,
        EGUI_LBC_ICON_HIGHLIGHT,
        EGUI_LBC_COUNT
    };



    class IGUIListBox : public IGUIElement
    {
    public:
        IGUIListBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
            : IGUIElement(EGUIET_LIST_BOX, environment, parent, id, rectangle) {}

        virtual u32 getItemCount() const = 0;

        virtual const wchar_t* getListItem(u32 id) const = 0;

        virtual u32 addItem(const wchar_t* text) = 0;


        virtual u32 addItem(const wchar_t* text, s32 icon) = 0;

        virtual void removeItem(u32 index) = 0;


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

        virtual s32 getIcon(u32 index) const = 0;


        virtual void setSpriteBank(IGUISpriteBank* bank) = 0;

        virtual void clear() = 0;

        virtual s32 getSelected() const = 0;

        virtual void setSelected(s32 index) = 0;

        virtual void setSelected(const wchar_t *item) = 0;

        virtual void setAutoScrollEnabled(bool scroll) = 0;

        virtual bool isAutoScrollEnabled() const = 0;

        virtual void setItemOverrideColor(u32 index, video::SColor color) = 0;

        virtual void setItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType, video::SColor color) = 0;

        virtual void clearItemOverrideColor(u32 index) = 0;

        virtual void clearItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType) = 0;

        virtual bool hasItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType) const = 0;

        virtual video::SColor getItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType) const = 0;

        virtual video::SColor getItemDefaultColor(EGUI_LISTBOX_COLOR colorType) const = 0;

        virtual void setItem(u32 index, const wchar_t* text, s32 icon) = 0;


        virtual s32 insertItem(u32 index, const wchar_t* text, s32 icon) = 0;

        virtual void swapItems(u32 index1, u32 index2) = 0;

        virtual void setItemHeight( s32 height ) = 0;

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


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

#endif