Public Member Functions

sp::gui::GUITreeGadget Class Reference
[Built in GUI]

#include <spGUITreeGadget.hpp>

Inheritance diagram for sp::gui::GUITreeGadget:
sp::gui::GUIGadget sp::gui::GUIScrollViewBased sp::gui::GUIController sp::gui::GUIBaseObject

List of all members.

Public Member Functions

 GUITreeGadget ()
 ~GUITreeGadget ()
bool update ()
void draw ()
GUITreeItem * addItem (const io::stringc &Text, GUITreeItem *Parent=0, video::Texture *Icon=0)
void removeItem (GUITreeItem *Item)
 Removes the specified item object from the tree.
void clearItems ()
 Removes and deletes all items.
void setExplorer (bool isExplorer)
io::stringc getExplorerFullPath (const GUITreeItem *Item) const
GUITreeItem * getSelectedItem () const
bool getExplorer () const

Detailed Description

Tree view controller gadget.

Constructor & Destructor Documentation

sp::gui::GUITreeGadget::GUITreeGadget (  ) 
sp::gui::GUITreeGadget::~GUITreeGadget (  ) 

Member Function Documentation

GUITreeItem* sp::gui::GUITreeGadget::addItem ( const io::stringc &  Text,
GUITreeItem *  Parent = 0,
video::Texture *  Icon = 0 
)

Adds a new item to the tree list.

Parameters:
Text,: Item text (or rather title).
Parent,: Optional parent item.
Icon,: Optional item icon (or rather image/ texture etc.).
void sp::gui::GUITreeGadget::clearItems (  ) 

Removes and deletes all items.

void sp::gui::GUITreeGadget::draw (  ) 
bool sp::gui::GUITreeGadget::getExplorer (  )  const [inline]
io::stringc sp::gui::GUITreeGadget::getExplorerFullPath ( const GUITreeItem *  Item  )  const
GUITreeItem* sp::gui::GUITreeGadget::getSelectedItem (  )  const [inline]
Returns:
Pointer to the currently selected item object. If no item is selected the return value is 0 (null).
void sp::gui::GUITreeGadget::removeItem ( GUITreeItem *  Item  ) 

Removes the specified item object from the tree.

void sp::gui::GUITreeGadget::setExplorer ( bool  isExplorer  ) 

Sets the explorer mode. If a tree gadget is in the explorer mode the whole disk will be represented in the tree gadget. When a sub directory will be opened new items will be created. It is similiar to the Windows(c) explorer(c) on the left side.

bool sp::gui::GUITreeGadget::update (  ) 
The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:55 for SoftPixel Engine by  doxygen 1.7.1