Salome HOME
Redesign SALOME documentation
[modules/gui.git] / doc / salome / gui / input / using_object_browser.rst
1 .. _using_object_browser_page: 
2
3 ********************
4 Using Object Browser
5 ********************
6
7 The **Object Browser** in SALOME is destined for displaying the
8 structure of the current study in a tree-like form. It contains:
9
10 * components, loaded during the current session
11 * objects created with the help of different components (The objects created with the help of a definite component are located in the folder having the name of this component)
12 * references to different objects (they are highlighted in red)
13
14 .. image:: ../images/objectbrowser1.png
15         :align: center
16
17 .. note:: 
18         The **Object Browser** is destined to getting quick access to different objects created during SALOME session. All pop-up menus associated with the objects displayed in the Object Browser are context-sensitive. So it depends on a definite currently loaded SALOME component what options you will see in the pop-up menu, if you right-click on a definite object in the Object Browser.
19
20 The Object Browser may contain supplementary attributes of the objects
21 displayed in additional columns. By default, these columns are not
22 displayed -  displaying/hiding these columns is possible through
23 :ref:`setting_preferences_page` or right-clicking on the attributes bar and toggling the necessary
24 attributes.
25
26 .. image:: ../images/objectbrowser2.png
27         :align: center
28
29 - **Name**; 
30 - **Entry**  - Identification index of the object in the structure of the study;
31 - **IOR** -  Interoperable Object Reference; 
32 - **Reference entry**  -  Identification index of the references to the objects;
33 - **Value**  -  Displays the value of the first object attribute.
34
35 .. note:: **Entry, IOR and Reference entry** attributes are displayed for debugging purposes only.
36
37 Sorting 
38 #######
39
40 By default the objects in the object browser are sorted in the creation order. 
41
42 However, it is possible to enable sorting in the alphabetical order (or the reverse alphabetical order) by right clicking in the header of the tree (near the **Name** field) and checking "enable sorting" in the context menu.
43
44 It is possible to use the arrow near "Name" to reverse the order.
45
46 If "enable sorting" is unchecked, the objects are sorted in the default order again.
47
48