doc/salome/gui/input/using_object_browser.doc

   1 /*!
   2
   3 \page using_object_browser_page Using Object Browser
   4
   5 The <b>Object Browser</b> in SALOME is destined for displaying the
   6 structure of the current study in a tree-like form. It contains:
   7
   8 <ul>
   9 <li>components, loaded during the current session</li>
  10 <li>objects created with the help of different components (The objects
  11 created with the help of a definite component are located in the
  12 folder having the name of this component)
  13 </li>
  14 <li>references to different objects (they are highlighted in red)</li>
  15 </ul>
  16
  17 \image html objectbrowser1.png
  18
  19 \note The <b>Object Browser</b> is destined to getting quick access to
  20 different objects created during SALOME session. All pop-up menus
  21 associated with the objects displayed in the Object Browser are
  22 context-sensitive. So it depends on a definite currently loaded SALOME
  23 component what options you will see in the pop-up menu, if you
  24 right-click on a definite object in the Object Browser.
  25
  26 The Object Browser may contain supplementary attributes of the objects
  27 displayed in additional columns. By default, these columns are not
  28 displayed -  displaying/hiding these columns is possible through
  29 \ref setting_preferences_page "setting study preferences" or
  30 right-clicking on the attributes bar and toggling the necessary
  31 attributes.
  32
  33 \image html objectbrowser2.png
  34
  35 <ul>
  36 <li>\b Entry  - Identification index of the object in the structure of
  37 the study</li>
  38 <li>\b IOR -  Interoperable Object Reference</li>
  39 <li><b>Reference entry</b>  -  Identification index of the references
  40 to the objects</li>
  41 <li>\b Value  -  Displays the value of the first object attribute</li>
  42 </ul>
  43
  44 \note <b>Entry, IOR and Reference entry</b> attributes are displayed for debugging purposes only.
  45
  46 <h2> Enable sorting </h2>
  47
  48 By default the objects in the object browser are sorted in the creation order.
  49 \n
  50 However, it is possible to enable sorting
  51 in the alphabetical order (or the reverse alphabetical order) by right
  52 clicking in the header of the tree (near the "Name" field) and
  53 checking "enable sorting" in the popup menu.
  54 \n
  55 It is possible to use the arrow near "Name" to reverse the order.
  56 If "enable sorting" is unchecked, the objects are sorted in the default order again.
  57
  58 */