IGUITreeView.h

Go to the documentation of this file.

// written by Reinhard Ostermeier, reinhard@nospam.r-ostermeier.de
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_GUI_TREE_VIEW_H_INCLUDED__
#define __I_GUI_TREE_VIEW_H_INCLUDED__

#include "IGUIElement.h"
#include "IGUIImageList.h"
#include "irrTypes.h"

namespace irr
{
namespace gui
{
        class IGUIFont;
        class IGUITreeView;
        class IGUIScrollBar;



        class IGUITreeViewNode : public IReferenceCounted
        {
        public:
                virtual IGUITreeView* getOwner() const = 0;


                virtual IGUITreeViewNode* getParent() const = 0;

                virtual const wchar_t* getText() const = 0;

                virtual void setText( const wchar_t* text ) = 0;

                virtual const wchar_t* getIcon() const = 0;

                virtual void setIcon( const wchar_t* icon ) = 0;

                virtual u32 getImageIndex() const = 0;

                virtual void setImageIndex( u32 imageIndex ) = 0;

                virtual u32 getSelectedImageIndex() const = 0;

                virtual void setSelectedImageIndex( u32 imageIndex ) = 0;

                virtual void* getData() const = 0;

                virtual void setData( void* data ) = 0;

                virtual IReferenceCounted* getData2() const = 0;

                virtual void setData2( IReferenceCounted* data ) = 0;

                virtual u32 getChildCount() const = 0;

                virtual void clearChildren() = 0;


                _IRR_DEPRECATED_ void clearChilds()
                {
                        return clearChildren();
                }

                virtual bool hasChildren() const = 0;


                _IRR_DEPRECATED_ bool hasChilds() const
                {
                        return hasChildren();
                }


                virtual IGUITreeViewNode* addChildBack(
                                const wchar_t* text, const wchar_t* icon = 0,
                                s32 imageIndex=-1, s32 selectedImageIndex=-1,
                                void* data=0, IReferenceCounted* data2=0) =0;


                virtual IGUITreeViewNode* addChildFront(
                                const wchar_t* text, const wchar_t* icon = 0,
                                s32 imageIndex=-1, s32 selectedImageIndex=-1,
                                void* data=0, IReferenceCounted* data2=0 ) =0;


                virtual IGUITreeViewNode* insertChildAfter(
                                IGUITreeViewNode* other,
                                const wchar_t* text, const wchar_t* icon = 0,
                                s32 imageIndex=-1, s32 selectedImageIndex=-1,
                                void* data=0, IReferenceCounted* data2=0) =0;


                virtual IGUITreeViewNode* insertChildBefore(
                                IGUITreeViewNode* other,
                                const wchar_t* text, const wchar_t* icon = 0,
                                s32 imageIndex=-1, s32 selectedImageIndex=-1,
                                void* data=0, IReferenceCounted* data2=0) = 0;


                virtual IGUITreeViewNode* getFirstChild() const = 0;


                virtual IGUITreeViewNode* getLastChild() const = 0;


                virtual IGUITreeViewNode* getPrevSibling() const = 0;


                virtual IGUITreeViewNode* getNextSibling() const = 0;


                virtual IGUITreeViewNode* getNextVisible() const = 0;


                virtual bool deleteChild( IGUITreeViewNode* child ) = 0;


                virtual bool moveChildUp( IGUITreeViewNode* child ) = 0;


                virtual bool moveChildDown( IGUITreeViewNode* child ) = 0;

                virtual bool getExpanded() const = 0;

                virtual void setExpanded( bool expanded ) = 0;

                virtual bool getSelected() const = 0;

                virtual void setSelected( bool selected ) = 0;

                virtual bool isRoot() const = 0;


                virtual s32 getLevel() const = 0;

                virtual bool isVisible() const = 0;
        };



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

                virtual IGUITreeViewNode* getRoot() const = 0;

                virtual IGUITreeViewNode* getSelected() const = 0;

                virtual bool getLinesVisible() const = 0;


                virtual void setLinesVisible( bool visible ) = 0;


                virtual void setIconFont( IGUIFont* font ) = 0;


                virtual void setOverrideFont(IGUIFont* font=0) = 0;


                virtual IGUIFont* getOverrideFont(void) const = 0;


                virtual IGUIFont* getActiveFont() const = 0;


                virtual void setImageList( IGUIImageList* imageList ) = 0;

                virtual IGUIImageList* getImageList() const = 0;

                virtual void setImageLeftOfIcon( bool bLeftOf ) = 0;

                virtual bool getImageLeftOfIcon() const = 0;


                virtual IGUITreeViewNode* getLastEventNode() const = 0;

                virtual IGUIScrollBar* getVerticalScrollBar() const = 0;

                virtual IGUIScrollBar* getHorizontalScrollBar() const = 0;
        };


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

#endif