tb_select_item.h

// ================================================================================
// ==      This file is a part of Turbo Badger. (C) 2011-2014, Emil Segerås      ==
// ==                     See tb_core.h for more information.                    ==
// ================================================================================

#ifndef TB_SELECT_ITEM_H
#define TB_SELECT_ITEM_H

#include "tb_linklist.h"
#include "tb_list.h"
#include "tb_value.h"

namespace tb {

class TBSelectItemSource;

enum TB_SORT {
    TB_SORT_NONE,       
    TB_SORT_ASCENDING,  
    TB_SORT_DESCENDING  
};

class TBSelectItemViewer : public TBLinkOf<TBSelectItemViewer>
{
public:
    TBSelectItemViewer() : m_source(nullptr) {}
    virtual ~TBSelectItemViewer() {}

    void SetSource(TBSelectItemSource *source);
    TBSelectItemSource *GetSource() const { return m_source; }

    virtual void OnSourceChanged() = 0;

    virtual void OnItemChanged(int index) = 0;

    virtual void OnItemAdded(int index) = 0;

    virtual void OnItemRemoved(int index) = 0;

    virtual void OnAllItemsRemoved() = 0;
protected:
    TBSelectItemSource *m_source;
};

class TBSelectItemSource : public TBTypedObject
{
public:
    TBSelectItemSource() : m_sort(TB_SORT_NONE) {}
    virtual ~TBSelectItemSource();
    TBOBJECT_SUBCLASS(TBSelectItemSource, TBTypedObject);

    virtual bool Filter(int index, const TBStr & filter);

    virtual const TBStr & GetItemString(int index) const = 0;

    virtual TBSelectItemSource *GetItemSubSource(int /*index*/) { return nullptr; }

    virtual TBID GetItemImage(int /*index*/) const { return TBID(); }

    virtual TBID GetItemID(int /*index*/) const { return TBID(); }

    virtual TBWidget *CreateItemWidget(int index, TBSelectItemViewer *viewer);

    virtual int GetNumItems() const = 0;

    virtual int FindIDIndex(TBID id) const;

    void SetSort(TB_SORT sort) { m_sort = sort; }
    TB_SORT GetSort() const { return m_sort; }

    void InvokeItemChanged(int index, TBSelectItemViewer *exclude_viewer = nullptr);
    void InvokeItemAdded(int index);
    void InvokeItemRemoved(int index);
    void InvokeAllItemsRemoved();
private:
    friend class TBSelectItemViewer;
    TBLinkListOf<TBSelectItemViewer> m_viewers;
    TB_SORT m_sort;
};

template<class T>
class TBSelectItemSourceList : public TBSelectItemSource
{
public:
    TBOBJECT_SUBCLASS(TBSelectItemSourceList, TBSelectItemSource);
    TBSelectItemSourceList() {}
    virtual ~TBSelectItemSourceList()                   { DeleteAllItems(); }
    virtual const TBStr & GetItemString(int index) const { return GetItem(index)->str; }
    virtual TBSelectItemSource *GetItemSubSource(int index){ return GetItem(index)->sub_source; }
    virtual TBID GetItemImage(int index) const          { return GetItem(index)->skin_image; }
    virtual TBID GetItemID(int index) const             { return GetItem(index)->id; }
    virtual int GetNumItems() const                     { return m_items.GetNumItems(); }
    virtual TBWidget *CreateItemWidget(int index, TBSelectItemViewer *viewer)
    {
        if (TBWidget *widget = TBSelectItemSource::CreateItemWidget(index, viewer))
        {
            T *item = m_items[index];
            widget->SetID(item->id);
            widget->SetStateRaw(item->state);
            return widget;
        }
        return nullptr;
    }

    bool AddItem(T *item, int index)
    {
        if (m_items.Add(item, index))
        {
            InvokeItemAdded(index);
            return true;
        }
        return false;
    }

    bool AddItem(T *item)               { return AddItem(item, m_items.GetNumItems()); }

    T *GetItem(int index)               { return m_items[index]; }

    const T *GetItem(int index) const   { return m_items[index]; }

    T *FindItemByID(TBID id)            { int index = FindIDIndex(id); return index >= 0 ? m_items[index] : nullptr; }

    const T *FindItemByID(TBID id) const { int index = FindIDIndex(id); return index >= 0 ? m_items[index] : nullptr; }

    void DeleteItem(int index)
    {
        if (!m_items.GetNumItems())
            return;
        m_items.Delete(index);
        InvokeItemRemoved(index);
    }

    void DeleteAllItems()
    {
        if (!m_items.GetNumItems())
            return;
        m_items.DeleteAll();
        InvokeAllItemsRemoved();
    }
private:
    TBListOf<T> m_items;
};

class TBGenericStringItem
{
public:
#define def_skin TBIDC("NormalItem")
    TBGenericStringItem(TBStr str) : str(str), id(str) {}
    TBGenericStringItem(TBStr str, TBID id, TBValue val = TBValue(), TBID img_id = def_skin)
        : str(str), id(id), skin_image(img_id), tag(val) {}
    TBGenericStringItem(TBStr str, TBSelectItemSource *sub_source, TBID img_id = def_skin)
        : str(str), id(str), skin_image(img_id), sub_source(sub_source) {}

    // protect the sub_source pointer from copy, since we own it.
    const TBGenericStringItem& operator = (const TBGenericStringItem &other) = delete;
    TBGenericStringItem(const TBGenericStringItem& other) = delete;

    ~TBGenericStringItem() { if (sub_source) delete sub_source; }
    void SetSkinImage(const TBID &image) { skin_image = image; }

 public:
    TBStr str;
    TBID id;
    TBID skin_image = def_skin;
    TBSelectItemSource *sub_source = nullptr;
    WIDGET_STATE state = WIDGET_STATE_NONE;

    TBValue tag;
};

class TBGenericSeparatorItem : public TBGenericStringItem {
public:
    TBGenericSeparatorItem() : TBGenericStringItem("-", nullptr, TBID()) {}
};

class TBGenericStringItemSource : public TBSelectItemSourceList<TBGenericStringItem> {
public:
    TBOBJECT_SUBCLASS(TBGenericStringItemSource, TBSelectItemSourceList<TBGenericStringItem>);
};

} // namespace tb

#endif // TB_SELECT_ITEM_H