Ignore:
Timestamp:
03/08/13 17:13:44 (13 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added sphinx documentation for SchemeEditWidget.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/document/schemeedit.py

    r11389 r11390  
    11""" 
    2 Scheme Edit widget. 
     2==================== 
     3Scheme Editor Widget 
     4==================== 
     5 
    36 
    47""" 
     
    2831from ..gui.quickhelp import QuickHelpTipEvent 
    2932from ..gui.utils import message_information, disabled 
    30 from ..scheme import scheme 
     33from ..scheme import scheme, SchemeNode, SchemeLink, BaseSchemeAnnotation 
    3134from ..canvas.scene import CanvasScene 
    3235from ..canvas.view import CanvasView 
     
    3538from . import commands 
    3639from . import quickmenu 
     40 
    3741 
    3842log = logging.getLogger(__name__) 
     
    7074class SchemeEditWidget(QWidget): 
    7175    """ 
    72     An editor for a :class:`Scheme` instance. 
     76    A widget for editing a :class:`~.scheme.Scheme` instance. 
    7377 
    7478    """ 
     
    368372        """ 
    369373        Return a list of actions that can be inserted into a toolbar. 
     374        At the moment these are: 
     375 
     376            - 'Zoom' action 
     377            - 'Clean up' action (align to grid) 
     378            - 'New text annotation' action (with a size menu) 
     379            - 'New arrow annotation' action (with a color menu) 
     380 
    370381        """ 
    371382        return [self.__zoomAction, 
     
    376387    def menuBarActions(self): 
    377388        """ 
    378         Return a list of actions that can be inserted into a QMenuBar. 
    379         These actions should have a menu (i.e. a 'File' action should 
    380         have a menu with "New", "Open", ...) 
     389        Return a list of actions that can be inserted into a `QMenuBar`. 
    381390 
    382391        """ 
     
    425434        """ 
    426435        Set quick menu trigger flags. 
     436 
     437        Flags can be a bitwise `or` of: 
     438 
     439            - `SchemeEditWidget.NoTrigeres` 
     440            - `SchemeEditWidget.Clicked` 
     441            - `SchemeEditWidget.DoubleClicked` 
     442            - `SchemeEditWidget.SpaceKey` 
     443            - `SchemeEditWidget.AnyKey` 
     444 
    427445        """ 
    428446        if self.__quickMenuTriggers != triggers: 
     
    478496    def setScheme(self, scheme): 
    479497        """ 
    480         Set the :class:`Scheme` instance to display/edit. 
    481  
     498        Set the :class:`~.scheme.Scheme` instance to display/edit. 
    482499        """ 
    483500        if self.__scheme is not scheme: 
     
    570587    def scheme(self): 
    571588        """ 
    572         Return the :class:`Scheme` edited by the widget. 
     589        Return the :class:`~.scheme.Scheme` edited by the widget. 
    573590        """ 
    574591        return self.__scheme 
     
    584601    def view(self): 
    585602        """ 
    586         Return the class:`QGraphicsView` instance used to display the 
     603        Return the :class:`QGraphicsView` instance used to display the 
    587604        current scene. 
    588605 
     
    602619    def quickMenu(self): 
    603620        """ 
    604         Return a quick menu instance for quick new node creation. 
     621        Return a :class:`~.quickmenu.QuickMenu` popup menu instance for 
     622        new node creation. 
     623 
    605624        """ 
    606625        if self.__quickMenu is None: 
     
    629648    def addNode(self, node): 
    630649        """ 
    631         Add a new node (:class:`SchemeNode`) to the document. 
     650        Add a new node (:class:`.SchemeNode`) to the document. 
    632651        """ 
    633652        command = commands.AddNodeCommand(self.__scheme, node) 
     
    636655    def createNewNode(self, description, title=None, position=None): 
    637656        """ 
    638         Create a new :class:`SchemeNode` and add it to the document. The new 
    639         node is constructed using :ref:`newNodeHelper` method. 
     657        Create a new :class:`.SchemeNode` and add it to the document. 
     658        The new node is constructed using :ref:`newNodeHelper` method. 
    640659 
    641660        """ 
     
    647666    def newNodeHelper(self, description, title=None, position=None): 
    648667        """ 
    649         Return a new initialized :class:`SchemeNode`. If `title` and 
    650         `position` are not supplied they are initialized to sensible 
     668        Return a new initialized :class:`.SchemeNode`. If `title` 
     669        and `position` are not supplied they are initialized to sensible 
    651670        defaults. 
    652671 
     
    658677            position = self.nextPosition() 
    659678 
    660         return scheme.SchemeNode(description, title=title, position=position) 
     679        return SchemeNode(description, title=title, position=position) 
    661680 
    662681    def enumerateTitle(self, title): 
     
    677696    def nextPosition(self): 
    678697        """ 
    679         Return the next default node position (x, y) tuple. This is 
     698        Return the next default node position as a (x, y) tuple. This is 
    680699        a position left of the last added node. 
    681700 
     
    691710    def removeNode(self, node): 
    692711        """ 
    693         Remove a `node` (:class:`SchemeNode`) from the scheme 
     712        Remove a `node` (:class:`.SchemeNode`) from the scheme 
    694713        """ 
    695714        command = commands.RemoveNodeCommand(self.__scheme, node) 
     
    698717    def renameNode(self, node, title): 
    699718        """ 
    700         Rename a `node` (:class:`SchemeNode`) to `title`. 
     719        Rename a `node` (:class:`.SchemeNode`) to `title`. 
    701720        """ 
    702721        command = commands.RenameNodeCommand(self.__scheme, node, title) 
     
    705724    def addLink(self, link): 
    706725        """ 
    707         Add a `link` (:class:`SchemeLink`) to the scheme. 
     726        Add a `link` (:class:`.SchemeLink`) to the scheme. 
    708727        """ 
    709728        command = commands.AddLinkCommand(self.__scheme, link) 
     
    712731    def removeLink(self, link): 
    713732        """ 
    714         Remove a link (:class:`SchemeLink`) from the scheme. 
     733        Remove a link (:class:`.SchemeLink`) from the scheme. 
    715734        """ 
    716735        command = commands.RemoveLinkCommand(self.__scheme, link) 
     
    719738    def addAnnotation(self, annotation): 
    720739        """ 
    721         Add `annotation` (:class:`BaseSchemeAnnotation`) to the scheme 
     740        Add `annotation` (:class:`.BaseSchemeAnnotation`) to the scheme 
    722741        """ 
    723742        command = commands.AddAnnotationCommand(self.__scheme, annotation) 
     
    726745    def removeAnnotation(self, annotation): 
    727746        """ 
    728         Remove `annotation` (:class:`BaseSchemeAnnotation`) from the scheme. 
     747        Remove `annotation` (:class:`.BaseSchemeAnnotation`) from the scheme. 
    729748        """ 
    730749        command = commands.RemoveAnnotationCommand(self.__scheme, annotation) 
     
    805824    def focusNode(self): 
    806825        """ 
    807         Return the current focused :class:`SchemeNode` or ``None`` if no 
     826        Return the current focused :class:`.SchemeNode` or ``None`` if no 
    808827        node has focus. 
    809828 
     
    822841    def selectedNodes(self): 
    823842        """ 
    824         Return all selected :class:`SchemeNode` items. 
     843        Return all selected :class:`.SchemeNode` items. 
    825844        """ 
    826845        return map(self.scene().node_for_item, 
     
    829848    def selectedAnnotations(self): 
    830849        """ 
    831         Return all selected :class:`SchemeAnnotation` items. 
     850        Return all selected :class:`.BaseSchemeAnnotation` items. 
    832851        """ 
    833852        return map(self.scene().annotation_for_item, 
     
    9881007                stack.beginMacro(self.tr("Move")) 
    9891008                for scheme_item, (old, new) in self.__itemsMoving.items(): 
    990                     if isinstance(scheme_item, scheme.SchemeNode): 
     1009                    if isinstance(scheme_item, SchemeNode): 
    9911010                        command = commands.MoveNodeCommand( 
    9921011                            self.scheme(), scheme_item, old, new 
    9931012                        ) 
    994                     elif isinstance(scheme_item, scheme.BaseSchemeAnnotation): 
     1013                    elif isinstance(scheme_item, BaseSchemeAnnotation): 
    9951014                        command = commands.AnnotationGeometryChange( 
    9961015                            self.scheme(), scheme_item, old, new 
Note: See TracChangeset for help on using the changeset viewer.