kDataTree Class Reference

Description

Represents a tree of data objects.

Inheritance diagram for kDataTree:

Public Member Functions
kStatus	kDataTree_Add (kDataTree tree, kDataTreeItem parent, const kChar *name, kDataTreeItem *item)
	Inserts a new child item at the end of the specified parent's child list. More...
kStatus	kDataTree_Child32f (kDataTree tree, kDataTreeItem parent, const kChar *path, k32f *value)
	Gets child item content as a k32f value. More...
kStatus	kDataTree_Child32s (kDataTree tree, kDataTreeItem parent, const kChar *path, k32s *value)
	Gets child item content as a k32s value. More...
kStatus	kDataTree_Child32u (kDataTree tree, kDataTreeItem parent, const kChar *path, k32u *value)
	Gets child item content as a k32u value. More...
kStatus	kDataTree_Child64f (kDataTree tree, kDataTreeItem parent, const kChar *path, k64f *value)
	Gets child item content as a k64f value. More...
kStatus	kDataTree_Child64s (kDataTree tree, kDataTreeItem parent, const kChar *path, k64s *value)
	Gets child item content as a k64s value. More...
kStatus	kDataTree_Child64u (kDataTree tree, kDataTreeItem parent, const kChar *path, k64u *value)
	Gets child item content as a k64u value. More...
kDataTreeItem	kDataTree_ChildAt (kDataTree tree, kDataTreeItem parent, k32u index)
	Returns a child item at a specific index within the list of child items for the given parent item. More...
kStatus	kDataTree_ChildBool (kDataTree tree, kDataTreeItem parent, const kChar *path, kBool *value)
	Gets child item content as a kBool value. More...
k32u	kDataTree_ChildCount (kDataTree tree, kDataTreeItem parent)
	Returns the number of child items for the given parent item. More...
kStatus	kDataTree_ChildData (kDataTree tree, kDataTreeItem parent, const kChar *path, kObject *value, kAlloc allocator)
	Gets child item content as a text value. More...
kStatus	kDataTree_ChildItem (kDataTree tree, kDataTreeItem parent, const kChar *path, kDataTreeItem *item)
	Gets a child item by path. More...
kStatus	kDataTree_ChildSize (kDataTree tree, kDataTreeItem parent, const kChar *path, kSize *value)
	Gets child item content as a kSize value. More...
kStatus	kDataTree_ChildSSize (kDataTree tree, kDataTreeItem parent, const kChar *path, kSSize *value)
	Gets child item content as a kSSize value. More...
kStatus	kDataTree_ChildText (kDataTree tree, kDataTreeItem parent, const kChar *path, kChar *value, k32u capacity)
	Gets child item content as a text value. More...
kStatus	kDataTree_Clear (kDataTree tree)
	Removes all elements from the tree. More...
kStatus	kDataTree_Construct (kDataTree *tree, kAlloc allocator)
	Constructs a data tree object. More...
kStatus	kDataTree_Delete (kDataTree tree, kDataTreeItem item)
	Deletes an item from the tree. More...
kDataTreeItem	kDataTree_FirstChild (kDataTree tree, kDataTreeItem item)
	Returns the first child of the given tree item. More...
kStatus	kDataTree_Insert (kDataTree tree, kDataTreeItem parent, kDataTreeItem before, const kChar *name, kDataTreeItem *item)
	Inserts a new item before the specified sibling node. More...
kStatus	kDataTree_Item32f (kDataTree tree, kDataTreeItem item, k32f *value)
	Gets item content as a k32f value. More...
kStatus	kDataTree_Item32s (kDataTree tree, kDataTreeItem item, k32s *value)
	Gets item content as a k32s value. More...
kStatus	kDataTree_Item32u (kDataTree tree, kDataTreeItem item, k32u *value)
	Gets item content as a k32u value. More...
kStatus	kDataTree_Item64f (kDataTree tree, kDataTreeItem item, k64f *value)
	Gets item content as a k64f value. More...
kStatus	kDataTree_Item64s (kDataTree tree, kDataTreeItem item, k64s *value)
	Gets item content as a k64s value. More...
kStatus	kDataTree_Item64u (kDataTree tree, kDataTreeItem item, k64u *value)
	Gets item content as a k64u value. More...
kStatus	kDataTree_ItemBool (kDataTree tree, kDataTreeItem item, kBool *value)
	Gets item content as a kBool value. More...
kObject	kDataTree_ItemContent (kDataTree tree, kDataTreeItem item)
	Returns the data object owned by a tree item. More...
kStatus	kDataTree_ItemData (kDataTree tree, kDataTreeItem item, kObject *value, kAlloc allocator)
	Gets item content as a data object. More...
