doc/salome/gui/input/using_find_tool.rst

   1 .. _using_find_tool_page:
   2
   3 ***************
   4 Using Find Tool
   5 ***************
   6
   7 The **Object Browser** is supplied with the **Find** toolbox. This tool
   8 allows performing context search of the items in the Object Browser:
   9
  10 .. image:: ../images/findtool1.png
  11         :align: center
  12
  13 The **Find** toolbox can be invoked in several ways:
  14
  15 - Pressing :kbd:`Ctrl-F` key combination starts a new search; the text previously input by the user in the edit control of the **Find** toolbox is automatically selected.
  16 - Pressing :kbd:`/` (slash) key starts a new search; the text previously input by the user is cleared.
  17 - Pressing :kbd:`F3` key repeats the previous search in the forward direction (from top to bottom).
  18 - Pressing :kbd:`Shift-F3` key repeats the previous search in the backward direction (from bottom to top).
  19 - Activating *Find* command from the Object Browser context popup menu starts a new search (the same as :kbd:`Ctrl-F`).
  20
  21 Pressing :kbd:`Escape` key closes the **Find** toolbox.
  22
  23 The search is always started from the first selected item in
  24 the Object Browser. If there are no selected items, the search is
  25 started from the top of the Object Browser contents. If there is an
  26 item which satisfies the search conditions, it is selected and the
  27 Object Browser is expanded to show this item (if it is collapsed).
  28
  29 The **Find** toolbox provides a set of widgets which are used to
  30 perform the search operations or change the search conditions:
  31
  32 - *"Close"* button closes the **Find** toolbox.
  33 - Line edit box is used to input the searched text. Note that the search is always done by the object name, i.e. by the data displayed in the "Name" column of the Object Browser.
  34 - *"Find first item"* button searches the very first item which satisfies the search conditions.
  35 - *"Find previous item"* button searches the previous item which satisfies the search conditions.
  36 - *"Find next item"* button searches the next item which satisfies the search conditions.
  37 - *"Find last item"* button searches the very last item which satisfies the search conditions.
  38 - *"Case sensitive"* check box allows performing case sensitive search.
  39 - *"Regular Expression"* check box allows performing the search of the items by the regular expression, for example:
  40
  41   - *Face* - matches all faces
  42   - *Face_[\\d]* - matches Face_1, Face_2, etc.. (all faces)
  43   - *Face_[\\d]$* - matches Face_1, Face_2, but does not match Face_11, Face_12.
  44   - *^Face_[\\d]$* - the same as above
  45   - *^ Face_[\\d]$* - matches nothing
  46
  47 - *"Wrap search"* check box: if checked and the search reaches the last item, satisfying the search conditions, pressing *"Find Next"* button moves the selection to the very first item which matches the search conditions (i.e. a cyclic search is performed).
  48
  49         If there are no items satisfying the search conditions in the Object Browser, the edit control of the **Find** toolbox becomes red-colored:
  50
  51 .. image:: ../images/findtool2.png
  52         :align: center
  53
  54 The **Find** toolbox also has an auto-hiding feature. This works as follows:
  55
  56 - If the input focus is inside the **Find** toolbox, auto-hiding is automatically deactivated.
  57 - If the input focus moves outside the **Find** toolbox, it hides automatically in 10 seconds after the last search operation (which can be done by clicking * "Find Next"*, *"Find Previous"* button, or typing something in the edit field); each new search operation restarts the auto-hide timer.
  58
  59