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/splashscreen.py

    r11123 r11366  
    11""" 
    2 Orange Canvas Splash Screen 
     2A splash screen widget with support for positioning of the message text. 
     3 
    34""" 
    45 
     
    1314 
    1415class SplashScreen(QSplashScreen): 
     16    """ 
     17    Splash screen widget. 
     18 
     19    Parameters 
     20    ---------- 
     21    parent : :class:`QWidget` 
     22        Parent widget 
     23 
     24    pixmap : :class:`QPixmap` 
     25        Splash window pixmap. 
     26 
     27    textRect : :class:`QRect` 
     28        Bounding rectangle of the shown message on the widget. 
     29 
     30    """ 
    1531    def __init__(self, parent=None, pixmap=None, textRect=None, **kwargs): 
    1632        QSplashScreen.__init__(self, parent, **kwargs) 
     
    3046 
    3147    def setTextRect(self, rect): 
    32         """Set the rectangle in which to show the message text. 
     48        """ 
     49        Set the rectangle (:class:`QRect`) in which to show the message text. 
    3350        """ 
    3451        if self.__textRect != rect: 
     
    3754 
    3855    def textRect(self): 
    39         """Return the text rect. 
     56        """ 
     57        Return the text message rectangle. 
    4058        """ 
    4159        return self.__textRect 
     
    4765 
    4866    def drawContents(self, painter): 
    49         """Reimplementation of drawContents to limit the drawing 
     67        """ 
     68        Reimplementation of drawContents to limit the drawing 
    5069        inside `textRext`. 
    5170 
     
    7594 
    7695    def showMessage(self, message, alignment=Qt.AlignLeft, color=Qt.black): 
     96        """ 
     97        Show the `message` with `color` and `alignment`. 
     98        """ 
    7799        # Need to store all this arguments for drawContents (no access 
    78100        # methods) 
Note: See TracChangeset for help on using the changeset viewer.