const kChar *	kDataTree_ItemName (kDataTree tree, kDataTreeItem item)
	Returns the name of a tree item. More...
kStatus	kDataTree_ItemSize (kDataTree tree, kDataTreeItem item, kSize *value)
	Gets item content as a kSize value. More...
kStatus	kDataTree_ItemSSize (kDataTree tree, kDataTreeItem item, kSSize *value)
	Gets item content as a kSSize value. More...
kStatus	kDataTree_ItemText (kDataTree tree, kDataTreeItem item, kChar *value, k32u capacity)
	Gets item content as a text value. More...
kDataTreeItem	kDataTree_LastChild (kDataTree tree, kDataTreeItem item)
	Returns the last child of the given tree item. More...
kStatus	kDataTree_Move (kDataTree tree, kDataTreeItem source, kDataTreeItem destParent, kDataTreeItem destBefore)
	Moves a node from one location in the tree to another location. More...
kDataTreeItem	kDataTree_NextSibling (kDataTree tree, kDataTreeItem item)
	Returns the next sibling of the given tree item. More...
kDataTreeItem	kDataTree_Parent (kDataTree tree, kDataTreeItem item)
	Returns the parent of the given tree item. More...
kDataTreeItem	kDataTree_PreviousSibling (kDataTree tree, kDataTreeItem item)
	Returns the previous sibling of the given tree item. More...
kStatus	kDataTree_PutChildData (kDataTree tree, kDataTreeItem parent, const kChar *path, kObject value)
	Sets child content to a particular data object. More...
kStatus	kDataTree_PutItemData (kDataTree tree, kDataTreeItem item, kObject value)
	Sets item content to a particular data object. More...
kDataTreeItem	kDataTree_Root (kDataTree tree)
	Returns the root element of the data tree. More...
kStatus	kDataTree_SetChild32f (kDataTree tree, kDataTreeItem parent, const kChar *path, k32f value)
	Sets child item content from a k32f value. More...
kStatus	kDataTree_SetChild32s (kDataTree tree, kDataTreeItem parent, const kChar *path, k32s value)
	Sets child item content from a k32s value. More...
kStatus	kDataTree_SetChild32u (kDataTree tree, kDataTreeItem parent, const kChar *path, k32u value)
	Sets child item content from a k32u value. More...
kStatus	kDataTree_SetChild64f (kDataTree tree, kDataTreeItem parent, const kChar *path, k64f value)
	Sets child item content from a k64f value. More...
kStatus	kDataTree_SetChild64s (kDataTree tree, kDataTreeItem parent, const kChar *path, k64s value)
	Sets child item content from a k64s value. More...
kStatus	kDataTree_SetChild64u (kDataTree tree, kDataTreeItem parent, const kChar *path, k64u value)
	Sets child item content from a k64u value. More...
kStatus	kDataTree_SetChildBool (kDataTree tree, kDataTreeItem parent, const kChar *path, kBool value)
	Sets child item content from a kBool value. More...
kStatus	kDataTree_SetChildData (kDataTree tree, kDataTreeItem parent, const kChar *path, kObject value)
	Sets child content by cloning a data object. More...
kStatus	kDataTree_SetChildSize (kDataTree tree, kDataTreeItem parent, const kChar *path, kSize value)
	Sets child item content from a kSize value. More...
kStatus	kDataTree_SetChildSSize (kDataTree tree, kDataTreeItem parent, const kChar *path, kSSize value)
	Sets child item content from a kSSize value. More...
kStatus	kDataTree_SetChildText (kDataTree tree, kDataTreeItem parent, const kChar *path, const kChar *value)
	Sets child item content from a text value. More...
kStatus	kDataTree_SetItem32f (kDataTree tree, kDataTreeItem item, k32f value)
	Sets item content from a k32f value. More...
kStatus	kDataTree_SetItem32s (kDataTree tree, kDataTreeItem item, k32s value)
	Sets item content from a k32s value. More...
kStatus	kDataTree_SetItem32u (kDataTree tree, kDataTreeItem item, k32u value)
	Sets item content from a k32u value. More...
kStatus	kDataTree_SetItem64f (kDataTree tree, kDataTreeItem item, k64f value)
	Sets item content from a k64f value. More...
kStatus	kDataTree_SetItem64s (kDataTree tree, kDataTreeItem item, k64s value)
	Sets item content from a k64s value. More...
kStatus	kDataTree_SetItem64u (kDataTree tree, kDataTreeItem item, k64u value)
	Sets item content from a k64u value. More...
kStatus	kDataTree_SetItemBool (kDataTree tree, kDataTreeItem item, kBool value)
	Sets item content from a kBool value. More...
