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

    r11264 r11366  
    77 
    88class QuickHelp(QTextBrowser): 
     9 
     10    #: Emitted when the shown text changes. 
    911    textChanged = Signal() 
    1012 
     
    2325 
    2426    def showHelp(self, text, timeout=0): 
    25         """Show help for `timeout` milliseconds. if timeout is 0 then 
     27        """ 
     28        Show help for `timeout` milliseconds. if timeout is 0 then 
    2629        show the text until it is cleared with clearHelp or showHelp is 
    2730        called with an empty string. 
     
    3740 
    3841    def clearHelp(self): 
    39         """Clear help text previously set with `showHelp`. 
     42        """ 
     43        Clear help text previously set with `showHelp`. 
    4044        """ 
    4145        self.__timer.stop() 
     
    4347 
    4448    def showPermanentHelp(self, text): 
    45         """Set permanent help text. The text may be temporarily 
    46         overridden by showHelp but will be shown again when that is cleared 
     49        """ 
     50        Set permanent help text. The text may be temporarily overridden 
     51        by showHelp but will be shown again when that is cleared. 
    4752 
    4853        """ 
     
    5358 
    5459    def currentText(self): 
    55         """Return the current shown text. 
     60        """ 
     61        Return the current shown text. 
    5662        """ 
    5763        return self.__text or self.__permanentText 
     
    103109 
    104110class StatusTipPromoter(QObject): 
    105     """Promotes `QStatusTipEvent` to `QuickHelpTipEvent` using whatsThis 
     111    """ 
     112    Promotes `QStatusTipEvent` to `QuickHelpTipEvent` using ``whatsThis`` 
    106113    property of the object. 
    107114 
Note: See TracChangeset for help on using the changeset viewer.