Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kDataTree.h
Go to the documentation of this file.
1 
10 #ifndef K_API_DATA_TREE_H
11 #define K_API_DATA_TREE_H
12 
13 #include <kApi/kApiDef.h>
14 
21 //typedef kObject kDataTree; --forward-declared in kApiDef.x.h
22 
29 //typedef kObject kDataTreeItem; --forward-declared in kApiDef.x.h
30 
41 kFx(kStatus) kDataTree_Construct(kDataTree* tree, kAlloc allocator);
42 
53 kFx(kStatus) kDataTree_Add(kDataTree tree, kDataTreeItem parent, const kChar* name, kDataTreeItem* item);
54 
66 kFx(kStatus) kDataTree_Insert(kDataTree tree, kDataTreeItem parent, kDataTreeItem before, const kChar* name, kDataTreeItem* item);
67 
78 kFx(kStatus) kDataTree_Move(kDataTree tree, kDataTreeItem source, kDataTreeItem destParent, kDataTreeItem destBefore);
79 
88 kFx(kStatus) kDataTree_Delete(kDataTree tree, kDataTreeItem item);
89 
97 kFx(kStatus) kDataTree_Clear(kDataTree tree);
98 
108 kFx(kStatus) kDataTree_SetItem32u(kDataTree tree, kDataTreeItem item, k32u value);
109 
119 kFx(kStatus) kDataTree_SetItemSize(kDataTree tree, kDataTreeItem item, kSize value);
120 
130 kFx(kStatus) kDataTree_SetItem32s(kDataTree tree, kDataTreeItem item, k32s value);
131 
141 kFx(kStatus) kDataTree_SetItemSSize(kDataTree tree, kDataTreeItem item, kSSize value);
142 
152 kFx(kStatus) kDataTree_SetItemBool(kDataTree tree, kDataTreeItem item, kBool value);
153 
163 kFx(kStatus) kDataTree_SetItem64u(kDataTree tree, kDataTreeItem item, k64u value);
164 
174 kFx(kStatus) kDataTree_SetItem64s(kDataTree tree, kDataTreeItem item, k64s value);
175 
185 kFx(kStatus) kDataTree_SetItem32f(kDataTree tree, kDataTreeItem item, k32f value);
186 
196 kFx(kStatus) kDataTree_SetItem64f(kDataTree tree, kDataTreeItem item, k64f value);
197 
207 kFx(kStatus) kDataTree_SetItemText(kDataTree tree, kDataTreeItem item, const kChar* value);
208 
221 kFx(kStatus) kDataTree_PutItemData(kDataTree tree, kDataTreeItem item, kObject value);
222 
235 kFx(kStatus) kDataTree_SetItemData(kDataTree tree, kDataTreeItem item, kObject value);
236 
246 kFx(kStatus) kDataTree_Item32u(kDataTree tree, kDataTreeItem item, k32u* value);
247 
257 kFx(kStatus) kDataTree_ItemSize(kDataTree tree, kDataTreeItem item, kSize* value);
258 
268 kFx(kStatus) kDataTree_Item32s(kDataTree tree, kDataTreeItem item, k32s* value);
269 
279 kFx(kStatus) kDataTree_ItemSSize(kDataTree tree, kDataTreeItem item, kSSize* value);
280 
290 kFx(kStatus) kDataTree_ItemBool(kDataTree tree, kDataTreeItem item, kBool* value);
291 
301 kFx(kStatus) kDataTree_Item64u(kDataTree tree, kDataTreeItem item, k64u* value);
302 
312 kFx(kStatus) kDataTree_Item64s(kDataTree tree, kDataTreeItem item, k64s* value);
313 
323 kFx(kStatus) kDataTree_Item32f(kDataTree tree, kDataTreeItem item, k32f* value);
324 
334 kFx(kStatus) kDataTree_Item64f(kDataTree tree, kDataTreeItem item, k64f* value);
335 
346 kFx(kStatus) kDataTree_ItemText(kDataTree tree, kDataTreeItem item, kChar* value, k32u capacity);
347 
361 kFx(kStatus) kDataTree_ItemData(kDataTree tree, kDataTreeItem item, kObject* value, kAlloc allocator);
362 
373 kFx(kStatus) kDataTree_SetChild32u(kDataTree tree, kDataTreeItem parent, const kChar* path, k32u value);
374 
385 kFx(kStatus) kDataTree_SetChildSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSize value);
386 
397 kFx(kStatus) kDataTree_SetChild32s(kDataTree tree, kDataTreeItem parent, const kChar* path, k32s value);
398 
409 kFx(kStatus) kDataTree_SetChildSSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSSize value);
410 
421 kFx(kStatus) kDataTree_SetChildBool(kDataTree tree, kDataTreeItem parent, const kChar* path, kBool value);
422 
433 kFx(kStatus) kDataTree_SetChild64u(kDataTree tree, kDataTreeItem parent, const kChar* path, k64u value);
434 
445 kFx(kStatus) kDataTree_SetChild64s(kDataTree tree, kDataTreeItem parent, const kChar* path, k64s value);
446 
457 kFx(kStatus) kDataTree_SetChild32f(kDataTree tree, kDataTreeItem parent, const kChar* path, k32f value);
458 
469 kFx(kStatus) kDataTree_SetChild64f(kDataTree tree, kDataTreeItem parent, const kChar* path, k64f value);
470 
481 kFx(kStatus) kDataTree_SetChildText(kDataTree tree, kDataTreeItem parent, const kChar* path, const kChar* value);
482 
496 kFx(kStatus) kDataTree_PutChildData(kDataTree tree, kDataTreeItem parent, const kChar* path, kObject value);
497 
511 kFx(kStatus) kDataTree_SetChildData(kDataTree tree, kDataTreeItem parent, const kChar* path, kObject value);
512 
523 kFx(kStatus) kDataTree_Child32u(kDataTree tree, kDataTreeItem parent, const kChar* path, k32u* value);
524 
535 kFx(kStatus) kDataTree_ChildSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSize* value);
536 
547 kFx(kStatus) kDataTree_Child32s(kDataTree tree, kDataTreeItem parent, const kChar* path, k32s* value);
548 
559 kFx(kStatus) kDataTree_ChildSSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSSize* value);
560 
571 kFx(kStatus) kDataTree_ChildBool(kDataTree tree, kDataTreeItem parent, const kChar* path, kBool* value);
572 
583 kFx(kStatus) kDataTree_Child64u(kDataTree tree, kDataTreeItem parent, const kChar* path, k64u* value);
584 
595 kFx(kStatus) kDataTree_Child64s(kDataTree tree, kDataTreeItem parent, const kChar* path, k64s* value);
596 
607 kFx(kStatus) kDataTree_Child32f(kDataTree tree, kDataTreeItem parent, const kChar* path, k32f* value);
608 
619 kFx(kStatus) kDataTree_Child64f(kDataTree tree, kDataTreeItem parent, const kChar* path, k64f* value);
620 
632 kFx(kStatus) kDataTree_ChildText(kDataTree tree, kDataTreeItem parent, const kChar* path, kChar* value, k32u capacity);
633 
648 kFx(kStatus) kDataTree_ChildData(kDataTree tree, kDataTreeItem parent, const kChar* path, kObject* value, kAlloc allocator);
649 
660 kFx(kStatus) kDataTree_ChildItem(kDataTree tree, kDataTreeItem parent, const kChar* path, kDataTreeItem* item);
661 
669 kFx(kDataTreeItem) kDataTree_Root(kDataTree tree);
670 
679 kFx(kDataTreeItem) kDataTree_Parent(kDataTree tree, kDataTreeItem item);
680 
689 kFx(kDataTreeItem) kDataTree_FirstChild(kDataTree tree, kDataTreeItem item);
690 
699 kFx(kDataTreeItem) kDataTree_LastChild(kDataTree tree, kDataTreeItem item);
700 
709 kFx(kDataTreeItem) kDataTree_NextSibling(kDataTree tree, kDataTreeItem item);
710 
719 kFx(kDataTreeItem) kDataTree_PreviousSibling(kDataTree tree, kDataTreeItem item);
720 
729 kFx(k32u) kDataTree_ChildCount(kDataTree tree, kDataTreeItem parent);
730 
740 kFx(kDataTreeItem) kDataTree_ChildAt(kDataTree tree, kDataTreeItem parent, k32u index);
741 
751 kFx(kStatus) kDataTree_SetItemName(kDataTree tree, kDataTreeItem item, const kChar* name);
752 
761 kFx(const kChar*) kDataTree_ItemName(kDataTree tree, kDataTreeItem item);
762 
775 kFx(kObject) kDataTree_ItemContent(kDataTree tree, kDataTreeItem item);
776 
777 #include <kApi/Data/kDataTree.x.h>
778 
779 #endif
kDataTree::kDataTree_SetItem64s
kStatus kDataTree_SetItem64s(kDataTree tree, kDataTreeItem item, k64s value)
Sets item content from a k64s value.
kDataTree::kDataTree_Item64s
kStatus kDataTree_Item64s(kDataTree tree, kDataTreeItem item, k64s *value)
Gets item content as a k64s value.
k32u
Represents a 32-bit unsigned integer.
kDataTree::kDataTree_Insert
kStatus kDataTree_Insert(kDataTree tree, kDataTreeItem parent, kDataTreeItem before, const kChar *name, kDataTreeItem *item)
Inserts a new item before the specified sibling node.
kDataTree::kDataTree_Child64f
kStatus kDataTree_Child64f(kDataTree tree, kDataTreeItem parent, const kChar *path, k64f *value)
Gets child item content as a k64f value.
kDataTree::kDataTree_SetChildBool
kStatus kDataTree_SetChildBool(kDataTree tree, kDataTreeItem parent, const kChar *path, kBool value)
Sets child item content from a kBool value.
kDataTree::kDataTree_PutChildData
kStatus kDataTree_PutChildData(kDataTree tree, kDataTreeItem parent, const kChar *path, kObject value)
Sets child content to a particular data object.
kDataTree::kDataTree_Child32u
kStatus kDataTree_Child32u(kDataTree tree, kDataTreeItem parent, const kChar *path, k32u *value)
Gets child item content as a k32u value.
kDataTree::kDataTree_SetItemText
kStatus kDataTree_SetItemText(kDataTree tree, kDataTreeItem item, const kChar *value)
Sets item content from a text value.
k64u
Represents a 64-bit unsigned integer.
kDataTree::kDataTree_Child32f
kStatus kDataTree_Child32f(kDataTree tree, kDataTreeItem parent, const kChar *path, k32f *value)
Gets child item content as a k32f value.
kDataTree::kDataTree_ItemName
const kChar * kDataTree_ItemName(kDataTree tree, kDataTreeItem item)
Returns the name of a tree item.
kDataTree::kDataTree_SetChild32u
kStatus kDataTree_SetChild32u(kDataTree tree, kDataTreeItem parent, const kChar *path, k32u value)
Sets child item content from a k32u value.
kDataTree
Represents a tree of data objects.
kDataTree::kDataTree_SetItem64f
kStatus kDataTree_SetItem64f(kDataTree tree, kDataTreeItem item, k64f value)
Sets item content from a k64f value.
kDataTree::kDataTree_ItemSize
kStatus kDataTree_ItemSize(kDataTree tree, kDataTreeItem item, kSize *value)
Gets item content as a kSize value.
kDataTree::kDataTree_SetItemSSize
kStatus kDataTree_SetItemSSize(kDataTree tree, kDataTreeItem item, kSSize value)
Sets item content from a kSSize value.
kSize
Represents an unsigned integer that can store a pointer address.
kAlloc
Abstract base class for memory allocator types.
kDataTree::kDataTree_ChildAt
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...
kDataTree::kDataTree_ItemContent
kObject kDataTree_ItemContent(kDataTree tree, kDataTreeItem item)
Returns the data object owned by a tree item.
kDataTree::kDataTree_ChildData
kStatus kDataTree_ChildData(kDataTree tree, kDataTreeItem parent, const kChar *path, kObject *value, kAlloc allocator)
Gets child item content as a text value.
kDataTree::kDataTree_Move
kStatus kDataTree_Move(kDataTree tree, kDataTreeItem source, kDataTreeItem destParent, kDataTreeItem destBefore)
Moves a node from one location in the tree to another location.
kChar
Represents a single unit (byte) in a UTF-8 character.
kDataTree::kDataTree_ChildCount
k32u kDataTree_ChildCount(kDataTree tree, kDataTreeItem parent)
Returns the number of child items for the given parent item.
kDataTree::kDataTree_ItemBool
kStatus kDataTree_ItemBool(kDataTree tree, kDataTreeItem item, kBool *value)
Gets item content as a kBool value.
kDataTree::kDataTree_PutItemData
kStatus kDataTree_PutItemData(kDataTree tree, kDataTreeItem item, kObject value)
Sets item content to a particular data object.
kSSize
Represents a signed integer that can store a pointer address.
kDataTree::kDataTree_ItemText
kStatus kDataTree_ItemText(kDataTree tree, kDataTreeItem item, kChar *value, k32u capacity)
Gets item content as a text value.
kDataTree::kDataTree_SetItem64u
kStatus kDataTree_SetItem64u(kDataTree tree, kDataTreeItem item, k64u value)
Sets item content from a k64u value.
kDataTree::kDataTree_PreviousSibling
kDataTreeItem kDataTree_PreviousSibling(kDataTree tree, kDataTreeItem item)
Returns the previous sibling of the given tree item.
kDataTree::kDataTree_ChildItem
kStatus kDataTree_ChildItem(kDataTree tree, kDataTreeItem parent, const kChar *path, kDataTreeItem *item)
Gets a child item by path.
kDataTree::kDataTree_Delete
kStatus kDataTree_Delete(kDataTree tree, kDataTreeItem item)
Deletes an item from the tree.
kDataTree::kDataTree_SetChild64f
kStatus kDataTree_SetChild64f(kDataTree tree, kDataTreeItem parent, const kChar *path, k64f value)
Sets child item content from a k64f value.
kDataTree::kDataTree_SetChild32f
kStatus kDataTree_SetChild32f(kDataTree tree, kDataTreeItem parent, const kChar *path, k32f value)
Sets child item content from a k32f value.
kDataTree::kDataTree_SetChildSize
kStatus kDataTree_SetChildSize(kDataTree tree, kDataTreeItem parent, const kChar *path, kSize value)
Sets child item content from a kSize value.
kDataTree::kDataTree_Item32u
kStatus kDataTree_Item32u(kDataTree tree, kDataTreeItem item, k32u *value)
Gets item content as a k32u value.
kDataTree::kDataTree_NextSibling
kDataTreeItem kDataTree_NextSibling(kDataTree tree, kDataTreeItem item)
Returns the next sibling of the given tree item.
kApiDef.h
Core Zen type declarations.
kDataTree::kDataTree_LastChild
kDataTreeItem kDataTree_LastChild(kDataTree tree, kDataTreeItem item)
Returns the last child of the given tree item.
k32s
Represents a 32-bit signed integer.
kDataTree::kDataTree_SetChildData
kStatus kDataTree_SetChildData(kDataTree tree, kDataTreeItem parent, const kChar *path, kObject value)
Sets child content by cloning a data object.
kDataTree::kDataTree_SetChildText
kStatus kDataTree_SetChildText(kDataTree tree, kDataTreeItem parent, const kChar *path, const kChar *value)
Sets child item content from a text value.
kDataTree::kDataTree_SetChildSSize
kStatus kDataTree_SetChildSSize(kDataTree tree, kDataTreeItem parent, const kChar *path, kSSize value)
Sets child item content from a kSSize value.
kDataTree::kDataTree_SetItemBool
kStatus kDataTree_SetItemBool(kDataTree tree, kDataTreeItem item, kBool value)
Sets item content from a kBool value.
k64s
Represents a 64-bit signed integer.
kDataTree::kDataTree_Item32s
kStatus kDataTree_Item32s(kDataTree tree, kDataTreeItem item, k32s *value)
Gets item content as a k32s value.
kDataTree::kDataTree_SetItemData
kStatus kDataTree_SetItemData(kDataTree tree, kDataTreeItem item, kObject value)
Sets item content by cloning a data object.
kDataTree::kDataTree_ItemData
kStatus kDataTree_ItemData(kDataTree tree, kDataTreeItem item, kObject *value, kAlloc allocator)
Gets item content as a data object.
kDataTree::kDataTree_Root
kDataTreeItem kDataTree_Root(kDataTree tree)
Returns the root element of the data tree.
kDataTree::kDataTree_Clear
kStatus kDataTree_Clear(kDataTree tree)
Removes all elements from the tree.
kDataTree::kDataTree_ItemSSize
kStatus kDataTree_ItemSSize(kDataTree tree, kDataTreeItem item, kSSize *value)
Gets item content as a kSSize value.
kDataTree::kDataTree_SetItem32s
kStatus kDataTree_SetItem32s(kDataTree tree, kDataTreeItem item, k32s value)
Sets item content from a k32s value.
kDataTree::kDataTree_Item32f
kStatus kDataTree_Item32f(kDataTree tree, kDataTreeItem item, k32f *value)
Gets item content as a k32f value.
kDataTree::kDataTree_ChildSSize
kStatus kDataTree_ChildSSize(kDataTree tree, kDataTreeItem parent, const kChar *path, kSSize *value)
Gets child item content as a kSSize value.
kDataTree::kDataTree_FirstChild
kDataTreeItem kDataTree_FirstChild(kDataTree tree, kDataTreeItem item)
Returns the first child of the given tree item.
kDataTree::kDataTree_ChildBool
kStatus kDataTree_ChildBool(kDataTree tree, kDataTreeItem parent, const kChar *path, kBool *value)
Gets child item content as a kBool value.
kDataTree::kDataTree_SetChild64s
kStatus kDataTree_SetChild64s(kDataTree tree, kDataTreeItem parent, const kChar *path, k64s value)
Sets child item content from a k64s value.
k32f
Represents a 32-bit floating-point number.
kObject
Root of all Zen classes.
kDataTree::kDataTree_SetChild32s
kStatus kDataTree_SetChild32s(kDataTree tree, kDataTreeItem parent, const kChar *path, k32s value)
Sets child item content from a k32s value.
kStatus
Represents an error code.
kDataTree::kDataTree_Construct
kStatus kDataTree_Construct(kDataTree *tree, kAlloc allocator)
Constructs a data tree object.
kDataTree::kDataTree_Child32s
kStatus kDataTree_Child32s(kDataTree tree, kDataTreeItem parent, const kChar *path, k32s *value)
Gets child item content as a k32s value.
kDataTree::kDataTree_ChildSize
kStatus kDataTree_ChildSize(kDataTree tree, kDataTreeItem parent, const kChar *path, kSize *value)
Gets child item content as a kSize value.
kDataTree::kDataTree_SetItem32f
kStatus kDataTree_SetItem32f(kDataTree tree, kDataTreeItem item, k32f value)
Sets item content from a k32f value.
kDataTree::kDataTree_SetItem32u
kStatus kDataTree_SetItem32u(kDataTree tree, kDataTreeItem item, k32u value)
Sets item content from a k32u value.
kDataTree::kDataTree_Add
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.
kDataTree::kDataTree_SetItemName
kStatus kDataTree_SetItemName(kDataTree tree, kDataTreeItem item, const kChar *name)
Sets the name of a tree item.
k64f
Represents a 64-bit floating-point number.
kDataTree::kDataTree_Item64f
kStatus kDataTree_Item64f(kDataTree tree, kDataTreeItem item, k64f *value)
Gets item content as a k64f value.
kDataTree::kDataTree_SetChild64u
kStatus kDataTree_SetChild64u(kDataTree tree, kDataTreeItem parent, const kChar *path, k64u value)
Sets child item content from a k64u value.
kDataTree::kDataTree_Child64u
kStatus kDataTree_Child64u(kDataTree tree, kDataTreeItem parent, const kChar *path, k64u *value)
Gets child item content as a k64u value.
kDataTreeItem
Represents an item within a tree of data objects.
kBool
Represents a boolean value.
kDataTree::kDataTree_Item64u
kStatus kDataTree_Item64u(kDataTree tree, kDataTreeItem item, k64u *value)
Gets item content as a k64u value.
kDataTree::kDataTree_SetItemSize
kStatus kDataTree_SetItemSize(kDataTree tree, kDataTreeItem item, kSize value)
Sets item content from a kSize value.
kDataTree::kDataTree_Child64s
kStatus kDataTree_Child64s(kDataTree tree, kDataTreeItem parent, const kChar *path, k64s *value)
Gets child item content as a k64s value.
kDataTree::kDataTree_ChildText
kStatus kDataTree_ChildText(kDataTree tree, kDataTreeItem parent, const kChar *path, kChar *value, k32u capacity)
Gets child item content as a text value.
kDataTree::kDataTree_Parent
kDataTreeItem kDataTree_Parent(kDataTree tree, kDataTreeItem item)
Returns the parent of the given tree item.