kStatus	kDataTree_SetItemData (kDataTree tree, kDataTreeItem item, kObject value)
	Sets item content by cloning a data object. More...
kStatus	kDataTree_SetItemName (kDataTree tree, kDataTreeItem item, const kChar *name)
	Sets the name of a tree item. More...
kStatus	kDataTree_SetItemSize (kDataTree tree, kDataTreeItem item, kSize value)
	Sets item content from a kSize value. More...
kStatus	kDataTree_SetItemSSize (kDataTree tree, kDataTreeItem item, kSSize value)
	Sets item content from a kSSize value. More...
kStatus	kDataTree_SetItemText (kDataTree tree, kDataTreeItem item, const kChar *value)
	Sets item content from a text value. More...
Public Member Functions inherited from kObject
kAlloc	kObject_Alloc (kObject object)
	Gets the memory allocator associated with this object. More...
kAllocTrait	kObject_AllocTraits (kObject object)
	Gets the bitset of allocator traits for any allocators used within this object, including aggregated child elements. More...
kStatus	kObject_Clone (kObject *object, kObject source, kAlloc objectAllocator)
	Constructs a new object by copying an existing object, including any aggregated child elements. More...
kStatus	kObject_Clone (kObject *object, kObject source, kAlloc objectAllocator, kAlloc valueAllocator, kObject context=kNULL)
	Constructs a new object by copying an existing object, including any aggregated child elements. More...
kStatus	kObject_Destroy (kObject object)
	Destroys the object. More...
kStatus	kObject_Dispose (kObject object)
	Destroys the object and any aggregated child elements. More...
kBool	kObject_Equals (kObject object, kObject other)
	Determines whether the object is equal to another object. More...
kBool	kObject_HasForeignData (kObject object)
	Reports whether the object, including aggregated child elements, contains any foreign memory references. More...
kSize	kObject_HashCode (kObject object)
	Gets a hash code representing the state of this object. More...
kBool	kObject_HasShared (kObject object)
	Reports whether an object or any of its aggregated child elements has a reference count greater than one. More...
kBool	kObject_Is (kObject object, kType type)
	Determines whether this object is an instance of the specified type. More...
kBool	kObject_IsShared (kObject object)
	Reports whether the object is currently shared (reference count greater than one). More...
kStatus	kObject_SetPool (kObject object, kObjectPool pool)
	Sets the object pool associated with this object. More...
kStatus	kObject_Share (kObject object)
	Increments the reference count associated with this object. More...
kSize	kObject_Size (kObject object)
	Estimates the memory consumed by this object, including any aggregated child elements. More...
kType	kObject_Type (kObject object)
	Returns the type of the object. More...

Additional Inherited Members
Protected Member Functions inherited from kObject
kStatus	kObject_FreeMem (kObject object, void *mem)
	Protected method called by derived classes to free memory using the object's allocator. More...
kStatus	kObject_FreeMemRef (kObject object, void *mem)
	Protected method called by derived classes to free memory (and reset the provided memory pointer to kNULL) using the object's allocator. More...
kStatus	kObject_GetMem (kObject object, kSize size, void *mem)
	Protected method called by derived classes to allocate memory using the object's allocator. More...
kStatus	kObject_GetMemZero (kObject object, kSize size, void *mem)
	Protected method called by derived classes to allocate and zero memory using the object's allocator. More...
kStatus	kObject_Init (kObject object, kType type, kAlloc alloc)
	Protected method called by derived classes to initialize the kObject base class. More...
kAllocTrait	kObject_VAllocTraits (kObject object)
	Protected virtual method that gets the bitset of allocator traits for any allocators used within this object, including aggregated child elements. More...
kStatus	kObject_VClone (kObject object, kObject source, kAlloc valueAllocator, kObject context)
	Protected virtual method that clones (makes a deep copy of) the specified source object. More...
kStatus	kObject_VDisposeItems (kObject object)
	Protected virtual method that destroys any aggregated child objects associated with a collection. More...
kBool	kObject_VEquals (kObject object, kObject other)
	Protected virtual method that compares two objects for equality. More...
kSize	kObject_VHashCode (kObject object)
	Protected virtual method that calculates a hash code representing the object instance. More...
kBool	kObject_VHasShared (kObject object)
	Protected virtual method that reports whether an object or any of its aggregated child elements has a reference count greater than one. More...
kStatus	kObject_VRelease (kObject object)
	Protected virtual method that deallocates any resources owned by the object. More...
kSize	kObject_VSize (kObject object)
	Protected virtual method that calculates the total size (in bytes) of the object instance. More...

---

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

• Data/kDataTree.h