tvAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(→‎note: tv command family overview)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *I([a-z ])" to "$1 - i$2")
 
(58 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.74


|0.74|= Game version
|gr1= GUI Control - Tree View


|arg= local |= Arguments in MP
|descr= Adds an item with given text to Tree View control. The position on Tree View where to add the item and the actual path to this item once added are different. If item is added to existing item, then parent item path is used. If no parent exists, empty array [] is used. See [[Tree View Path]] for more information.


|eff= local |= Effects in MP
|s1= [[tvAdd]] [idc, pathParent, text]
____________________________________________________________________________________________


| Adds an item with given text to Tree View with given idc under specified path (zero based). |= Description
|p1= idc: [[Number]]
____________________________________________________________________________________________


| [[tvAdd]] [idc, [path], text] |= Syntax
|p2= pathParent: [[Array]] - [[Tree View Path]] of parent item or [] if no parent exists


|p1= [idc, [path], text]: [[Array]] |= PARAMETER1
|p3= text: [[String]]


|p2= idc: [[Number]] |= PARAMETER2
|r1= [[Number]] - index of the added item relative to the branch it was added to


|p3= [path]: [[Array]] - Array containing numbers. |= PARAMETER3
|s2= control [[tvAdd]] [pathParent, text]


|p4= text: [[String]] |= PARAMETER4
|p21= control: [[Control]]


| [[Number]] |= RETURNVALUE
|p22= pathParent: [[Array]] - [[Tree View Path]] of parent item or [] if no parent exists


____________________________________________________________________________________________
|p23= text: [[String]]


| s2= _ctrl [[tvAdd]] [ [path], text] |= Syntax
|r2= [[Number]] - index of the added item relative to the branch it was added to


| p21= _ctrl: [[Control]] |= PARAMETER1
|x1= <sqf>_index = _ctrl tvAdd [[], "Parent Item"];</sqf>


| p22= [ [path], text]: [[Array]] |= PARAMETER2
|x2= <sqf>_index = tvAdd [101, [0], "First item"];</sqf>


| r2= [[Number]] |= RETURNVALUE
|seealso= [[tvClear]] [[tvCollapse]] [[tvCount]] [[tvCurSel]] [[tvData]] [[tvDelete]] [[tvExpand]] [[tvPicture]] [[tvSetCurSel]] [[tvSetData]] [[tvSetValue]] [[tvSort]] [[tvSortByValue]] [[tvValue]] [[tvText]] [[tvSetText]] [[tvSetPicture]] [[tvSetPictureColor]] [[tvSetPictureRight]] [[tvSetPictureRightColor]]
____________________________________________________________________________________________
 
|x1= <code>[[tvAdd]] [101, [0], "First item"];</code> |= Example 1
 
|x2= <code>_ctrl [[tvAdd]] [ [], "Parent_A"];</code> |= Example 2
____________________________________________________________________________________________
 
| [[tvClear]], [[tvCollapse]], [[tvCount]], [[tvCurSel]], [[tvData]], [[tvDelete]], [[tvExpand]], [[tvPicture]], [[tvSetCurSel]], [[tvSetData]], [[tvSetPicture]], [[tvSetValue]], [[tvSort]], [[tvSortByValue]], [[tvText]], [[tvValue]] |= See Also
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted: Sep 11 2014</dd>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">(A3 1.28)tv command fmily overview
<code>
//tv command family available for CT_TREE (type 14)
[[private]] ["_count","_current","_data","_text","_value","_pic"];
_CT_TREE [[tvAdd]] [ [],"Parent_A"];
_CT_TREE [[tvAdd]] [ [0],"Child_A"];
_CT_TREE [[tvAdd]] [ [0,0],"Grandchild_A"];
_CT_TREE [[tvAdd]] [ [],"Parent_B"];
_CT_TREE [[tvAdd]] [ [1],"Child_B"];
[[file:WuChaoRen_CTTree001.png]]
_count = _CT_TREE [[tvCount]] []; //return 2
_CT_TREE [[tvSetCurSel]] [0,0,0]; //select grandchild_A
[[file:WuChaoRen_CTTree003.png]]
_current = [[tvCurSel]] _CT_TREE; //return [0,0,0]
_CT_TREE [[tvSetData]] [_current,"I'm grandchild_A"];
_data = _CT_TREE [[tvData]] _current; // "I'm grandchild_A"
_text = _CT_TREE [[tvText]] _current; //"Grandchild_A"
_CT_TREE [[tvSetValue]] [_current,14];
_value = _CT_TREE [[tvValue]] _current; // 14
_CT_TREE [[tvSetPicture]] [_current,[[getText]] ([[configFile]] >> "CfgWeapons" >> "optic_NVS" >> "picture")];
_pic = _CT_TREE [[tvPicture]] _current;
[[file:WuChaoRen_CTTree004.png]]
_CT_TREE [[tvExpand]] [1];
[[file:WuChaoRen_CTTree005.png]]
_CT_TREE [[tvSort]] [[],[[false]] ];
_CT_TREE [[tvSortByValue]] [[],[[false]] ];
[[file:WuChaoRen_CTTree006.png]]
_CT_TREE [[tvDelete]] [0,0]; //remove child_b
[[tvClear]] 12;
_CT_TREE [[tvCollapse]] [];
[[file:WuChaoRen_CTTree002.png]]
</code>
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:33, 8 November 2023

Hover & click on the images for description

Description

Description:
Adds an item with given text to Tree View control. The position on Tree View where to add the item and the actual path to this item once added are different. If item is added to existing item, then parent item path is used. If no parent exists, empty array [] is used. See Tree View Path for more information.
Groups:
GUI Control - Tree View

Syntax

Syntax:
tvAdd [idc, pathParent, text]
Parameters:
idc: Number
pathParent: Array - Tree View Path of parent item or [] if no parent exists
text: String
Return Value:
Number - index of the added item relative to the branch it was added to

Alternative Syntax

Syntax:
control tvAdd [pathParent, text]
Parameters:
control: Control
pathParent: Array - Tree View Path of parent item or [] if no parent exists
text: String
Return Value:
Number - index of the added item relative to the branch it was added to

Examples

Example 1:
_index = _ctrl tvAdd [[], "Parent Item"];
Example 2:
_index = tvAdd [101, [0], "First item"];

Additional Information

See also:
tvClear tvCollapse tvCount tvCurSel tvData tvDelete tvExpand tvPicture tvSetCurSel tvSetData tvSetValue tvSort tvSortByValue tvValue tvText tvSetText tvSetPicture tvSetPictureColor tvSetPictureRight tvSetPictureRightColor

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note