thirdparty/pyqtermwidget/doc/usage.rst

   1 How to use PyQTermWidget
   2 ========================
   3
   4
   5 Here is a minimal example:
   6
   7
   8 .. code-block:: python
   9
  10   #!/usr/bin/env python
  11   # -*- coding: utf-8 -*-
  12
  13   from PyQt4.QtGui import QApplication
  14   from pyqterm import TerminalWidget
  15
  16
  17   if __name__ == "__main__":
  18       app = QApplication(sys.argv)
  19       win = TerminalWidget()
  20       win.resize(800, 600)
  21       win.show()
  22       app.exec_()
  23
  24
  25
  26 Look into *demo.py* for a more complete example with a tabbed terminal
  27 application.
  28
  29
  30 .. image:: screenshot2.png
  31
  32
  33 The constructor has the following signature:
  34
  35  * def __init__(self, parent=None, command="/bin/bash", font_name="Monospace", font_size=18)
  36
  37
  38 The widget has the following methods:
  39
  40  * execute(command="/bin/bash")
  41  * send(string)
  42  * stop()
  43  * pid() -> process id (int)
  44  * zoom_in()
  45  * zoom_out()
  46  * text_selection() -> string
  47  * update_screen()
  48  * is_alive() -> bool
  49  * row_count() -> int
  50  * column_count() -> int
  51  * text() -> string
  52
  53
  54 TerminalWidget inherits directly from QWidget, so it has show, hide,
  55 setFont, etc.
  56
  57
  58 The widget emits the following signals:
  59
  60  * session_closed()
  61  * return_pressed()
  62
  63
  64