Update docs

docs/source/api-reference/controls.rst

@@ -30,7 +30,7 @@ ControlBoundingSlider
     :members:
     :undoc-members:
     :show-inheritance:
-    :exclude-members: init_form, serialize, deserialize
+    :exclude-members: css, error, label_visible, changed_event, load_form, save_form, init_form
 
 ----------------------------
 
@@ -41,7 +41,7 @@ ControlButton
     :members:
     :undoc-members:
     :show-inheritance:
-    :exclude-members: init_form, serialize, deserialize
+    :exclude-members: css, error, label_visible, changed_event, load_form, save_form, init_form, label
 
 ----------------------------
 

pyforms_gui/controls/control_boundingslider.py

@@ -258,18 +258,28 @@ class ControlBoundingSlider(ControlBase):
     """
     .. image:: https://raw.githubusercontent.com/UmSenhorQualquer/pyforms/master/tutorials/Controls4Docs/ControlBoundingSlider.png  
 
-    |
-
+    
     """
 
     def __init__(self, *args, **kwargs):
+        """
+        
+        :param tupple default: The default value is a list containing in the first element the lower value and in the second element the upper value. Default = [20,40].
+        :param bool horizontal: Flag indicating if the Bounding slider should be draw horizontally or vertically. Default = True.
+        :param bool show_spinboxes: Show or hide the spinboxes. Default = True
+        :param float minimum: Defines the minimum value that can be selected.
+        :param float maximum: Defines the maximum value that can be selected.  
+        :param bool convert_2_int: Flag to define if the control should return floats or integers.
+        
+        """
         self._horizontal     = kwargs.get('horizontal', True)
         self._show_spinboxes = kwargs.get('show_spinboxes', True)
         ControlBase.__init__(self,  *args, **kwargs)
 
         self.min = kwargs.get('min', kwargs.get('minimum', 0))
         self.max = kwargs.get('max', kwargs.get('maximum', 100))
         self.value = kwargs.get('default', [10,20])
+        self.convert_2_int = kwargs.get('convert_2_int', False)
         self.__update()
 
     def init_form(self):
@@ -380,6 +390,9 @@ def save_form(self, data, path=None):
 
     @property
     def value(self):
+        """
+        Sets and gets the control value. It should be a list or tuple of 2 values.
+        """
         return self._boundingbox._minVal, self._boundingbox._maxVal
 
     @value.setter
@@ -393,6 +406,9 @@ def value(self, value):
 
     @property
     def min(self):
+        """
+        Sets and gets the minimum value possible.
+        """
         return self._boundingbox._lower
 
     @min.setter
@@ -404,6 +420,9 @@ def min(self, value):
 
     @property
     def max(self):
+        """
+        Sets and gets the maximum value possible.
+        """
         return self._boundingbox._higher
 
     @max.setter
@@ -415,6 +434,9 @@ def max(self, value):
 
     @property
     def scale(self):
+        """
+        Sets and gets the scale value.
+        """
         return self._boundingbox.scale
 
     @scale.setter
@@ -423,6 +445,9 @@ def scale(self, value):
 
     @property
     def convert_2_int(self):
+        """
+        Flag to define if the control should return floats or integers.
+        """
         return not self._boundingbox._use_float
 
     @convert_2_int.setter

pyforms_gui/controls/control_button.py

@@ -1,8 +1,6 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-
-
 from confapp import conf
 
 from AnyQt 			 import uic
@@ -14,6 +12,13 @@
 
 class ControlButton(ControlBase):
 	def __init__(self, *args, **kwargs):
+		"""
+		...
+
+		:param str icon: Button icon
+        :param bool checkable: Flag to set the button checkable.
+        
+		"""
 		self._checkable = kwargs.get('checkable', False)
 		super(ControlButton, self).__init__(*args, **kwargs)
 
@@ -31,6 +36,9 @@ def init_form(self):
 		self._form.setToolTip(self.help)
 
 	def click(self):
+		"""
+		Trigger a click event
+		"""
 		self._form.click()
 
 	def load_form(self, data, path=None):
@@ -52,6 +60,9 @@ def label(self, value):
 
 	@property
 	def icon(self):
+		"""
+		Sets and gets the icon of the button.
+		"""
 		return self._form.icon()
 
 	@icon.setter
@@ -65,6 +76,9 @@ def icon(self, value):
 
 	@property
 	def value(self):
+		"""
+		Sets and gets the value of the Button. The value should be a function
+		"""
 		return None
 
 	@value.setter
@@ -78,6 +92,9 @@ def value(self, value):
 
 	@property
 	def checked(self):
+		"""
+		Sets and gets the button checked state
+		"""
 		return self._form.isChecked()
 
 	@checked.setter