Ignore:
Timestamp:
03/25/13 14:39:50 (13 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Fixes to canvas package documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/canvas/scene.py

    r11411 r11442  
    3636class CanvasScene(QGraphicsScene): 
    3737    """ 
    38     A Graphics Scene for displaying and editing an :class:`Scheme`. 
     38    A Graphics Scene for displaying an :class:`~.scheme.Scheme` instance. 
    3939    """ 
    4040 
    41     #: An node item has been added to the scene. 
     41    #: Signal emitted when a :class:`NodeItem` has been added to the scene. 
    4242    node_item_added = Signal(items.NodeItem) 
    4343 
    44     #: An node item has been removed from the scene 
     44    #: Signal emitted when a :class:`NodeItem` has been removed from the 
     45    #: scene. 
    4546    node_item_removed = Signal(items.LinkItem) 
    4647 
    47     #: A new link item has been added to the scene 
     48    #: Signal emitted when a new :class:`LinkItem` has been added to the 
     49    #: scene. 
    4850    link_item_added = Signal(items.LinkItem) 
    4951 
    50     #: Link item has been removed 
     52    #: Signal emitted when a :class:`LinkItem` has been removed. 
    5153    link_item_removed = Signal(items.LinkItem) 
    5254 
    53     #: Annotation item has been added 
     55    #: Signal emitted when a :class:`Annotation` item has been added. 
    5456    annotation_added = Signal(items.annotationitem.Annotation) 
    5557 
    56     #: Annotation item has been removed 
     58    #: Signal emitted when a :class:`Annotation` item has been removed. 
    5759    annotation_removed = Signal(items.annotationitem.Annotation) 
    5860 
    59     #: The position of a node has changed 
     61    #: Signal emitted when the position of a :class:`NodeItem` has changed. 
    6062    node_item_position_changed = Signal(items.NodeItem, QPointF) 
    6163 
    62     #: An node item has been double clicked 
     64    #: Signal emitted when an :class:`NodeItem` has been double clicked. 
    6365    node_item_double_clicked = Signal(items.NodeItem) 
    6466 
     
    122124 
    123125    def clear_scene(self): 
     126        """ 
     127        Clear (reset) the scene. 
     128        """ 
    124129        self.scheme = None 
    125130        self.__node_items = [] 
     
    138143 
    139144    def set_scheme(self, scheme): 
    140         """Set the scheme to display and edit. Populates the scene 
    141         with nodes and links already in the scheme. 
     145        """ 
     146        Set the scheme to display. Populates the scene with nodes and links 
     147        already in the scheme. Any further change to the scheme will be 
     148        reflected in the scene. 
     149 
     150        Parameters 
     151        ---------- 
     152        scheme : :class:`~.scheme.Scheme` 
    142153 
    143154        """ 
     
    194205 
    195206    def set_registry(self, registry): 
    196         """Set the widget registry. 
    197         """ 
     207        """ 
     208        Set the widget registry. 
     209        """ 
     210        # TODO: Remove/Deprecate. Is used only to get the category/background 
     211        # color. That should be part of the SchemeNode/WidgetDescription. 
    198212        log.info("Setting registry '%s on '%s'." % (registry, self)) 
    199213        self.registry = registry 
    200214 
    201215    def set_anchor_layout(self, layout): 
     216        """ 
     217        Set an :class:`~.layout.AnchorLayout` 
     218        """ 
    202219        if self.__anchor_layout != layout: 
    203220            if self.__anchor_layout: 
     
    208225 
    209226    def anchor_layout(self): 
     227        """ 
     228        Return the anchor layout instance. 
     229        """ 
    210230        return self.__anchor_layout 
    211231 
    212232    def set_channel_names_visible(self, visible): 
     233        """ 
     234        Set the channel names visibility. 
     235        """ 
    213236        self.__channel_names_visible = visible 
    214237        for link in self.__link_items: 
     
    216239 
    217240    def channel_names_visible(self): 
     241        """ 
     242        Return the channel names visibility state. 
     243        """ 
    218244        return self.__channel_names_visible 
    219245 
    220246    def set_node_animation_enabled(self, enabled): 
     247        """ 
     248        Set node animation enabled state. 
     249        """ 
    221250        if self.__node_animation_enabled != enabled: 
    222251            self.__node_animation_enabled = enabled 
     
    226255 
    227256    def add_node_item(self, item): 
    228         """Add a :class:`NodeItem` instance to the scene. 
     257        """ 
     258        Add a :class:`.NodeItem` instance to the scene. 
    229259        """ 
    230260        if item in self.__node_items: 
     
    261291 
    262292    def add_node(self, node): 
    263         """Add and return a default constructed `NodeItem` for a 
    264         `SchemeNode` instance. If the node is already in the scene 
    265         do nothing and just return its item. 
     293        """ 
     294        Add and return a default constructed :class:`.NodeItem` for a 
     295        :class:`SchemeNode` instance `node`. If the `node` is already in 
     296        the scene do nothing and just return its item. 
    266297 
    267298        """ 
     
    290321 
    291322    def new_node_item(self, widget_desc, category_desc=None): 
    292         """Construct an new `NodeItem` from a `WidgetDescription`. 
     323        """ 
     324        Construct an new :class:`.NodeItem` from a `WidgetDescription`. 
    293325        Optionally also set `CategoryDescription`. 
    294326 
     
    313345 
    314346    def remove_node_item(self, item): 
    315         """Remove `item` (:class:`NodeItem`) from the scene. 
     347        """ 
     348        Remove `item` (:class:`.NodeItem`) from the scene. 
    316349        """ 
    317350        self.activated_mapper.removePyMappings(item) 
     
    327360 
    328361    def remove_node(self, node): 
    329         """Remove the `NodeItem` instance that was previously constructed for 
    330         a `SchemeNode` node using the `add_node` method. 
     362        """ 
     363        Remove the :class:`.NodeItem` instance that was previously 
     364        constructed for a :class:`SchemeNode` `node` using the `add_node` 
     365        method. 
    331366 
    332367        """ 
     
    341376 
    342377    def node_items(self): 
    343         """Return all :class:`NodeItem` instances in the scene. 
     378        """ 
     379        Return all :class:`.NodeItem` instances in the scene. 
    344380        """ 
    345381        return list(self.__node_items) 
    346382 
    347383    def add_link_item(self, item): 
    348         """Add a link (:class:`LinkItem`)to the scene. 
     384        """ 
     385        Add a link (:class:`.LinkItem`) to the scene. 
    349386        """ 
    350387        if item.scene() is not self: 
     
    364401 
    365402    def add_link(self, scheme_link): 
    366         """Create and add a `LinkItem` instance for a `SchemeLink` 
    367         instance. If the link is already in the scene do nothing 
    368         and just return its `LinkItem`. 
     403        """ 
     404        Create and add a :class:`.LinkItem` instance for a 
     405        :class:`SchemeLink` instance. If the link is already in the scene 
     406        do nothing and just return its :class:`.LinkItem`. 
    369407 
    370408        """ 
     
    392430    def new_link_item(self, source_item, source_channel, 
    393431                      sink_item, sink_channel): 
    394         """Construct and return a new `LinkItem` 
     432        """ 
     433        Construct and return a new :class:`.LinkItem` 
    395434        """ 
    396435        item = items.LinkItem() 
     
    420459 
    421460    def remove_link_item(self, item): 
    422         """Remove a link (:class:`LinkItem`) from the scene. 
     461        """ 
     462        Remove a link (:class:`.LinkItem`) from the scene. 
    423463        """ 
    424464        # Invalidate the anchor layout. 
     
    443483 
    444484    def remove_link(self, scheme_link): 
    445         """ Remove a `LinkItem` instance that was previously constructed for 
    446         a `SchemeLink` node using the `add_link` method. 
     485        """ 
     486        Remove a :class:`.LinkItem` instance that was previously constructed 
     487        for a :class:`SchemeLink` instance `link` using the `add_link` method. 
    447488 
    448489        """ 
     
    452493 
    453494    def link_items(self): 
    454         """Return all :class:`LinkItems` in the scene. 
    455  
     495        """ 
     496        Return all :class:`.LinkItem`\s in the scene. 
    456497        """ 
    457498        return list(self.__link_items) 
    458499 
    459500    def add_annotation_item(self, annotation): 
    460         """Add an `Annotation` item to the scene. 
    461  
     501        """ 
     502        Add an :class:`.Annotation` item to the scene. 
    462503        """ 
    463504        self.__annotation_items.append(annotation) 
     
    467508 
    468509    def add_annotation(self, scheme_annot): 
    469         """Create a new item for :class:`SchemeAnnotation` and add it 
     510        """ 
     511        Create a new item for :class:`SchemeAnnotation` and add it 
    470512        to the scene. If the `scheme_annot` is already in the scene do 
    471513        nothing and just return its item. 
     
    504546 
    505547    def remove_annotation_item(self, annotation): 
    506         """Remove an `Annotation` item from the scene. 
     548        """ 
     549        Remove an :class:`.Annotation` instance from the scene. 
    507550 
    508551        """ 
     
    512555 
    513556    def remove_annotation(self, scheme_annotation): 
     557        """ 
     558        Remove an :class:`.Annotation` instance that was previously added 
     559        using :func:`add_anotation`. 
     560 
     561        """ 
    514562        item = self.__item_for_annotation.pop(scheme_annotation) 
    515563 
     
    526574 
    527575    def annotation_items(self): 
    528         """Return all `Annotation` items in the scene. 
    529  
     576        """ 
     577        Return all :class:`.Annotation` items in the scene. 
    530578        """ 
    531579        return self.__annotation_items 
     
    540588 
    541589    def commit_scheme_node(self, node): 
    542         """Commit the `node` into the scheme. 
     590        """ 
     591        Commit the `node` into the scheme. 
    543592        """ 
    544593        if not self.editable: 
     
    553602            self.scheme.add_node(node) 
    554603        except Exception: 
    555             log.error("An unexpected error occurred while commiting node '%s'", 
     604            log.error("An error occurred while committing node '%s'", 
    556605                      node, exc_info=True) 
    557606            # Cleanup (remove the node item) 
     
    563612 
    564613    def commit_scheme_link(self, link): 
    565         """Commit a scheme link. 
     614        """ 
     615        Commit a scheme link. 
    566616        """ 
    567617        if not self.editable: 
     
    576626 
    577627    def node_for_item(self, item): 
    578         """Return the `SchemeNode` for the `item`. 
     628        """ 
     629        Return the `SchemeNode` for the `item`. 
    579630        """ 
    580631        rev = dict([(v, k) for k, v in self.__item_for_node.items()]) 
     
    582633 
    583634    def item_for_node(self, node): 
    584         """Return the :class:`NodeItem` instance for a :class:`SchemeNode`. 
     635        """ 
     636        Return the :class:`NodeItem` instance for a :class:`SchemeNode`. 
    585637        """ 
    586638        return self.__item_for_node[node] 
    587639 
    588640    def link_for_item(self, item): 
    589         """Return the `SchemeLink for `item` (:class:`LinkItem`). 
     641        """ 
     642        Return the `SchemeLink for `item` (:class:`LinkItem`). 
    590643        """ 
    591644        rev = dict([(v, k) for k, v in self.__item_for_link.items()]) 
     
    593646 
    594647    def item_for_link(self, link): 
    595         """Return the :class:`LinkItem` for a :class:`SchemeLink` 
     648        """ 
     649        Return the :class:`LinkItem` for a :class:`SchemeLink` 
    596650        """ 
    597651        return self.__item_for_link[link] 
    598652 
    599653    def selected_node_items(self): 
    600         """Return the selected :class:`NodeItem`'s. 
     654        """ 
     655        Return the selected :class:`NodeItem`'s. 
    601656        """ 
    602657        return [item for item in self.__node_items if item.isSelected()] 
    603658 
    604659    def selected_annotation_items(self): 
    605         """Return the selected :class:`Annotation`'s 
     660        """ 
     661        Return the selected :class:`Annotation`'s 
    606662        """ 
    607663        return [item for item in self.__annotation_items if item.isSelected()] 
    608664 
    609665    def node_links(self, node_item): 
    610         """Return all links from the `node_item` (:class:`NodeItem`). 
     666        """ 
     667        Return all links from the `node_item` (:class:`NodeItem`). 
    611668        """ 
    612669        return self.node_output_links(node_item) + \ 
     
    614671 
    615672    def node_output_links(self, node_item): 
    616         """Return a list of all output links from `node_item`. 
     673        """ 
     674        Return a list of all output links from `node_item`. 
    617675        """ 
    618676        return [link for link in self.__link_items 
     
    620678 
    621679    def node_input_links(self, node_item): 
    622         """Return a list of all input links for `node_item`. 
     680        """ 
     681        Return a list of all input links for `node_item`. 
    623682        """ 
    624683        return [link for link in self.__link_items 
     
    626685 
    627686    def neighbor_nodes(self, node_item): 
    628         """Return a list of `node_item`'s (class:`NodeItem`) neighbor nodes. 
     687        """ 
     688        Return a list of `node_item`'s (class:`NodeItem`) neighbor nodes. 
    629689        """ 
    630690        neighbors = map(attrgetter("sourceItem"), 
     
    811871 
    812872def grab_svg(scene): 
    813     """Return a SVG rendering of the scene contents. 
     873    """ 
     874    Return a SVG rendering of the scene contents. 
     875 
     876    Parameters 
     877    ---------- 
     878    scene : :class:`CanvasScene` 
     879 
    814880    """ 
    815881    from PyQt4.QtSvg import QSvgGenerator 
Note: See TracChangeset for help on using the changeset viewer.