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

    r11343 r11369  
    11""" 
     2===================== 
    23Canvas Graphics Scene 
     4===================== 
    35 
    46""" 
     
    3335 
    3436class CanvasScene(QGraphicsScene): 
    35     """A Graphics Scene for displaying and editing an Orange Scheme. 
    3637    """ 
    37  
     38    A Graphics Scene for displaying and editing an :class:`Scheme`. 
     39    """ 
     40 
     41    #: An node item has been added to the scene. 
    3842    node_item_added = Signal(items.NodeItem) 
    39     """An node item has been added to the scene""" 
    40  
     43 
     44    #: An node item has been removed from the scene 
    4145    node_item_removed = Signal(items.LinkItem) 
    42     """An node item has been removed from the scene""" 
    43  
     46 
     47    #: A new link item has been added to the scene 
     48    link_item_added = Signal(items.LinkItem) 
     49 
     50    #: Link item has been removed 
     51    link_item_removed = Signal(items.LinkItem) 
     52 
     53    #: Annotation item has been added 
     54    annotation_added = Signal(items.annotationitem.Annotation) 
     55 
     56    #: Annotation item has been removed 
     57    annotation_removed = Signal(items.annotationitem.Annotation) 
     58 
     59    #: The position of a node has changed 
    4460    node_item_position_changed = Signal(items.NodeItem, QPointF) 
    45     """The position of a node has changed""" 
    46  
     61 
     62    #: An node item has been double clicked 
    4763    node_item_double_clicked = Signal(items.NodeItem) 
    48     """An node item has been double clicked""" 
    49  
     64 
     65    #: An node item has been activated (clicked) 
    5066    node_item_activated = Signal(items.NodeItem) 
    51     """An node item has been activated (clicked)""" 
    52  
     67 
     68    #: An node item has been hovered 
    5369    node_item_hovered = Signal(items.NodeItem) 
    54     """An node item has been hovered""" 
    55  
    56     link_item_added = Signal(items.LinkItem) 
    57     """A new link item has been added to the scene""" 
    58  
    59     link_item_removed = Signal(items.LinkItem) 
    60     """Link item has been removed""" 
    61  
     70 
     71    #: Link item has been hovered 
    6272    link_item_hovered = Signal(items.LinkItem) 
    63     """Link item has been hovered""" 
    64  
    65     annotation_added = Signal(items.annotationitem.Annotation) 
    66     """Annotation item has been added""" 
    67  
    68     annotation_removed = Signal(items.annotationitem.Annotation) 
    69     """Annotation item has been removed""" 
    7073 
    7174    def __init__(self, *args, **kwargs): 
Note: See TracChangeset for help on using the changeset viewer.