Salome HOME
update of the documentation
[modules/hydro.git] / doc / salome / gui / HYDRO / split_image.h
1
2 /**
3   @file
4   \brief Help for the split image
5 */
6
7 /**
8   \page splitimage Split image
9
10   <a href="index.html"><b>Back to Main page.</b></a>
11   
12 The user can start <b>Split image</b> operation via:<ol>
13 <li>The main menu <b>HYDRO - Split image</b>;
14 <li>Context menu of any image in Object browser - <b>Split image</b>;
15 <li><b>Split image</b> toolbar button  \image html split_image_toolbar_button.png "Split image toolbar button"
16  </ol> 
17   Arguments of the input panel: 
18   \image html split_image_input_panel.png "Split image input panel"
19   
20 <b>Name</b> - field for defining the name of image after cut;<br>
21 <b>Modify selected image</b> - if this checkbox is OFF, new object will be created, as result. If checkbox is ON, initial image will be modified.<br>
22 <b>Image</b> - field for defining the reference image to be split;<br>
23 <b>Polyline</b> - field for defining the the tool for split. Only <b>closed polylines</b> can be selected in this field; <br>
24 <b>Apply</b> - button to create split image object;<br>
25 <b>Apply and Close</b> - button to create split image object and close input panel;<br>
26 <b>Close</b> - button to close input panel.<br>
27
28 Also, it's possible to change background color of split image. For this <b>Color</b> radio button should be pushed and <b>Select color</b> dialog box should be called<br> by double clicking on the area near <b>Color</b> radio button.
29
30   \image html select_color.png "Select color dialog box"
31   
32 <a href="index.html"><b>Back to Main page.</b></a>
33
34 */