YTreeItem Class Reference

#include <YTree.h>

List of all members.

Public Member Functions
	YTreeItem (YTree *parent, YCPValue id, YCPString text, bool open=false)
	YTreeItem (YTreeItem *parent, YCPValue id, YCPString text, bool open=false)
	YTreeItem (YTree *parent, YCPString text, void *data, bool open=false)
	YTreeItem (YTreeItem *parent, YCPString text, void *data, bool open=false)
virtual	~YTreeItem ()
const YCPString &	getText () const
const YCPValue &	getId () const
const YTreeItemList &	itemList () const
bool	isOpenByDefault () const
YTreeItem *	findItemWithId (const YCPValue &id)
YTreeItem *	findItemWithText (const YCPString &text)
void *	data () const
void	setData (void *newData)
Protected Attributes
YCPValue	id
void *	_data
YCPString	text
YTree *	parentTree
YTreeItem *	parentItem
bool	openByDefault
YTreeItemList	items

---

Constructor & Destructor Documentation

YTreeItem::YTreeItem (  YTree *  parent, YCPValue  id, YCPString  text, bool  open = false )

Regular constructor for root level items.

YTreeItem::YTreeItem (  YTreeItem *  parent, YCPValue  id, YCPString  text, bool  open = false )

Regular constructor for items in deeper tree levels.

YTreeItem::YTreeItem (  YTree *  parent, YCPString  text, void *  data, bool  open = false )

Special constructor for root items that take an opaque data pointer for application use: This kind of root item can be used to reference to external objects that are connected with this tree item. Use YTreeItem::data() to retrieve this pointer. Casting will be necessary to make any use of it.

YTreeItem::YTreeItem (  YTreeItem *  parent, YCPString  text, void *  data, bool  open = false )

Special constructor for deeper level items that take an opaque data pointer for application use: This kind of root item can be used to reference to external objects that are connected with this tree item. Use YTreeItem::data() to retrieve this pointer. Casting will be necessary to make any use of it.

YTreeItem::~YTreeItem (   )  [virtual]

Destructor.

---

Member Function Documentation

void* YTreeItem::data (   )  const [inline]

Returns the opaque data pointer for applicaton use.

YTreeItem * YTreeItem::findItemWithId (  const YCPValue &  id  )

Recursively search for an item with a given ID. Returns 0 if not found.

YTreeItem * YTreeItem::findItemWithText (  const YCPString &  text  )

Recursively search for an item with a given text. Returns 0 if not found.

const YCPValue& YTreeItem::getId (   )  const [inline]

const YCPString& YTreeItem::getText (   )  const [inline]

bool YTreeItem::isOpenByDefault (   )  const [inline]

const YTreeItemList& YTreeItem::itemList (   )  const [inline]

void YTreeItem::setData (  void *  newData  )  [inline]

Set the opaque data pointer. The application may choose to store internal data here. Watch for dangling pointers!

---

Member Data Documentation

void* YTreeItem::_data [protected]

YCPValue YTreeItem::id [protected]

YTreeItemList YTreeItem::items [protected]

bool YTreeItem::openByDefault [protected]

YTreeItem* YTreeItem::parentItem [protected]

YTree* YTreeItem::parentTree [protected]

YCPString YTreeItem::text [protected]

---

The documentation for this class was generated from the following files:

• YTree.h
• YTree.cc

---