Ignore:
Timestamp:
02/22/13 16:00:22 (14 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added rst documentation for the canvas package.

Fixing docstrings in the process.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/canvas/items/linkitem.py

    r11343 r11369  
    77    QGraphicsItem, QGraphicsEllipseItem, QGraphicsPathItem, QGraphicsObject, 
    88    QGraphicsTextItem, QGraphicsDropShadowEffect, QPen, QBrush, QColor, 
    9     QPainterPath, QFont, QTransform 
     9    QPainterPath, QTransform 
    1010) 
    1111 
     
    107107 
    108108class LinkItem(QGraphicsObject): 
    109     """A Link in the canvas. 
     109    """ 
     110    A Link in the canvas. 
    110111    """ 
    111112 
     
    144145 
    145146    def setSourceItem(self, item, anchor=None): 
    146         """Set the source `item` (:class:`CanvasNodeItem`). Use `anchor` 
    147         (:class:`AnchorPoint) as the curve start point (if `None` a new 
     147        """ 
     148        Set the source `item` (:class:`NodeItem`). Use `anchor` 
     149        (:class:`AnchorPoint`) as the curve start point (if ``None`` a new 
    148150        output anchor will be created). 
    149151 
    150         Setting item to `None` and a valid anchor is a valid operation 
    151         (for instance while mouse dragging one and of the link). 
     152        Setting item to ``None`` and a valid anchor is a valid operation 
     153        (for instance while mouse dragging one end of the link). 
    152154 
    153155        """ 
     
    193195 
    194196    def setSinkItem(self, item, anchor=None): 
    195         """Set the sink `item` (:class:`CanvasNodeItem`). Use `anchor` 
    196         (:class:`AnchorPoint) as the curve end point (if `None` a new 
     197        """ 
     198        Set the sink `item` (:class:`NodeItem`). Use `anchor` 
     199        (:class:`AnchorPoint`) as the curve end point (if ``None`` a new 
    197200        input anchor will be created). 
    198201 
    199         Setting item to `None` and a valid anchor is a valid operation 
     202        Setting item to ``None`` and a valid anchor is a valid operation 
    200203        (for instance while mouse dragging one and of the link). 
     204 
    201205        """ 
    202206        if item is not None and anchor is not None: 
     
    242246    def setFont(self, font): 
    243247        """ 
    244         Set the channel names font. 
     248        Set the font for the channel names text. 
    245249        """ 
    246250        if font != self.font(): 
     
    250254    def font(self): 
    251255        """ 
    252         Return the channel names font. 
     256        Return the font for the channel names text. 
    253257        """ 
    254258        return self.linkTextItem.font() 
    255259 
    256260    def setChannelNamesVisible(self, visible): 
     261        """ 
     262        Set the visibility of the channel name text. 
     263        """ 
    257264        self.linkTextItem.setVisible(visible) 
    258265 
    259266    def setSourceName(self, name): 
     267        """ 
     268        Set the name of the source (used in channel name text). 
     269        """ 
    260270        if self.__sourceName != name: 
    261271            self.__sourceName = name 
     
    263273 
    264274    def sourceName(self): 
     275        """ 
     276        Return the source name. 
     277        """ 
    265278        return self.__sourceName 
    266279 
    267280    def setSinkName(self, name): 
     281        """ 
     282        Set the name of the sink (used in channel name text). 
     283        """ 
    268284        if self.__sinkName != name: 
    269285            self.__sinkName = name 
     
    271287 
    272288    def sinkName(self): 
     289        """ 
     290        Return the sink name. 
     291        """ 
    273292        return self.__sinkName 
    274293 
     
    378397 
    379398    def setEnabled(self, enabled): 
     399        """ 
     400        Set link enabled state. When disabled the link is rendered with a 
     401        dashed line. 
     402 
     403        """ 
    380404        QGraphicsObject.setEnabled(self, enabled) 
    381405 
    382406    def setDynamicEnabled(self, enabled): 
     407        """ 
     408        Set the link's dynamic enabled state. 
     409 
     410        If the link is `dynamic` it will be rendered in red/green color 
     411        respectively depending on the state of the dynamic enabled state. 
     412 
     413        """ 
    383414        if self.__dynamicEnabled != enabled: 
    384415            self.__dynamicEnabled = enabled 
     
    387418 
    388419    def isDynamicEnabled(self): 
     420        """ 
     421        Is the link dynamic enabled. 
     422        """ 
    389423        return self.__dynamicEnabled 
    390424 
    391425    def setDynamic(self, dynamic): 
     426        """ 
     427        Mark the link as dynamic (e.i. it responds to the 
     428        ``setDynamicEnabled``). 
     429 
     430        """ 
    392431        if self.__dynamic != dynamic: 
    393432            self.__dynamic = dynamic 
     
    395434 
    396435    def isDynamic(self): 
     436        """ 
     437        Is the link dynamic. 
     438        """ 
    397439        return self.__dynamic 
    398440 
Note: See TracChangeset for help on using the changeset viewer.