diff options
Diffstat (limited to 'qtdesigner_plugins/README.rst')
| -rw-r--r-- | qtdesigner_plugins/README.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/qtdesigner_plugins/README.rst b/qtdesigner_plugins/README.rst new file mode 100644 index 0000000..d647ea3 --- /dev/null +++ b/qtdesigner_plugins/README.rst @@ -0,0 +1,40 @@ +Using silx widgets in Qt Designer +================================= + +With PyQt_, it is possible to use ``silx.gui`` widgets (and widgets written with PyQt in general) from the `Qt Designer`_. + +The following ``silx.gui`` widgets are available in the Qt Designer: + +- :class:`silx.gui.plot.Plot1D` +- :class:`silx.gui.plot.Plot2D` +- :class:`silx.gui.plot.PlotWidget` +- :class:`silx.gui.plot.PlotWindow` + +Pre-requisite +------------- + +The following software must be installed: + +- Qt_ with the `Qt Designer`_. +- Python_. +- PyQt_ with the designer plugin. +- The ``silx`` Python package and its dependencies. + :mod:`silx.gui.plot` widgets requires matplotlib_. + +Usage +----- + +The **PYQTDESIGNERPATH** environment variable defines the search paths for plugins enabling use of PyQt widgets in the designer. + +To start the Qt Designer with ``silx.gui`` widgets available, on Linux, run the following from the command line:: + + PYQTDESIGNERPATH=<silx_designer_plugin_dir> designer + + +See `Using Qt Designer <http://pyqt.sourceforge.net/Docs/PyQt5/designer.html>`_ in PyQt_ documentation. + +.. _Qt: http://www.qt.io/ +.. _Python: https://www.python.org/ +.. _PyQt: https://riverbankcomputing.com/software/pyqt/intro +.. _Qt Designer: http://doc.qt.io/qt-5/qtdesigner-manual.html +.. _matplotlib: http://matplotlib.org/ |