FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kDataTree.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_DATA_TREE_H
9 #define K_FIRESYNC_DATA_TREE_H
10 
11 #include <kFireSync/kFsDef.h>
12 
19 //typedef kObject kDataTree; --forward-declared in kFsDef.x.h
20 
27 //typedef kObject kDataTreeItem; --forward-declared in kFsDef.x.h
28 
39 kFsFx(kStatus) kDataTree_Construct(kDataTree* tree, kAlloc allocator);
40 
51 kFsFx(kStatus) kDataTree_Add(kDataTree tree, kDataTreeItem parent, const kChar* name, kDataTreeItem* item);
52 
64 kFsFx(kStatus) kDataTree_Insert(kDataTree tree, kDataTreeItem parent, kDataTreeItem before, const kChar* name, kDataTreeItem* item);
65 
76 kFsFx(kStatus) kDataTree_Move(kDataTree tree, kDataTreeItem source, kDataTreeItem destParent, kDataTreeItem destBefore);
77 
86 kFsFx(kStatus) kDataTree_Delete(kDataTree tree, kDataTreeItem item);
87 
95 kFsFx(kStatus) kDataTree_Clear(kDataTree tree);
96 
106 kFsFx(kStatus) kDataTree_SetItem32u(kDataTree tree, kDataTreeItem item, k32u value);
107 
117 kFsFx(kStatus) kDataTree_SetItemSize(kDataTree tree, kDataTreeItem item, kSize value);
118 
128 kFsFx(kStatus) kDataTree_SetItem32s(kDataTree tree, kDataTreeItem item, k32s value);
129 
139 kFsFx(kStatus) kDataTree_SetItemSSize(kDataTree tree, kDataTreeItem item, kSSize value);
140 
150 kFsFx(kStatus) kDataTree_SetItemBool(kDataTree tree, kDataTreeItem item, kBool value);
151 
161 kFsFx(kStatus) kDataTree_SetItem64u(kDataTree tree, kDataTreeItem item, k64u value);
162 
172 kFsFx(kStatus) kDataTree_SetItem64s(kDataTree tree, kDataTreeItem item, k64s value);
173 
183 kFsFx(kStatus) kDataTree_SetItem32f(kDataTree tree, kDataTreeItem item, k32f value);
184 
194 kFsFx(kStatus) kDataTree_SetItem64f(kDataTree tree, kDataTreeItem item, k64f value);
195 
205 kFsFx(kStatus) kDataTree_SetItemText(kDataTree tree, kDataTreeItem item, const kChar* value);
206 
219 kFsFx(kStatus) kDataTree_PutItemData(kDataTree tree, kDataTreeItem item, kObject value);
220 
233 kFsFx(kStatus) kDataTree_SetItemData(kDataTree tree, kDataTreeItem item, kObject value);
234 
244 kFsFx(kStatus) kDataTree_Item32u(kDataTree tree, kDataTreeItem item, k32u* value);
245 
255 kFsFx(kStatus) kDataTree_ItemSize(kDataTree tree, kDataTreeItem item, kSize* value);
256 
266 kFsFx(kStatus) kDataTree_Item32s(kDataTree tree, kDataTreeItem item, k32s* value);
267 
277 kFsFx(kStatus) kDataTree_ItemSSize(kDataTree tree, kDataTreeItem item, kSSize* value);
278 
288 kFsFx(kStatus) kDataTree_ItemBool(kDataTree tree, kDataTreeItem item, kBool* value);
289 
299 kFsFx(kStatus) kDataTree_Item64u(kDataTree tree, kDataTreeItem item, k64u* value);
300 
310 kFsFx(kStatus) kDataTree_Item64s(kDataTree tree, kDataTreeItem item, k64s* value);
311 
321 kFsFx(kStatus) kDataTree_Item32f(kDataTree tree, kDataTreeItem item, k32f* value);
322 
332 kFsFx(kStatus) kDataTree_Item64f(kDataTree tree, kDataTreeItem item, k64f* value);
333 
344 kFsFx(kStatus) kDataTree_ItemText(kDataTree tree, kDataTreeItem item, kChar* value, k32u capacity);
345 
359 kFsFx(kStatus) kDataTree_ItemData(kDataTree tree, kDataTreeItem item, kObject* value, kAlloc allocator);
360 
371 kFsFx(kStatus) kDataTree_SetChild32u(kDataTree tree, kDataTreeItem parent, const kChar* path, k32u value);
372 
383 kFsFx(kStatus) kDataTree_SetChildSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSize value);
384 
395 kFsFx(kStatus) kDataTree_SetChild32s(kDataTree tree, kDataTreeItem parent, const kChar* path, k32s value);
396 
407 kFsFx(kStatus) kDataTree_SetChildSSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSSize value);
408 
419 kFsFx(kStatus) kDataTree_SetChildBool(kDataTree tree, kDataTreeItem parent, const kChar* path, kBool value);
420 
431 kFsFx(kStatus) kDataTree_SetChild64u(kDataTree tree, kDataTreeItem parent, const kChar* path, k64u value);
432 
443 kFsFx(kStatus) kDataTree_SetChild64s(kDataTree tree, kDataTreeItem parent, const kChar* path, k64s value);
444 
455 kFsFx(kStatus) kDataTree_SetChild32f(kDataTree tree, kDataTreeItem parent, const kChar* path, k32f value);
456 
467 kFsFx(kStatus) kDataTree_SetChild64f(kDataTree tree, kDataTreeItem parent, const kChar* path, k64f value);
468 
479 kFsFx(kStatus) kDataTree_SetChildText(kDataTree tree, kDataTreeItem parent, const kChar* path, const kChar* value);
480 
494 kFsFx(kStatus) kDataTree_PutChildData(kDataTree tree, kDataTreeItem parent, const kChar* path, kObject value);
495 
509 kFsFx(kStatus) kDataTree_SetChildData(kDataTree tree, kDataTreeItem parent, const kChar* path, kObject value);
510 
521 kFsFx(kStatus) kDataTree_Child32u(kDataTree tree, kDataTreeItem parent, const kChar* path, k32u* value);
522 
533 kFsFx(kStatus) kDataTree_ChildSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSize* value);
534 
545 kFsFx(kStatus) kDataTree_Child32s(kDataTree tree, kDataTreeItem parent, const kChar* path, k32s* value);
546 
557 kFsFx(kStatus) kDataTree_ChildSSize(kDataTree tree, kDataTreeItem parent, const kChar* path, kSSize* value);
558 
569 kFsFx(kStatus) kDataTree_ChildBool(kDataTree tree, kDataTreeItem parent, const kChar* path, kBool* value);
570 
581 kFsFx(kStatus) kDataTree_Child64u(kDataTree tree, kDataTreeItem parent, const kChar* path, k64u* value);
582 
593 kFsFx(kStatus) kDataTree_Child64s(kDataTree tree, kDataTreeItem parent, const kChar* path, k64s* value);
594 
605 kFsFx(kStatus) kDataTree_Child32f(kDataTree tree, kDataTreeItem parent, const kChar* path, k32f* value);
606 
617 kFsFx(kStatus) kDataTree_Child64f(kDataTree tree, kDataTreeItem parent, const kChar* path, k64f* value);
618 
630 kFsFx(kStatus) kDataTree_ChildText(kDataTree tree, kDataTreeItem parent, const kChar* path, kChar* value, k32u capacity);
631 
646 kFsFx(kStatus) kDataTree_ChildData(kDataTree tree, kDataTreeItem parent, const kChar* path, kObject* value, kAlloc allocator);
647 
658 kFsFx(kStatus) kDataTree_ChildItem(kDataTree tree, kDataTreeItem parent, const kChar* path, kDataTreeItem* item);
659 
667 kFsFx(kDataTreeItem) kDataTree_Root(kDataTree tree);
668 
677 kFsFx(kDataTreeItem) kDataTree_Parent(kDataTree tree, kDataTreeItem item);
678 
687 kFsFx(kDataTreeItem) kDataTree_FirstChild(kDataTree tree, kDataTreeItem item);
688 
697 kFsFx(kDataTreeItem) kDataTree_LastChild(kDataTree tree, kDataTreeItem item);
698 
707 kFsFx(kDataTreeItem) kDataTree_NextSibling(kDataTree tree, kDataTreeItem item);
708 
717 kFsFx(kDataTreeItem) kDataTree_PreviousSibling(kDataTree tree, kDataTreeItem item);
718 
727 kFsFx(k32u) kDataTree_ChildCount(kDataTree tree, kDataTreeItem parent);
728 
738 kFsFx(kDataTreeItem) kDataTree_ChildAt(kDataTree tree, kDataTreeItem parent, k32u index);
739 
749 kFsFx(kStatus) kDataTree_SetItemName(kDataTree tree, kDataTreeItem item, const kChar* name);
750 
759 kFsFx(const kChar*) kDataTree_ItemName(kDataTree tree, kDataTreeItem item);
760 
773 kFsFx(kObject) kDataTree_ItemContent(kDataTree tree, kDataTreeItem item);
774 
775 #include <kFireSync/Data/kDataTree.x.h>
776 
777 #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.
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.
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.
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.
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.
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.
kFsDef.h
Essential API declarations for the kFireSync library.
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.
kDataTree::kDataTree_LastChild
kDataTreeItem kDataTree_LastChild(kDataTree tree, kDataTreeItem item)
Returns the last child of the given tree item.
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.
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.
kDataTree::kDataTree_SetChild32s
kStatus kDataTree_SetChild32s(kDataTree tree, kDataTreeItem parent, const kChar *path, k32s value)
Sets child item content from a k32s value.
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.
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.
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.