IGUITable.hpp

// Copyright (C) 2003-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in nirtcpp/nirtcpp.hpp
 
#ifndef NIRT_I_GUI_TABLE_HPP_INCLUDED
#define NIRT_I_GUI_TABLE_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IGUIElement.hpp>
#include <nirtcpp/core/engine/SColor.hpp>
 
namespace nirt
{
namespace gui
{
    class IGUIFont;
    class IGUIScrollBar;
 
    enum EGUI_COLUMN_ORDERING
    {
        EGCO_NONE,
 
        EGCO_CUSTOM,
 
        EGCO_ASCENDING,
 
        EGCO_DESCENDING,
 
        EGCO_FLIP_ASCENDING_DESCENDING,
 
        EGCO_COUNT
    };
 
    const c8* const GUIColumnOrderingNames[] =
    {
        "none",
        "custom",
        "ascend",
        "descend",
        "ascend_descend",
        0,
    };
 
    enum EGUI_ORDERING_MODE
    {
        EGOM_NONE,
 
        EGOM_ASCENDING,
 
        EGOM_DESCENDING,
 
        EGOM_COUNT
    };
 
    const c8* const GUIOrderingModeNames[] =
    {
        "none",
        "ascending",
        "descending",
        0
    };
 
    enum EGUI_TABLE_DRAW_FLAGS
    {
        EGTDF_ROWS = 1,
        EGTDF_COLUMNS = 2,
        EGTDF_ACTIVE_ROW = 4,
        EGTDF_COUNT
    };
 
 
    class IGUITable : public IGUIElement
    {
    public:
        IGUITable(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
            : IGUIElement(EGUIET_TABLE, environment, parent, id, rectangle) {}
 
 
        virtual void addColumn(const wchar_t* caption, s32 columnIndex=-1) = 0;
 
        virtual void removeColumn(u32 columnIndex) = 0;
 
        virtual s32 getColumnCount() const = 0;
 
 
        virtual bool setActiveColumn(s32 idx, bool doOrder=false) = 0;
 
        virtual s32 getActiveColumn() const = 0;
 
        virtual EGUI_ORDERING_MODE getActiveColumnOrdering() const = 0;
 
        virtual void setColumnWidth(u32 columnIndex, u32 width) = 0;
 
        virtual u32 getColumnWidth(u32 columnIndex) const = 0;
 
        virtual void setResizableColumns(bool resizable) = 0;
 
        virtual bool hasResizableColumns() const = 0;
 
 
        virtual void setColumnOrdering(u32 columnIndex, EGUI_COLUMN_ORDERING mode) = 0;
 
        virtual s32 getSelected() const = 0;
 
        virtual void setSelected( s32 index ) = 0;
 
        virtual s32 getRowCount() const = 0;
 
 
        virtual u32 addRow(u32 rowIndex) = 0;
 
        virtual void removeRow(u32 rowIndex) = 0;
 
        virtual void clearRows() = 0;
 
        virtual void swapRows(u32 rowIndexA, u32 rowIndexB) = 0;
 
 
        virtual void orderRows(s32 columnIndex=-1, EGUI_ORDERING_MODE mode=EGOM_NONE) = 0;
 
        virtual void setCellText(u32 rowIndex, u32 columnIndex, const core::stringw& text) = 0;
 
        virtual void setCellText(u32 rowIndex, u32 columnIndex, const core::stringw& text, video::SColor color) = 0;
 
        virtual void setCellData(u32 rowIndex, u32 columnIndex, void *data) = 0;
 
        virtual void setCellColor(u32 rowIndex, u32 columnIndex, video::SColor color) = 0;
 
        virtual const wchar_t* getCellText(u32 rowIndex, u32 columnIndex ) const = 0;
 
        virtual void* getCellData(u32 rowIndex, u32 columnIndex ) const = 0;
 
        virtual void clear() = 0;
 
        virtual void setDrawFlags(s32 flags) = 0;
 
        virtual s32 getDrawFlags() const = 0;
 
 
        virtual void setOverrideFont(IGUIFont* font=0) = 0;
 
 
        virtual IGUIFont* getOverrideFont(void) const = 0;
 
 
        virtual IGUIFont* getActiveFont() const = 0;
 
        virtual s32 getItemHeight() const = 0;
 
        virtual IGUIScrollBar* getVerticalScrollBar() const = 0;
 
        virtual IGUIScrollBar* getHorizontalScrollBar() const = 0;
 
        virtual void setDrawBackground(bool draw) = 0;
 
 
        virtual bool isDrawBackgroundEnabled() const = 0;
    };
 
 
} // end namespace gui
} // end namespace nirt
 
#endif