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