summaryrefslogtreecommitdiff
path: root/doc/source/modules/gui/widgets
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/gui/widgets')
-rw-r--r--doc/source/modules/gui/widgets/framebrowser.rst19
-rw-r--r--doc/source/modules/gui/widgets/index.rst19
-rw-r--r--doc/source/modules/gui/widgets/periodictable.rst37
-rw-r--r--doc/source/modules/gui/widgets/tablewidget.rst42
-rw-r--r--doc/source/modules/gui/widgets/threadpoolpushbutton.rst14
-rw-r--r--doc/source/modules/gui/widgets/waitingpushbutton.rst13
6 files changed, 144 insertions, 0 deletions
diff --git a/doc/source/modules/gui/widgets/framebrowser.rst b/doc/source/modules/gui/widgets/framebrowser.rst
new file mode 100644
index 0000000..5ea0918
--- /dev/null
+++ b/doc/source/modules/gui/widgets/framebrowser.rst
@@ -0,0 +1,19 @@
+
+.. currentmodule:: silx.gui.widgets
+
+:mod:`FrameBrowser`
+-------------------
+
+.. automodule:: silx.gui.widgets.FrameBrowser
+
+API
+***
+
+.. autoclass:: silx.gui.widgets.FrameBrowser.HorizontalSliderWithBrowser
+ :members:
+
+
+.. autoclass:: silx.gui.widgets.FrameBrowser.FrameBrowser
+ :members:
+
+
diff --git a/doc/source/modules/gui/widgets/index.rst b/doc/source/modules/gui/widgets/index.rst
new file mode 100644
index 0000000..2284f22
--- /dev/null
+++ b/doc/source/modules/gui/widgets/index.rst
@@ -0,0 +1,19 @@
+
+.. currentmodule:: silx.gui
+
+:mod:`widgets`: Simple widgets
+------------------------------
+
+.. automodule:: silx.gui.widgets
+
+
+Public modules:
+
+.. toctree::
+ :maxdepth: 2
+
+ framebrowser.rst
+ periodictable.rst
+ tablewidget.rst
+ threadpoolpushbutton.rst
+ waitingpushbutton.rst
diff --git a/doc/source/modules/gui/widgets/periodictable.rst b/doc/source/modules/gui/widgets/periodictable.rst
new file mode 100644
index 0000000..dead3d9
--- /dev/null
+++ b/doc/source/modules/gui/widgets/periodictable.rst
@@ -0,0 +1,37 @@
+
+.. currentmodule:: silx.gui.widgets
+
+:mod:`PeriodicTable`: Atomic elements widgets
+----------------------------------------------
+
+.. automodule:: silx.gui.widgets.PeriodicTable
+
+Widgets
++++++++
+
+.. autoclass:: silx.gui.widgets.PeriodicTable.PeriodicTable
+ :members:
+ :exclude-members: elementEnter, elementLeave, elementClicked, elementToggle
+ :show-inheritance:
+
+
+.. autoclass:: silx.gui.widgets.PeriodicTable.PeriodicList
+ :members:
+ :show-inheritance:
+
+.. autoclass:: silx.gui.widgets.PeriodicTable.PeriodicCombo
+ :members:
+ :show-inheritance:
+
+
+Data model
+++++++++++
+
+.. autoclass:: silx.gui.widgets.PeriodicTable.PeriodicTableItem
+ :members:
+
+
+.. autoclass:: silx.gui.widgets.PeriodicTable.ColoredPeriodicTableItem
+ :members:
+ :show-inheritance:
+
diff --git a/doc/source/modules/gui/widgets/tablewidget.rst b/doc/source/modules/gui/widgets/tablewidget.rst
new file mode 100644
index 0000000..1eb5695
--- /dev/null
+++ b/doc/source/modules/gui/widgets/tablewidget.rst
@@ -0,0 +1,42 @@
+
+.. currentmodule:: silx.gui.widgets
+
+:mod:`TableWidget`: Table widget
+--------------------------------
+
+.. automodule:: silx.gui.widgets.TableWidget
+
+
+Widget
+++++++
+
+.. autoclass:: silx.gui.widgets.TableWidget.TableWidget
+ :members:
+ :show-inheritance:
+
+
+View
+++++
+
+.. autoclass:: silx.gui.widgets.TableWidget.TableView
+ :members:
+ :show-inheritance:
+
+
+Actions
++++++++
+
+.. autoclass:: silx.gui.widgets.TableWidget.CopySelectedCellsAction
+ :show-inheritance:
+
+.. autoclass:: silx.gui.widgets.TableWidget.CopyAllCellsAction
+ :show-inheritance:
+
+.. autoclass:: silx.gui.widgets.TableWidget.CutSelectedCellsAction
+ :show-inheritance:
+
+.. autoclass:: silx.gui.widgets.TableWidget.CutAllCellsAction
+ :show-inheritance:
+
+.. autoclass:: silx.gui.widgets.TableWidget.PasteCellsAction
+ :show-inheritance:
diff --git a/doc/source/modules/gui/widgets/threadpoolpushbutton.rst b/doc/source/modules/gui/widgets/threadpoolpushbutton.rst
new file mode 100644
index 0000000..cd98ac4
--- /dev/null
+++ b/doc/source/modules/gui/widgets/threadpoolpushbutton.rst
@@ -0,0 +1,14 @@
+
+.. currentmodule:: silx.gui.widgets
+
+:mod:`ThreadPoolPushButton`: Button to execute a threaded task
+--------------------------------------------------------------
+
+.. automodule:: silx.gui.widgets.ThreadPoolPushButton
+
+
+.. autoclass:: silx.gui.widgets.ThreadPoolPushButton.ThreadPoolPushButton
+ :members:
+
+
+
diff --git a/doc/source/modules/gui/widgets/waitingpushbutton.rst b/doc/source/modules/gui/widgets/waitingpushbutton.rst
new file mode 100644
index 0000000..310ea80
--- /dev/null
+++ b/doc/source/modules/gui/widgets/waitingpushbutton.rst
@@ -0,0 +1,13 @@
+
+.. currentmodule:: silx.gui.widgets
+
+:mod:`WaitingPushButton`: Button with waiting status
+----------------------------------------------------
+
+.. automodule:: silx.gui.widgets.WaitingPushButton
+
+.. autoclass:: silx.gui.widgets.WaitingPushButton.WaitingPushButton
+ :members:
+
+
+