CGUISTKListBox.hpp

// Copyright (C) 2002-2015 Nikolaus Gebhardt
//               2013 Glenn De Jonghe
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h
 
#ifndef HEADER_CGUISTKListBox_HPP
#define HEADER_CGUISTKListBox_HPP
 
#include "IrrCompileConfig.h"
 
#include "IGUIListBox.h"
#include "IGUIElement.h"
#include "irrArray.h"
#include <string>
#include <vector>
 
#include "GlyphLayout.h"
 
namespace irr
{
    namespace gui
    {
    class IGUIFont;
    class IGUIScrollBar;
 
    class CGUISTKListBox : public IGUIElement
    {
    public:
 
            struct ListItem
            {
 
                struct ListCell
                {
                    irr::core::stringw m_text;
                    int m_proportion;
                    s32 m_icon;
                    std::vector<GlyphLayout> m_glyph_layouts;
                    bool m_center;
 
                    ListCell(irr::core::stringw text, s32 icon = -1, int proportion = 1, bool center = false)
                    {
                        m_text = text;
                        m_proportion = proportion;
                        m_icon = icon;
                        m_center = center;
                    }
                };
 
                core::array< ListCell > m_contents;
 
                // Actually only used in list_widget -- still refactoring FIXME
                std::string m_internal_name;
                int m_current_id;
 
                bool m_word_wrap = false;
                float m_line_height_scale = 0.0f;
 
                // A multicolor extension
                struct ListItemOverrideColor
                {
                        ListItemOverrideColor() : Use(false) {}
                        bool Use;
                        video::SColor Color;
                };
 
                ListItemOverrideColor OverrideColors[EGUI_LBC_COUNT];
            };
 
            CGUISTKListBox(IGUIEnvironment* environment, IGUIElement* parent,
                    s32 id, core::rect<s32> rectangle, bool clip=true,
                    bool drawBack=false, bool moveOverSelect=false);
 
            virtual ~CGUISTKListBox();
 
            virtual u32 getItemCount() const;
 
            virtual const wchar_t* getCellText(u32 row_num, u32 col_num) const;
 
            virtual ListItem getItem(u32 id) const;
 
            virtual void clear();
 
            virtual s32 getSelected() const;
 
            virtual void setSelected(s32 id);
 
            virtual s32 getRowByCellText(const wchar_t * text);
 
            virtual void setSelectedByCellText(const wchar_t * text);
 
            virtual s32 getRowByInternalName(const std::string & text) const;
 
            virtual bool OnEvent(const SEvent& event);
 
            virtual void draw();
 
            //virtual u32 addItem(const wchar_t* text, s32 icon);
 
            virtual u32 addItem(const ListItem & item);
 
            virtual s32 getIcon(u32 row_num, u32 col_num) const;
 
            virtual void removeItem(u32 id);
 
            virtual s32 getItemAt(s32 xpos, s32 ypos) const;
 
            virtual void setSpriteBank(IGUISpriteBank* bank);
 
            virtual void setAutoScrollEnabled(bool scroll);
 
            virtual bool isAutoScrollEnabled() const;
 
            virtual void updateAbsolutePosition();
 
            virtual void setItemOverrideColor(u32 index, video::SColor color);
 
            virtual void setItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType, video::SColor color);
 
            virtual void clearItemOverrideColor(u32 index);
 
            virtual void clearItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType);
 
            virtual bool hasItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType) const;
 
            virtual video::SColor getItemOverrideColor(u32 index, EGUI_LISTBOX_COLOR colorType) const;
 
            virtual video::SColor getItemDefaultColor(EGUI_LISTBOX_COLOR colorType) const;
 
            virtual void setCell(u32 row_num, u32 col_num, const wchar_t* text, s32 icon);
 
            virtual void swapItems(u32 index1, u32 index2);
 
            virtual void setItemHeight( s32 height );
 
            /* return item height */
            int getItemHeight() { return (int) m_item_height; }
 
            virtual void setDrawBackground(bool draw);
 
            void setAlternatingDarkness(bool val) { m_alternating_darkness = val; }
            gui::IGUIScrollBar* getScrollBar() const { return ScrollBar; }
            void setDisactivated(bool val)
            {
                m_deactivated = val;
                if (m_deactivated)
                    Selected = -1;
            }
    private:
 
            void recalculateItemHeight();
            void updateDefaultItemHeight();
            void selectNew(s32 ypos, bool onlyHover=false);
            void recalculateScrollPos();
            void updateScrollBarSize(s32 size);
 
            // extracted that function to avoid copy&paste code
            void recalculateIconWidth();
 
            core::array< ListItem > Items;
            s32 Selected;
            s32 m_item_height;
            s32 ItemHeightOverride;
            s32 TotalItemHeight;
            s32 ItemsIconWidth;
            s32 MousePosY;
            gui::IGUIFont* Font;
            gui::IGUISpriteBank* IconBank;
            gui::IGUIScrollBar* ScrollBar;
            u32 selectTime;
            core::stringw KeyBuffer;
            bool Selecting;
            bool Moving;
            bool DrawBack;
            bool MoveOverSelect;
            bool AutoScroll;
            bool HighlightWhenNotFocused;
            bool m_alternating_darkness;
            bool m_deactivated;
    };
 
 
    } // end namespace gui
} // end namespace irr
 
#endif