Update documentation

UmSenhorQualquer · Aug 10, 2018 · 99e27be · 99e27be
1 parent 40e16a6
commit 99e27be
Show file tree

Hide file tree

Showing 11 changed files with 382 additions and 96 deletions.
diff --git a/docs/source/api-reference/controls.rst b/docs/source/api-reference/controls.rst
@@ -2,6 +2,12 @@
 :mod:`Controls`
 ***************************
 
+A form Control is a UI interface for the user to interact with the application.  
+
+Bellow we can find the description of all the Controls implemented in the PyForms library.
+
+
+
 .. module:: pyforms_gui.controls
    :synopsis: Pyforms Controls
 
@@ -13,8 +19,7 @@ ControlBase
     :members:
     :undoc-members:
     :show-inheritance:
-    :exclude-members: add_popup_submenu,add_popup_menu_option,clean_field,commit,about_to_show_contextmenu_event,load_form,save_form
-
+    :exclude-members: css, error, label_visible, 
 
 ----------------------------
 
@@ -51,6 +56,47 @@ ControlCheckBox
 
 ----------------------------
 
+
+ControlCheckBoxList
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_checkboxlist.ControlCheckBoxList
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+ControlCodeEditor
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_codeeditor.ControlCodeEditor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 ControlCombo
 ----------------------------
 
@@ -74,6 +120,17 @@ ControlDir
 
 ----------------------------
 
+ControlDockWidget
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_dockwidget.ControlDockWidget
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
 ControlEmptyWidget
 ----------------------------
 
@@ -97,6 +154,18 @@ ControlFile
 
 ----------------------------
 
+
+ControlFilesTree
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_filestree.ControlFilesTree
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
 ControlImage
 ----------------------------
 
@@ -119,6 +188,19 @@ ControlLabel
 
 ----------------------------
 
+
+ControlList
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_list.ControlList
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
 ControlPlayer
 ----------------------------
 
@@ -130,6 +212,56 @@ ControlPlayer
 
 ----------------------------
 
+
+ControlMatplotlib
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_matplotlib.ControlMatplotlib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+ControlMdiArea
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_mdiarea.ControlMdiArea
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+ControlNumber
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_number.ControlNumber
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+ControlOpenGL
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_opengl.ControlOpenGL
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+
 ControlProgress
 ----------------------------
 
@@ -170,4 +302,117 @@ ControlTextArea
     :members:
     :undoc-members:
     :show-inheritance:
-    :exclude-members: init_form, serialize, deserialize
+    :exclude-members: init_form, serialize, deserialize
+
+
+
+
+ControlToolBox
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_toolbox.ControlToolBox
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+ControlToolButton
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_toolbutton.ControlToolButton
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+ControlTree
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_tree.ControlTree
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+ControlTreeView
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_treeview.ControlTreeView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+ControlVisVis
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_visvis.ControlVisVis
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+ControlVisVisVolume
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_visvisvolume.ControlVisVisVolume
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+
+ControlWeb
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_web.ControlWeb
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+ControlEventTimeline
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_event_timeline.control_eventtimeline.ControlEventTimeline
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
+
+----------------------------
+
+
+ControlEventsGraph
+----------------------------
+
+.. autoclass:: pyforms_gui.controls.control_events_graph.control_eventsgraph.ControlEventsGraph
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: init_form, serialize, deserialize
diff --git a/docs/source/getting-started/first-app.rst b/docs/source/getting-started/first-app.rst
@@ -92,4 +92,3 @@ Now execute in the terminal the next command:
 You will visualize the next result:
 
 .. image:: /_static/imgs/gui-example-computervisionalgorithm.png
-    :align: left
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,11 +14,7 @@ The framework aims the boost the developement productivity by providing an API i
 Source code
    https://github.com/UmSenhorQualquer/pyforms-gui
 
-
-
 .. image:: /_static/imgs/gui-example-computervisionalgorithm.png
-    :align: left
-
 
 .. note::