Ignore:
Timestamp:
02/19/13 15:01:43 (14 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added rst documentation for the canvas gui package.

Fixing docstrings in the process.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/gui/dropshadow.py

    r11130 r11366  
    11""" 
    2 A DropShadowWidget 
     2================= 
     3Drop Shadow Frame 
     4================= 
     5 
     6A widget providing a drop shadow (gaussian blur effect) around another 
     7widget. 
    38 
    49""" 
     
    4247 
    4348class DropShadowFrame(QWidget): 
    44     """A widget drawing a drop shadow effect around the geometry of 
    45     another widget (similar to QFocusFrame). 
     49    """ 
     50    A widget drawing a drop shadow effect around the geometry of 
     51    another widget (works similar to :class:`QFocusFrame`). 
     52 
     53    Parameters 
     54    ---------- 
     55    parent : :class:`QObject` 
     56        Parent object. 
     57    color : :class:`QColor` 
     58        The color of the drop shadow. 
     59    radius : float 
     60        Shadow radius. 
    4661 
    4762    """ 
     
    6479 
    6580    def setColor(self, color): 
    66         """Set the color of the shadow. 
     81        """ 
     82        Set the color of the shadow. 
    6783        """ 
    6884        if not isinstance(color, QColor): 
     
    7086 
    7187        if self.__color != color: 
    72             self.__color = color 
     88            self.__color = QColor(color) 
    7389            self.__updatePixmap() 
    7490 
    7591    def color(self): 
    76         return self.__color 
    77  
    78     color_ = Property(QColor, fget=color, fset=setColor, designable=True) 
     92        """ 
     93        Return the color of the drop shadow. 
     94        """ 
     95        return QColor(self.__color) 
     96 
     97    color_ = Property(QColor, fget=color, fset=setColor, designable=True, 
     98                      doc="Drop shadow color") 
    7999 
    80100    def setRadius(self, radius): 
    81         """Set the drop shadow blur radius. 
     101        """ 
     102        Set the drop shadow's blur radius. 
    82103        """ 
    83104        if self.__radius != radius: 
     
    87108 
    88109    def radius(self): 
     110        """ 
     111        Return the shadow blur radius. 
     112        """ 
    89113        return self.__radius 
    90114 
    91     radius_ = Property(int, fget=radius, fset=setRadius, designable=True) 
     115    radius_ = Property(int, fget=radius, fset=setRadius, designable=True, 
     116                       doc="Drop shadow blur radius.") 
    92117 
    93118    def setWidget(self, widget): 
    94         """Set the widget to show the shadow around. 
     119        """ 
     120        Set the widget around which to show the shadow. 
    95121        """ 
    96122        if self.__widget: 
     
    119145 
    120146    def widget(self): 
    121         """Return the widget taht was set by `setWidget`. 
     147        """ 
     148        Return the widget that was set by `setWidget`. 
    122149        """ 
    123150        return self.__widget 
     
    160187 
    161188    def __updateGeometry(self): 
    162         """Update the shadow geometry to fit the widget's changed 
     189        """ 
     190        Update the shadow geometry to fit the widget's changed 
    163191        geometry. 
     192 
    164193        """ 
    165194        widget = self.__widget 
     
    185214 
    186215    def __updatePixmap(self): 
    187         """Update the cached shadow pixmap. 
     216        """ 
     217        Update the cached shadow pixmap. 
    188218        """ 
    189219        rect_size = QSize(50, 50) 
     
    211241 
    212242    def __shadowPixmapFragments(self, pixmap_rect, shadow_rect): 
    213         """Return a list of 8 QRectF fragments for drawing a shadow. 
     243        """ 
     244        Return a list of 8 QRectF fragments for drawing a shadow. 
    214245        """ 
    215246        s_left, s_top, s_right, s_bottom = \ 
Note: See TracChangeset for help on using the changeset viewer.