View source for Tree view

{{TOCright}}

== Introduction == 
The [[Tree_view|Tree view]] appears in the upper section of the '''Model''' panel (if the [[Combo_view|Combo view]] is active) or as a stand-alone panel. It shows all user defined objects that are part of a LabRPS document. The Tree view is a representation of the [[Document_structure|document's structure]], and indicates what information is saved to disk.

These objects don't necessarily have to be random phenomenon simulation feature visible in the [[Dependency_graph_view|Dependency graph view]], but can also be supporting data objects created with any of the [[Workbenches|workbenches]].

[[File:LabRPS_Tree_view.png]]

{{Caption|The Tree view showing various elements in the document.}}

== Working with the Tree view == 

By default, whenever a new object is created, it is added to the end of the list in the Tree view. The Tree view allows managing the objects to keep them organized; it permits creating [[Std_Group|groups]], moving objects inside groups, moving groups inside other groups, relabeling objects, copying objects, deleting objects, and using options from its [[#Context_menu|context menu]].

=== Tree view columns === 

The Tree view always displays two column with the icons and labels of objects in the first one and the the  description in the second one.

=== Edit object label === 

Select an object in the first column and press {{KEY|F2}} (on Windows and Linux), or {{KEY|Enter}} (on macOS), to edit its {{PropertyData|Label}} property. This property can also be edited via the context menu option {{MenuCommand|Rename}} or in the [[Property_editor|Property editor]].

=== Edit object description === 

An object can optionally have a description. This information is stored in its {{PropertyData|Label2}} property. If the description column is displayed you can edit this property by selecting an object in that column and pressing {{KEY|F2}} (on Windows and Linux), or {{KEY|Enter}} (on macOS). The property can also be changed in the [[Property_editor|Property editor]].

=== Context menu === 

The options in the context menu of the Tree view depend on the selected object(s) and the currently active workbench. To display this menu right-click the background of the list, right-click an object in the list, or select multiple objects in the list and then right-click one of them.

=== Keyboard modifiers === 

The usual keyboard modifiers can be used in the Tree view. The modifiers can be combined as well.
* {{KEY|Ctrl}}: hold down this key to select multiple objects.
* {{KEY|Shift}}: hold down this key to select all objects between a previously selected object and the next selected object.

=== Keyboard shortcuts === 

The following keyboard shortcuts are available when the focus is on the Tree view:
* {{KEY|Ctrl}}+{{KEY|F}}: opens a search box at the bottom of the tree, allowing to search and reach objects using their internal names or labels.
* Expand and collapse actions using {{KEY|Alt}}+{{KEY|Arrow}} combinations:
** {{KEY|Alt}}+{{KEY|Left}}: collapses selected item(s).
** {{KEY|Alt}}+{{KEY|Right}}: expands selected item(s).
** {{KEY|Alt}}+{{KEY|Up}}: expands selected item(s) with all their tier-1 children collapsed (deeper children remain unchanged).
** {{KEY|Alt}}+{{KEY|Down}}: expands selected item(s) with all their tier-1 children expanded as well (deeper children remain unchanged).

== Overlay icons == 

One or more overlay icons can be displayed on top of an object's default icon in the Tree view. The available overlay icons and their meaning are listed below.

=== [[File:LabRPS_Tree_view_recompute.png]] White check mark on blue background === 

This indicates that the object has to be [[Std_Refresh|recomputed]], due to changes made to the document or because the user marked the object in the Tree view context menu to be recomputed. In most cases recomputes are triggered automatically, but sometimes they are delayed for performance reasons.

=== [[File:LabRPS_Tree_view_error.png]] White exclamation mark on red background === 

This indicates that the object has an error that needs to be fixed. After recomputing the whole document a tooltip describing the error is shown when you hover the mouse over the object in the Tree view. Note: All other objects depending on an object in such an error state will not be properly recomputed, thus they may still show some old state.

== Preferences == 

See [[Combo_view#Preferences|Combo view]].


{{Interface_navi}}
{{Std_Base_navi}}
{{Userdocnavi}}