doc/salome/gui/input/using_find_tool.doc

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