doc/salome/gui/input/python_viewer.doc

   1 /*!
   2
   3 \page python_viewer_page Python viewer
   4
   5 The functionalities of Python viewer are available via its Viewer
   6 Toolbar.
   7
   8 \image html pythonviewer_toolbar.png
   9 <hr>
  10
  11 \image html python_new.png
  12
  13 <b>New</b> - clears viewer in order to create a new script. If viewer was modified, you will be asked to close it before removing.
  14 <hr>
  15
  16 \image html python_open.png
  17 <b>Open</b> - allows to open an existing script by browsing for it in a standard Open File dialog box, choosing the required .py file and clicking Open button. If there is already opened script, you will be asked to close it before opening new one.
  18 <hr>
  19
  20 \image html python_save.png
  21
  22 <b>Save</b> - saves the current script.
  23
  24 \note If the script hasn't been previously saved, Save will call the standard Save File dialog box where you can enter the name for your script and save it.
  25
  26 <hr>
  27
  28 \image html python_saveas.png
  29
  30 <b>Save As...</b> - allows to save the current script with a new name. Input a new name for the script in the standard Save file as dialog box and click Save button.
  31 <hr>
  32
  33 \image html python_undo.png
  34
  35 <b>Undo</b> - undo the last user's action in Python viewer.
  36 <hr>
  37
  38 \image html python_redo.png
  39
  40 <b>Redo</b> - redo the previously user's action in Python viewer.
  41 <hr>
  42
  43 \image html python_cut.png
  44
  45 <b>Cut</b> - save the selected text into clipboard and remove it from the viewer.
  46 <hr>
  47
  48 \image html python_copy.png
  49
  50 <b>Copy</b> - save the selected text into clipboard.
  51 <hr>
  52
  53 \image html python_paste.png
  54
  55 <b>Paste</b> - restore the saved text from clipboard.
  56 <hr>
  57
  58 \image html python_delete.png
  59
  60 <b>Delete</b> - remove the selected text.
  61 <hr>
  62
  63 \image html python_selectall.png
  64
  65 <b>Select All</b> - select whole the text.
  66 <hr>
  67
  68 \image html python_preferences.png
  69
  70 <b>Preferences</b> - provides an access to the preferences dialog box, that allows to specify advanced parameters for the Python Viewer.
  71
  72 \anchor custom_python_preferences
  73 \image html python_view_preferences.png
  74
  75 The following options are available:
  76
  77 - <b>Font settings</b> allows setting font variant and it's size.
  78
  79 - <b>Display settings</b> specifies the script representation in the viewer:
  80
  81   - <b>Enable current line highlight</b> switches on a background coloring of current line.
  82   - <b>Enable text wrapping</b> allows lines wrapping at the view border of the editor.
  83
  84   - <b>Center cursor on scroll</b> scrolls the script vertically to make the cursor visible at the center of the viewer.
  85
  86   - <b>Display line numbers area</b> will make a panel displaying the line numbers of the script visible in the left border of the editor.
  87
  88 - <b>Tab settings</b> allows to display tab indentation as a set of desirable number of white spaces.
  89
  90 - <b>Vertical edge settings</b> manages drawing of vertical line at the specified column of the viewer.
  91
  92 - <b>Save settings as default</b> will store the applied Python viewer settings in the SALOME preferences .xml file and restore it in the current and next SALOME sessions.
  93
  94 */