From: vsr Date: Fri, 28 Mar 2008 07:59:45 +0000 (+0000) Subject: IPAL19251 X-Git-Tag: V5_0_0a1~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=2bd2b33377123f93a651c39f2944503002bee8b2;p=modules%2Fgui.git IPAL19251 --- diff --git a/doc/salome/gui/GUI/images/findtool1.png b/doc/salome/gui/GUI/images/findtool1.png new file mode 100644 index 000000000..c0577ba66 Binary files /dev/null and b/doc/salome/gui/GUI/images/findtool1.png differ diff --git a/doc/salome/gui/GUI/images/findtool2.png b/doc/salome/gui/GUI/images/findtool2.png new file mode 100644 index 000000000..a01966736 Binary files /dev/null and b/doc/salome/gui/GUI/images/findtool2.png differ diff --git a/doc/salome/gui/GUI/input/gui_module_chapter.doc b/doc/salome/gui/GUI/input/gui_module_chapter.doc index 3d4f43ce0..bc95ea061 100644 --- a/doc/salome/gui/GUI/input/gui_module_chapter.doc +++ b/doc/salome/gui/GUI/input/gui_module_chapter.doc @@ -17,6 +17,7 @@
  • \ref setting_study_properties_page
  • \subpage using_object_browser_page
    • +
  • \subpage using_find_tool_page
  • \subpage using_registry_tool_page
  • \subpage using_catalog_generator_page "Using Catalog Generator"
  • \subpage viewers_page
    • diff --git a/doc/salome/gui/GUI/input/index.doc b/doc/salome/gui/GUI/input/index.doc index 1f340a405..1f4d18053 100644 --- a/doc/salome/gui/GUI/input/index.doc +++ b/doc/salome/gui/GUI/input/index.doc @@ -28,6 +28,7 @@
  • \ref using_object_browser_page
    • +
  • \ref using_find_tool_page
  • \ref using_registry_tool_page
  • \ref using_catalog_generator_page "Using Catalog Generator"
  • \ref viewers_page
    • diff --git a/doc/salome/gui/GUI/input/using_find_tool.doc b/doc/salome/gui/GUI/input/using_find_tool.doc new file mode 100644 index 000000000..2c567ce62 --- /dev/null +++ b/doc/salome/gui/GUI/input/using_find_tool.doc @@ -0,0 +1,76 @@ +/*! + +\page using_find_tool_page Using Find toolbox + +The Object Browser is supplied with the \b Find toolbox. This tool +allows performing context search of the items in the Object Browser: + +\image html findtool1.png + +The \b Find toolbox can be invoked in several ways: +- Pressing \a <Ctrl>-<F> key combination starts new +search; the text previously entered by the user in the edit control of +the \b Find toolbox is automatically selected. +- Pressing \a </> (slash) key starts new search; the text +previously entered by the user is cleared. +- Pressing \a <F3> key repeats previous search in the forward +direction (from top to bottom). +- Pressing \a <Shift>-<F3> key repeats previous search in +the backward direction (from bottom to top). +- Activating \a Find command from the Object Browser context popup +menu starts new search (the same as \a <Ctrl>-<F>). + +Pressing \a <Escape> key closes the \b Find toolbox. + +The search is always started beginning from the first selected item in +the Object Browser. If there are no selected items, the search is +started from the top of the Object Browser contents. If there is an +item which satisfies the search conditions, it is selected and +Object Browser is expanded to show this item (if it is collapsed). + +The \b Find toolbox provides a set of widgets which are used to +perform the search operations or affect on the search conditions: +- \a "Close" button closes the \b Find toolbox. +- Line edit box is used to enter the text to be searched. Note that +search is alwasy done by the object name, i.e. by the data displayed +in the "Name" column of the Object Browser. +- \a "Find first item" button searches the very first item +which satisfies the search condition. +- \a "Find previous item" button searches the previous item +which satisfies the search condition. +- \a "Find next item" button searches the next item +which satisfies the search condition. +- \a "Find last item" button searches the very last item +which satisfies the search condition. +- \a "Case sensitive" check box allows performing case sensitive +search. +- \a "Regular Expression" check box allow performing the search of the +items by the regular expression, for example: + - Face - matches all faces + - Face_[\\d] - matches Face_1, Face_2, etc.. (all faces) + - Face_[\\d]$ - matches Face_1, Face_2, but not matches Face_11, Face_12. + - ^Face_[\\d]$ - same as above + - ^ Face_[\\d]$ - matches nothing + +- \a "Wrap search" check box: when it is switched on and search +reaches last item, satisfying the search conditions, pressing \a "Find +Next" button moves the selection to the very first item which matches +search conditions (i.e. cyclic search is performed). + +If there are no items in the Object Browser which satisfy the search +conditions, the edit control of the \b Find toolbox becomes +red-colored: + +\image html findtool2.png + +The \b Find toolbox has also auto-hiding feature. This works as +follows: +- If input focus is inside the \b Find toolbox, auto-hiding is +automatically deactivated. +- If input focus moves outside the \b Find toolbox, it hides +automatically in 10 seconds after the last search operation (which can +be done by clicking \a "Find Next", \a "Find Previous" button, or typing +something in the edit field); it means that each new search operation +restarts the auto-hide timer. + +*/