diff options
Diffstat (limited to 'doc/source/modules')
28 files changed, 209 insertions, 114 deletions
diff --git a/doc/source/modules/gui/dialog/datasetdialog.rst b/doc/source/modules/gui/dialog/datasetdialog.rst new file mode 100644 index 0000000..4a8d43c --- /dev/null +++ b/doc/source/modules/gui/dialog/datasetdialog.rst @@ -0,0 +1,7 @@ + +.. currentmodule:: silx.gui.dialog + +:mod:`DatasetDialog` +====================== + +.. automodule:: silx.gui.dialog.DatasetDialog diff --git a/doc/source/modules/gui/dialog/img/colormapdialog.png b/doc/source/modules/gui/dialog/img/colormapdialog.png Binary files differnew file mode 100644 index 0000000..b5eb8e2 --- /dev/null +++ b/doc/source/modules/gui/dialog/img/colormapdialog.png diff --git a/doc/source/modules/gui/dialog/img/datasetdialog.png b/doc/source/modules/gui/dialog/img/datasetdialog.png Binary files differnew file mode 100644 index 0000000..af5f931 --- /dev/null +++ b/doc/source/modules/gui/dialog/img/datasetdialog.png diff --git a/doc/source/modules/gui/dialog/index.rst b/doc/source/modules/gui/dialog/index.rst index 7e2f687..2042ac4 100644 --- a/doc/source/modules/gui/dialog/index.rst +++ b/doc/source/modules/gui/dialog/index.rst @@ -17,14 +17,27 @@ Snapshot of the widgets: :height: 150px :align: middle -.. |imgGroupDialog| image:: ./img/datafiledialog.png +.. |imgColormapDialog| image:: ./img/colormapdialog.png :height: 150px :align: middle -======================== ========================== ========================== -|imgImageFileDialog| |imgDataFileDialog| |imgGroupDialog| -:class:`ImageFileDialog` :class:`DataFileDialog` :class:`GroupDialog` -======================== ========================== ========================== +======================== ========================= ======================== +|imgImageFileDialog| |imgDataFileDialog| |imgColormapDialog| +:class:`ImageFileDialog` :class:`DataFileDialog` :class:`ColormapDialog` +======================== ========================= ======================== + +.. |imgGroupDialog| image:: ./img/groupdialog.png + :height: 150px + :align: middle + +.. |imgDatasetDialog| image:: ./img/datasetdialog.png + :height: 150px + :align: middle + +========================== ========================== +|imgGroupDialog| |imgDatasetDialog| +:class:`GroupDialog` :class:`DatasetDialog` +========================== ========================== Public modules: @@ -35,5 +48,6 @@ Public modules: datafiledialog.rst abstractdatafiledialog.rst groupdialog.rst + datasetdialog.rst colormapdialog.rst diff --git a/doc/source/modules/gui/gallery.rst b/doc/source/modules/gui/gallery.rst index c71a87a..fffcfd8 100644 --- a/doc/source/modules/gui/gallery.rst +++ b/doc/source/modules/gui/gallery.rst @@ -190,6 +190,10 @@ Plotting widgets: :height: 150px :align: center - :class:`ScatterView` is a widget dedicated to visualize a scatter plot. + * - .. image:: plot/img/CompareImages.png + :height: 150px + :align: center + - :class:`CompareImages` is a widget dedicated to compare 2 images. Additional widgets: @@ -267,6 +271,26 @@ Additional widgets: It displays current parameters of the :class:`ScalarFieldView` and allows to modify it. See :ref:`plot3d-sample-code`. +Additional widgets: + +.. list-table:: + :widths: 1 4 + :header-rows: 1 + + * - Widget + - Description + * - .. image:: plot3d/img/PositionInfoWidget.png + :width: 300px + :align: center + - :class:`~silx.gui.plot3d.tools.PositionInfoWidget.PositionInfoWidget` displays the position + and value of selected data point in a :class:`SceneWidget`. + * - .. image:: plot3d/img/GroupPropertiesWidget.png + :height: 150px + :align: center + - :class:`~silx.gui.plot3d.tools.GroupPropertiesWidget.GroupPropertiesWidget` + allows to reset properties of all items in a group in a :class:`SceneWidget`. + + :mod:`silx.gui.widgets` Widgets +++++++++++++++++++++++++++++++ @@ -289,6 +313,11 @@ Additional widgets: :align: center - :class:`FrameBrowser.HorizontalSliderWithBrowser` is a :class:`FrameBrowser` with an additional slider. + * - .. image:: widgets/img/RangeSlider.png + :width: 150px + :align: center + - :class:`~silx.gui.widgets.RangeSlider.RangeSlider` is a slider with 2 thumbs dedicated + to the interactive selection of an interval. * - .. image:: widgets/img/PeriodicCombo.png :width: 150px :align: center diff --git a/doc/source/modules/gui/icons.rst b/doc/source/modules/gui/icons.rst index 3105006..659bc4c 100644 --- a/doc/source/modules/gui/icons.rst +++ b/doc/source/modules/gui/icons.rst @@ -41,6 +41,8 @@ Available icons - add-shape-polygon * - |add-shape-rectangle| - add-shape-rectangle + * - |add-shape-unknown| + - add-shape-unknown * - |add-shape-vertical| - add-shape-vertical * - |arrow-keys| @@ -63,6 +65,28 @@ Available icons - colormap-range * - |colormap| - colormap + * - |compare-align-auto| + - compare-align-auto + * - |compare-align-center| + - compare-align-center + * - |compare-align-origin| + - compare-align-origin + * - |compare-align-stretch| + - compare-align-stretch + * - |compare-keypoints| + - compare-keypoints + * - |compare-mode-a| + - compare-mode-a + * - |compare-mode-b| + - compare-mode-b + * - |compare-mode-hline| + - compare-mode-hline + * - |compare-mode-rb-channel| + - compare-mode-rb-channel + * - |compare-mode-rbneg-channel| + - compare-mode-rbneg-channel + * - |compare-mode-vline| + - compare-mode-vline * - |crop| - crop * - |crosshair| @@ -145,6 +169,8 @@ Available icons - math-fit * - |math-imaginary| - math-imaginary + * - |math-mean| + - math-mean * - |math-normalize| - math-normalize * - |math-peak-reset| @@ -327,6 +353,7 @@ Available icons .. |add-shape-point| image:: ../../../../silx/resources/gui/icons/add-shape-point.png .. |add-shape-polygon| image:: ../../../../silx/resources/gui/icons/add-shape-polygon.png .. |add-shape-rectangle| image:: ../../../../silx/resources/gui/icons/add-shape-rectangle.png +.. |add-shape-unknown| image:: ../../../../silx/resources/gui/icons/add-shape-unknown.png .. |add-shape-vertical| image:: ../../../../silx/resources/gui/icons/add-shape-vertical.png .. |arrow-keys| image:: ../../../../silx/resources/gui/icons/arrow-keys.png .. |axis| image:: ../../../../silx/resources/gui/icons/axis.png @@ -338,6 +365,17 @@ Available icons .. |colormap-none| image:: ../../../../silx/resources/gui/icons/colormap-none.png .. |colormap-range| image:: ../../../../silx/resources/gui/icons/colormap-range.png .. |colormap| image:: ../../../../silx/resources/gui/icons/colormap.png +.. |compare-align-auto| image:: ../../../../silx/resources/gui/icons/compare-align-auto.png +.. |compare-align-center| image:: ../../../../silx/resources/gui/icons/compare-align-center.png +.. |compare-align-origin| image:: ../../../../silx/resources/gui/icons/compare-align-origin.png +.. |compare-align-stretch| image:: ../../../../silx/resources/gui/icons/compare-align-stretch.png +.. |compare-keypoints| image:: ../../../../silx/resources/gui/icons/compare-keypoints.png +.. |compare-mode-a| image:: ../../../../silx/resources/gui/icons/compare-mode-a.png +.. |compare-mode-b| image:: ../../../../silx/resources/gui/icons/compare-mode-b.png +.. |compare-mode-hline| image:: ../../../../silx/resources/gui/icons/compare-mode-hline.png +.. |compare-mode-rb-channel| image:: ../../../../silx/resources/gui/icons/compare-mode-rb-channel.png +.. |compare-mode-rbneg-channel| image:: ../../../../silx/resources/gui/icons/compare-mode-rbneg-channel.png +.. |compare-mode-vline| image:: ../../../../silx/resources/gui/icons/compare-mode-vline.png .. |crop| image:: ../../../../silx/resources/gui/icons/crop.png .. |crosshair| image:: ../../../../silx/resources/gui/icons/crosshair.png .. |cube-back| image:: ../../../../silx/resources/gui/icons/cube-back.png @@ -379,6 +417,7 @@ Available icons .. |math-energy| image:: ../../../../silx/resources/gui/icons/math-energy.png .. |math-fit| image:: ../../../../silx/resources/gui/icons/math-fit.png .. |math-imaginary| image:: ../../../../silx/resources/gui/icons/math-imaginary.png +.. |math-mean| image:: ../../../../silx/resources/gui/icons/math-mean.png .. |math-normalize| image:: ../../../../silx/resources/gui/icons/math-normalize.png .. |math-peak-reset| image:: ../../../../silx/resources/gui/icons/math-peak-reset.png .. |math-peak-search| image:: ../../../../silx/resources/gui/icons/math-peak-search.png diff --git a/doc/source/modules/gui/plot/compareimages.rst b/doc/source/modules/gui/plot/compareimages.rst new file mode 100644 index 0000000..ca85636 --- /dev/null +++ b/doc/source/modules/gui/plot/compareimages.rst @@ -0,0 +1,19 @@ + +.. currentmodule:: silx.gui.plot + +:mod:`CompareImages`: Plot 2 images to compare them +=================================================== + +.. automodule:: silx.gui.plot.CompareImages + +.. currentmodule:: silx.gui.plot.CompareImages + +.. image:: img/CompareImages.png + :height: 400px + :align: center + +:class:`CompareImages` class +---------------------------- + +.. autoclass:: CompareImages + :members: diff --git a/doc/source/modules/gui/plot/dev.rst b/doc/source/modules/gui/plot/dev.rst index d7d4581..8966487 100644 --- a/doc/source/modules/gui/plot/dev.rst +++ b/doc/source/modules/gui/plot/dev.rst @@ -44,7 +44,6 @@ The :mod:`backends` package provide the implementation of the rendering used by It contains: :mod:`.backends.BackendBase` defines the API any plot backend should provide in :class:`BackendBase`. :mod:`.backends.BackendMatplotlib` implements a `matplotlib <http://matplotlib.org/>`_ backend. -It uses :mod:`.backends.ModestImage` to provide a faster matplotlib AxesImage class using nearest values. The :mod:`.backends.BackendMatplotlib` the provides two classes: .. currentmodule:: silx.gui.plot.backends.BackendMatplotlib diff --git a/doc/source/modules/gui/plot/getting_started.rst b/doc/source/modules/gui/plot/getting_started.rst index 412cc11..899d262 100644 --- a/doc/source/modules/gui/plot/getting_started.rst +++ b/doc/source/modules/gui/plot/getting_started.rst @@ -66,7 +66,7 @@ On Windows, run from the command line:: - version 1, the legacy version which is also the default, and - version 2, a more pythonic one, which is the only one supported by *silx*. - All other configurations (i.e., PyQt4 on Python 3.x, PySide, PyQt5, IPython QtConsole widget) uses version 2. + All other configurations (i.e., PyQt4 on Python 3.x, PySide2, PyQt5, IPython QtConsole widget) uses version 2. For more information, see `IPython, PyQt and PySide <http://ipython.org/ipython-doc/stable/interactive/reference.html#pyqt-and-pyside>`_. @@ -103,7 +103,7 @@ A Qt GUI script must have a QApplication initialised before creating widgets: [...] qapp.exec_() -Unless a Qt binding has already been loaded, :mod:`silx.gui.qt` uses one of the supported Qt bindings (PyQt4, PySide or PyQt5). +Unless a Qt binding has already been loaded, :mod:`silx.gui.qt` uses one of the supported Qt bindings (PyQt5, PyQt4, PySide2). If you prefer to choose the Qt binding yourself, import it before importing a module from :mod:`silx.gui`: @@ -295,7 +295,7 @@ When displaying an image, it is possible to define the ``origin`` and the ``scal Colormap ++++++++ -A ``colormap`` is described with a :class:`.Colormap` class as follows: +A ``colormap`` is described with a :class:`~silx.gui.colors.Colormap` class as follows: .. code-block:: python @@ -338,7 +338,7 @@ It is possible to change the default colormap of the plot widget by :meth:`.Plot data = numpy.arange(512 * 512.).reshape(512, -1) plot.addImage(data) # Rendered with the default colormap set before -It is also possible to provide a :class:`.Colormap` to :meth:`.PlotWidget.addImage` to override this default for an image: +It is also possible to provide a :class:`~silx.gui.colors.Colormap` to :meth:`.PlotWidget.addImage` to override this default for an image: .. code-block:: python diff --git a/doc/source/modules/gui/plot/img/CompareImages.png b/doc/source/modules/gui/plot/img/CompareImages.png Binary files differnew file mode 100644 index 0000000..6650f26 --- /dev/null +++ b/doc/source/modules/gui/plot/img/CompareImages.png diff --git a/doc/source/modules/gui/plot/img/CurveLegendsWidget.png b/doc/source/modules/gui/plot/img/CurveLegendsWidget.png Binary files differnew file mode 100644 index 0000000..e7fa9f8 --- /dev/null +++ b/doc/source/modules/gui/plot/img/CurveLegendsWidget.png diff --git a/doc/source/modules/gui/plot/index.rst b/doc/source/modules/gui/plot/index.rst index 5cda6d8..6f06830 100644 --- a/doc/source/modules/gui/plot/index.rst +++ b/doc/source/modules/gui/plot/index.rst @@ -36,6 +36,7 @@ Main plot widgets: imageview.rst stackview.rst scatterview.rst + compareimages.rst Classes describing plot content: diff --git a/doc/source/modules/gui/plot/items.rst b/doc/source/modules/gui/plot/items.rst index eb3ca1a..43eb77e 100644 --- a/doc/source/modules/gui/plot/items.rst +++ b/doc/source/modules/gui/plot/items.rst @@ -29,8 +29,11 @@ Curve isFill, setFill, getXLabel, getYLabel, getLineWidth, setLineWidth, getLineStyle, setLineStyle, - isHighlighted, setHighlighted, getHighlightedColor, setHighlightedColor, - getCurrentColor + isHighlighted, setHighlighted, getHighlightedStyle, setHighlightedStyle, + getCurrentStyle + +.. autoclass:: CurveStyle + :members: getColor, getLineStyle, getLineWidth, getSymbol, getSymbolSize Images ------ diff --git a/doc/source/modules/gui/plot/plotsignal.rst b/doc/source/modules/gui/plot/plotsignal.rst index c4cb003..091f481 100644 --- a/doc/source/modules/gui/plot/plotsignal.rst +++ b/doc/source/modules/gui/plot/plotsignal.rst @@ -132,6 +132,7 @@ Plot state change events These events are deprecated. Use :attr:`PlotWidget.sigSetKeepDataAspectRatio`, :attr:`PlotWidget.sigSetGraphGrid`, :attr:`PlotWidget.sigSetGraphCursor`, + :attr:`PlotWidget.sigItemAdded`,:attr:`PlotWidget.sigItemAboutToBeRemoved`, :attr:`PlotWidget.sigContentChanged`, :attr:`PlotWidget.sigActiveCurveChanged`, :attr:`PlotWidget.sigActiveImageChanged` and :attr:`PlotWidget.sigInteractiveModeChanged` instead. diff --git a/doc/source/modules/gui/plot/plotwidget.rst b/doc/source/modules/gui/plot/plotwidget.rst index 4ce69f7..9978479 100644 --- a/doc/source/modules/gui/plot/plotwidget.rst +++ b/doc/source/modules/gui/plot/plotwidget.rst @@ -37,15 +37,13 @@ Get data Those methods return objects providing access to plotted data: +.. automethod:: PlotWidget.getItems + .. automethod:: PlotWidget.getCurve .. automethod:: PlotWidget.getImage .. automethod:: PlotWidget.getScatter .. automethod:: PlotWidget.getHistogram -.. automethod:: PlotWidget.getAllCurves -.. automethod:: PlotWidget.getAllImages - - Plot markers ............ @@ -134,10 +132,10 @@ Coordinates conversion Active Item ........... -.. automethod:: PlotWidget.isActiveCurveHandling -.. automethod:: PlotWidget.setActiveCurveHandling -.. automethod:: PlotWidget.getActiveCurveColor -.. automethod:: PlotWidget.setActiveCurveColor +.. automethod:: PlotWidget.setActiveCurveSelectionMode +.. automethod:: PlotWidget.getActiveCurveSelectionMode +.. automethod:: PlotWidget.getActiveCurveStyle +.. automethod:: PlotWidget.setActiveCurveStyle .. automethod:: PlotWidget.getActiveCurve .. automethod:: PlotWidget.setActiveCurve .. automethod:: PlotWidget.getActiveImage @@ -159,6 +157,8 @@ The :class:`PlotWidget` provides the following Qt signals: .. autoattribute:: PlotWidget.sigSetGraphGrid .. autoattribute:: PlotWidget.sigSetGraphCursor .. autoattribute:: PlotWidget.sigSetPanWithArrowKeys +.. autoattribute:: PlotWidget.sigItemAdded +.. autoattribute:: PlotWidget.sigItemAboutToBeRemoved .. autoattribute:: PlotWidget.sigContentChanged .. autoattribute:: PlotWidget.sigActiveCurveChanged .. autoattribute:: PlotWidget.sigActiveImageChanged diff --git a/doc/source/modules/gui/plot/tools.rst b/doc/source/modules/gui/plot/tools.rst index 766c8f1..d7c96b5 100644 --- a/doc/source/modules/gui/plot/tools.rst +++ b/doc/source/modules/gui/plot/tools.rst @@ -54,6 +54,18 @@ :show-inheritance: :members: +:mod:`~silx.gui.plot.tools.CurveLegendsWidget` +---------------------------------------------- + +.. automodule:: silx.gui.plot.tools.CurveLegendsWidget + +.. image:: img/CurveLegendsWidget.png + :align: center + +.. autoclass:: silx.gui.plot.tools.CurveLegendsWidget.CurveLegendsWidget + :show-inheritance: + :members: + :mod:`~silx.gui.plot.tools.roi`: Region of interest --------------------------------------------------- diff --git a/doc/source/modules/gui/plot3d/img/GroupPropertiesWidget.png b/doc/source/modules/gui/plot3d/img/GroupPropertiesWidget.png Binary files differnew file mode 100644 index 0000000..0901aba --- /dev/null +++ b/doc/source/modules/gui/plot3d/img/GroupPropertiesWidget.png diff --git a/doc/source/modules/gui/plot3d/img/PositionInfoWidget.png b/doc/source/modules/gui/plot3d/img/PositionInfoWidget.png Binary files differnew file mode 100644 index 0000000..680d698 --- /dev/null +++ b/doc/source/modules/gui/plot3d/img/PositionInfoWidget.png diff --git a/doc/source/modules/gui/plot3d/scenewidget.rst b/doc/source/modules/gui/plot3d/scenewidget.rst index 5c6f411..c1f49a4 100644 --- a/doc/source/modules/gui/plot3d/scenewidget.rst +++ b/doc/source/modules/gui/plot3d/scenewidget.rst @@ -26,4 +26,10 @@ For sample code using :class:`SceneWidget`, see ``plot3dSceneWindow.py`` in :ref .. toctree:: :maxdepth: 2 - items.rst
\ No newline at end of file + items.rst + +:class:`~silx.gui.plot3d.items._pick.PickingResult` +--------------------------------------------------- + +.. autoclass:: silx.gui.plot3d.items._pick.PickingResult + :members:
\ No newline at end of file diff --git a/doc/source/modules/gui/plot3d/tools.rst b/doc/source/modules/gui/plot3d/tools.rst index 6cd433b..09c7468 100644 --- a/doc/source/modules/gui/plot3d/tools.rst +++ b/doc/source/modules/gui/plot3d/tools.rst @@ -38,3 +38,27 @@ Tool Buttons .. autoclass:: ViewpointToolButton :show-inheritance: :members: + + +Widgets +------- + +:mod:`PositionInfoWidget` ++++++++++++++++++++++++++ + +.. automodule:: silx.gui.plot3d.tools.PositionInfoWidget + +.. image:: img/PositionInfoWidget.png + +.. autoclass:: silx.gui.plot3d.tools.PositionInfoWidget.PositionInfoWidget + :members: + +:mod:`GroupPropertiesWidget` +++++++++++++++++++++++++++++ + +.. automodule:: silx.gui.plot3d.tools.GroupPropertiesWidget + +.. image:: img/GroupPropertiesWidget.png + +.. autoclass:: silx.gui.plot3d.tools.GroupPropertiesWidget.GroupPropertiesWidget + :members: diff --git a/doc/source/modules/gui/update_icons_rst.py b/doc/source/modules/gui/update_icons_rst.py deleted file mode 100644 index 3f6565a..0000000 --- a/doc/source/modules/gui/update_icons_rst.py +++ /dev/null @@ -1,90 +0,0 @@ -# coding: utf-8 -# /*########################################################################## -# -# Copyright (c) 2016 European Synchrotron Radiation Facility -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. -# -# ###########################################################################*/ -"""Script to update icons.rst file according to icons available in resources. -""" - -__authors__ = ["Thomas Vincent"] -__license__ = "MIT" -__date__ = "30/06/2016" - - -import os -import glob - - -ICONS_RST_FILENAME = os.path.join(os.path.dirname(__file__), 'icons.rst') - - -ICONS_DIR = os.path.join( - os.path.dirname(__file__), - '..', '..', '..', '..', 'silx', 'resources', 'gui', 'icons', '*.png') - - -ICONS_RST_HEADER = """ -.. AUTOMATICALLY GENERATED FILE DO NOT EDIT - Use %s script instead - -.. currentmodule:: silx.gui - -:mod:`icons`: Set of icons --------------------------- - -.. automodule:: silx.gui.icons - :members: - -Available icons -+++++++++++++++ - -.. list-table:: - :widths: 1 4 - :header-rows: 1 - - * - Icon - - Name -""" % os.path.basename(__file__) - - -def main(): - """Write icons.rst file""" - icons = glob.glob(ICONS_DIR) - icons = [os.path.relpath(f, os.path.dirname(__file__)) for f in icons] - icons = sorted(icons) - - icons_table = '\n'.join( - ' * - |%s|\n - %s' % (os.path.basename(f)[:-4], - os.path.basename(f)[:-4]) for f in icons) - - icon_definitions = '\n'.join( - '.. |%s| image:: %s' % (os.path.basename(f)[:-4], f) for f in icons) - - content = ICONS_RST_HEADER + icons_table + '\n\n' + icon_definitions + '\n' - - # Write to file - with open(ICONS_RST_FILENAME, 'w') as f: - f.write(content) - - -if __name__ == '__main__': - main() diff --git a/doc/source/modules/gui/utils.rst b/doc/source/modules/gui/utils.rst index be0f0ae..34670b6 100644 --- a/doc/source/modules/gui/utils.rst +++ b/doc/source/modules/gui/utils.rst @@ -10,3 +10,9 @@ .. automodule:: silx.gui.utils.concurrent :members: + +:mod:`~silx.gui.utils.image` +---------------------------- + +.. automodule:: silx.gui.utils.image + :members: diff --git a/doc/source/modules/gui/widgets/flowlayout.rst b/doc/source/modules/gui/widgets/flowlayout.rst new file mode 100644 index 0000000..539386b --- /dev/null +++ b/doc/source/modules/gui/widgets/flowlayout.rst @@ -0,0 +1,11 @@ + +.. currentmodule:: silx.gui.widgets + +:mod:`FlowLayout` +------------------- + +.. automodule:: silx.gui.widgets.FlowLayout + +.. autoclass:: silx.gui.widgets.FlowLayout.FlowLayout + :members: + :show-inheritance: diff --git a/doc/source/modules/gui/widgets/img/RangeSlider.png b/doc/source/modules/gui/widgets/img/RangeSlider.png Binary files differnew file mode 100644 index 0000000..b068c6f --- /dev/null +++ b/doc/source/modules/gui/widgets/img/RangeSlider.png diff --git a/doc/source/modules/gui/widgets/index.rst b/doc/source/modules/gui/widgets/index.rst index 72f89a8..e36b046 100644 --- a/doc/source/modules/gui/widgets/index.rst +++ b/doc/source/modules/gui/widgets/index.rst @@ -12,9 +12,11 @@ Public modules: .. toctree:: :maxdepth: 2 + flowlayout.rst framebrowser.rst periodictable.rst printpreview.rst + rangeslider.rst tablewidget.rst threadpoolpushbutton.rst waitingpushbutton.rst diff --git a/doc/source/modules/gui/widgets/rangeslider.rst b/doc/source/modules/gui/widgets/rangeslider.rst new file mode 100644 index 0000000..f4e5ff5 --- /dev/null +++ b/doc/source/modules/gui/widgets/rangeslider.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.gui.widgets + +:mod:`RangeSlider`: Slider to define an interval +------------------------------------------------ + +.. automodule:: silx.gui.widgets.RangeSlider + :members: diff --git a/doc/source/modules/sx.rst b/doc/source/modules/sx.rst index f08dd98..def5b44 100644 --- a/doc/source/modules/sx.rst +++ b/doc/source/modules/sx.rst @@ -9,6 +9,8 @@ Plot functions -------------- +.. currentmodule:: silx.sx._plot + The following functions plot curves and images with silx widgets: - :func:`plot` for curves @@ -44,6 +46,8 @@ The :func:`ginput` function handles user selection on those widgets. 3D plot functions ----------------- +.. currentmodule:: silx.sx._plot3d + The following functions plot 3D data with silx widgets (it requires OpenGL): - :func:`contour3d` for isosurfaces (and cut plane) in a 3D scalar field diff --git a/doc/source/modules/test/index.rst b/doc/source/modules/test/index.rst index f9d8ec0..c20bf97 100644 --- a/doc/source/modules/test/index.rst +++ b/doc/source/modules/test/index.rst @@ -13,8 +13,8 @@ .. automodule:: silx.test.utils :members: -:mod:`silx.gui.test.utils` --------------------------- +:mod:`silx.gui.utils.testutils` +------------------------------- -.. automodule:: silx.gui.test.utils +.. automodule:: silx.gui.utils.testutils :members: |
