tvDelete: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(45 intermediate revisions by 4 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
|arg= local


|eff= local |= Effects in MP
|eff= local
____________________________________________________________________________________________


| Removes an item with given [[Tree View Path]] from Tree View. The paths of other items on the same branch are updated accordingly and may change. |= Description
|descr= Removes an item with given [[Tree View Path]] from Tree View.
____________________________________________________________________________________________
{{Feature|important|The paths of other items on the same branch after delete operation are updated accordingly; therefore, when deleting multiple entries, start with the one with the highest index and proceed in reverse order.}}


| '''tvDelete''' [idc, path] |= Syntax
|s1= [[tvDelete]] [idc, path]


|p1= [idc, path]: [[Array]] |PARAMETER1=
|p1= idc: [[Number]]


|p2= idc: [[Number]] |PARAMETER2=
|p2= path: [[Array]] - [[Tree View Path]] of the item


|p3= path: [[Array]] - [[Tree View Path]] of the item |PARAMETER3=
|r1= [[Nothing]]


| [[Nothing]] |RETURNVALUE=
|s2= control [[tvDelete]] path
____________________________________________________________________________________________


| s2= control [[tvDelete]] path |= Syntax
|p21= control: [[Control]]


| p21= control: [[Control]] |PARAMETER1=
|p22= path: [[Array]] - [[Tree View Path]] of the item


| p22= path: [[Array]] - [[Tree View Path]] of the item |PARAMETER2=
|r2= [[Nothing]]


| r2= [[Nothing]] |RETURNVALUE=
|x1= <sqf>tvDelete [101, [0, 0]];</sqf>
____________________________________________________________________________________________


|x2= <sqf>_ctrl tvDelete [0, 0];</sqf>


|x1= <code>[[tvDelete]] [101, [0, 0]];</code> |= Example 1
|seealso= [[tvAdd]] [[tvClear]] [[tvCollapse]] [[tvCount]] [[tvCurSel]] [[tvData]] [[tvExpand]] [[tvPicture]] [[tvSetCurSel]] [[tvSetData]] [[tvSetPicture]] [[tvSetValue]] [[tvSort]] [[tvSortByValue]] [[tvText]] [[tvValue]]
 
|x2= <code>_ctrl [[tvDelete]] [0, 0];</code> |= Example 2
____________________________________________________________________________________________
 
| [[tvAdd]], [[tvClear]], [[tvCollapse]], [[tvCount]], [[tvCurSel]], [[tvData]], [[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 on 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 12)
[[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 16:47, 15 August 2022

Hover & click on the images for description

Description

Description:
Removes an item with given Tree View Path from Tree View.
The paths of other items on the same branch after delete operation are updated accordingly; therefore, when deleting multiple entries, start with the one with the highest index and proceed in reverse order.
Groups:
GUI Control - Tree View

Syntax

Syntax:
tvDelete [idc, path]
Parameters:
idc: Number
path: Array - Tree View Path of the item
Return Value:
Nothing

Alternative Syntax

Syntax:
control tvDelete path
Parameters:
control: Control
path: Array - Tree View Path of the item
Return Value:
Nothing

Examples

Example 1:
tvDelete [101, [0, 0]];
Example 2:
_ctrl tvDelete [0, 0];

Additional Information

See also:
tvAdd tvClear tvCollapse tvCount tvCurSel tvData tvExpand tvPicture tvSetCurSel tvSetData tvSetPicture tvSetValue tvSort tvSortByValue tvText tvValue

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