Salome HOME
Update users guide for toolbars management part
authormpv <mpv@opencascade.com>
Wed, 30 Jan 2019 12:15:45 +0000 (15:15 +0300)
committermpv <mpv@opencascade.com>
Wed, 30 Jan 2019 12:15:45 +0000 (15:15 +0300)
doc/gui/Introduction.rst
doc/gui/images/create_toolbar.png [new file with mode: 0644]
doc/gui/images/delete_toolbar.png [new file with mode: 0644]
doc/gui/images/name_toolbar.png [new file with mode: 0644]

index d4e2430a52fbcc96ab2fe2df0a0c9fffe74b8eca..73759b85a8d3f7b5c570a2ef381132109a7e50ba 100644 (file)
@@ -608,58 +608,80 @@ Viewer tab defines selection in OCC 3D viewer properties.
 Toolbars management\r
 -------------------\r
 \r
-There is a possibility to modify default toolbars structure.\r
-\r
-To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item. Editing of tool bars can be done with help of two following dialog boxes:\r
-\r
-#. **Toolbars** provides possibility to create a new toolbar or delete an existing.\r
-#. **Edit toolbar** provides possibility to edit content of a toolbar.\r
-\r
 .. _toolbars_dialog:\r
 \r
 **Toolbars** dialog box\r
 ^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-The dialog box looks like following:\r
+To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item. \r
+The following dialog box with existing toolbars appears:\r
 \r
 .. image:: images/Toolbars.png\r
    :align: center\r
 \r
 .. centered::\r
-   **Toolbars** diaqlog box\r
+   **Toolbars** dialog box\r
 \r
-In this dialog box there are following controls:\r
+**Input fields**:\r
 \r
-- **Toolbars** is a window with a list of toolbars names. Number of commands in each tool bar is shown in brackets.\r
-- **Add** a button for creation of a new toolbar. When this button is pressed then a small dialog box with a text input field will uppear. In this diaog box user has to input a name of the new tool bar. The name of tool bar has to be unique. If user defines a not unique name then a warning will be shown.\r
-- **Edit** a button which calls **Edit toolbar** dialog box for currently selected tool bar.\r
-- **Delete** a button to delete currently selected tool bar. If user presses this button then he will have to confirm deletion of the selected toolbar.\r
-- **Reset** a button to reset modified tool bars structure to default one.\r
-- **Ok** button to close the dialog box, store result of tool bars editing and update tool bars of the module.\r
+- **Toolbars** window contains list of toolbars names. Number of commands in each tool bar is shown in brackets.\r
+- **Add** button creates a new toolbar. Click on **Add** button opens  :ref:`create_toolbar`;\r
+- **Edit**  button  calls :ref:`edit_toolbar` for currently selected tool bar;\r
+- **Delete** button removes currently selected tool bar. Click on **Delete** button opens  **Delete toolbar** dialog box. After confirmation by click **Yes** button the selected toolbar is deleted;\r
+- **Reset** button restores modified tool bars structure to default state;\r
+- **Ok** button closes the dialog box, stores result of tool bars editing and updates tool bars of the module;\r
 - **Cancel** closes the dialog box without modification of tool bars.\r
 \r
+.. image:: images/delete_toolbar.png\r
+   :align: center\r
+\r
+.. centered::\r
+   **Delete toolbar** dialog box\r
+\r
+   \r
+.. _create_toolbar:\r
+\r
+**Create toolbar** dialog box\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+**Input fields** of **Create toolbar** dialog box:\r
+\r
+.. image:: images/create_toolbar.png\r
+   :align: center\r
+\r
+.. centered::\r
+   **Create toolbar** dialog box\r
+\r
+- **Name of a new toolbar** defines name of the new tool bar. The name of tool bar has to be unique. If user defines a not unique name then a warning appears and a new tooolbar with not unique name is not created;\r
+- **Ok** button closes the dialog box and add a new tool bars of the module into  **Toolbars** window;\r
+- **Cancel** closes the dialog box without addition of a new tool bar.\r
+\r
+.. image:: images/name_toolbar.png\r
+   :align: center\r
+\r
+.. centered::\r
+   **Warning** dialog box\r
+   \r
+\r
 .. _edit_toolbar:\r
 \r
 **Edit toolbar** dialog box\r
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
 \r
-The dialog box like following:\r
+**Input fields** of **Edit toolbar** dialog box:\r
 \r
 .. image:: images/EditToolbar.png\r
    :align: center\r
 \r
 .. centered::\r
-   **Edit toolbar** diaqlog box\r
-\r
-In this dialog box there are following controls:\r
-\r
-- **Toolbar name** a non-editable field which displays a name of current tool bar.\r
-- **Out of toolbars** a left window with a list of commands which are out of any tool bar. Also this list contains an item for separator definition "------".\r
-- Right arrow button transfers currently selected item from left window to right one. If right window contains a selected item then new item will be placed before the selectged one. If there is no selected item in right window then new item will be added at the end of items list. In order to clear current selection in right window it is necessary to click in empty space or click by right button of the window.\r
-- Left arrow button removes currently selected item from right window and appends it to left window.\r
-- **In the toolbar** a right window with a list of commands which are defined in the current tool bar. Items in this window are listed according to order of commands in the toolbar.\r
-- Buttons **Up** and **Down** to change position of a selected command in right window.\r
-- **Ok** button to close the dialog box, store result of editing.\r
+   **Edit toolbar** dialog box\r
+\r
+- **Toolbar name** non-editable field displays  name of modified tool bar;\r
+- **Out of toolbars** window contains list of commands which are not included into any tool bar and separator definition "------";\r
+- **In the toolbar** window contains list of commands which are defined in the current tool bar. Items in this window are listed according to order of commands in the toolbar; \r
+- **Right arrow** button transfers currently selected item from left window to right one. If right window contains a selected item then new item will be placed before the selected one. If there is no selected item in right window then new item will be added at the end of items list. In order to clear current selection in right window it is necessary to click in empty space or click by right button of the window.\r
+- **Left arrow** button removes currently selected item from right window and appends it to left window;\r
+- **Up** and **Down** buttons  change position of a selected command in right window;\r
+- **Ok** button closes the dialog box, stores result of edition;\r
 - **Cancel** closes the dialog box without modification of tool bar content.\r
 \r
 \r
diff --git a/doc/gui/images/create_toolbar.png b/doc/gui/images/create_toolbar.png
new file mode 100644 (file)
index 0000000..182f652
Binary files /dev/null and b/doc/gui/images/create_toolbar.png differ
diff --git a/doc/gui/images/delete_toolbar.png b/doc/gui/images/delete_toolbar.png
new file mode 100644 (file)
index 0000000..0acf516
Binary files /dev/null and b/doc/gui/images/delete_toolbar.png differ
diff --git a/doc/gui/images/name_toolbar.png b/doc/gui/images/name_toolbar.png
new file mode 100644 (file)
index 0000000..83a4ce0
Binary files /dev/null and b/doc/gui/images/name_toolbar.png differ