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

Added rst documentation for scheme package.

Fixing docstrings in the process.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/scheme/annotations.py

    r11202 r11367  
    11""" 
     2================== 
    23Scheme Annotations 
     4================== 
    35 
    46""" 
     
    1214 
    1315class BaseSchemeAnnotation(QObject): 
    14     """Base class for scheme annotations. 
    1516    """ 
     17    Base class for scheme annotations. 
     18    """ 
     19    # Signal emitted when the geometry of the annotation changes 
    1620    geometry_changed = Signal() 
    1721 
    1822 
    1923class SchemeArrowAnnotation(BaseSchemeAnnotation): 
    20     """An arrow annotation in the scheme. 
     24    """ 
     25    An arrow annotation in the scheme. 
    2126    """ 
    2227 
     
    3237 
    3338    def set_line(self, start_pos, end_pos): 
    34         """Set arrow lines start and end position ((x, y) tuples). 
     39        """ 
     40        Set arrow lines start and end position (``(x, y)`` tuples). 
    3541        """ 
    3642        if self.__start_pos != start_pos or self.__end_pos != end_pos: 
     
    4046 
    4147    def start_pos(self): 
    42         """Start position. 
     48        """ 
     49        Start position of the arrow (base point). 
    4350        """ 
    4451        return self.__start_pos 
     
    4754 
    4855    def end_pos(self): 
    49         """Arrows end position (arrow head points toward the end).""" 
     56        """ 
     57        End position of the arrow (arrow head points toward the end). 
     58        """ 
    5059        return self.__end_pos 
    5160 
     
    5362 
    5463    def set_geometry(self, (start_pos, end_pos)): 
    55         """Set the geometry of the arrow as a start and end position tuples 
    56         (e.g. `set_geometry(((0, 0), (100, 0))). 
     64        """ 
     65        Set the geometry of the arrow as a start and end position tuples 
     66        (e.g. ``set_geometry(((0, 0), (100, 0))``). 
    5767 
    5868        """ 
     
    6070 
    6171    def geometry(self): 
    62         """Return the start and end positions of the arrow. 
    63  
     72        """ 
     73        Return the start and end positions of the arrow. 
    6474        """ 
    6575        return (self.start_pos, self.end_pos) 
     
    6878 
    6979    def set_color(self, color): 
    70         """Set the fill color for the arrow as a string (#RGB, #RRGGBB, 
    71         #RRRGGGBBB, #RRRRGGGGBBBB format or one of SVG color keyword 
     80        """ 
     81        Set the fill color for the arrow as a string (`#RGB`, `#RRGGBB`, 
     82        `#RRRGGGBBB`, `#RRRRGGGGBBBB` format or one of SVG color keyword 
    7283        names). 
    7384 
     
    8091 
    8192    def color(self): 
    82         """Return the arrow's fill color. 
     93        """ 
     94        The arrow's fill color. 
    8395        """ 
    8496        return self.__color 
     
    88100 
    89101class SchemeTextAnnotation(BaseSchemeAnnotation): 
    90     """Text annotation in the scheme. 
    91102    """ 
     103    Text annotation in the scheme. 
     104    """ 
     105 
     106    # Signal emitted when the annotation text changes. 
    92107    text_changed = Signal(unicode) 
     108 
     109    # Signal emitted when the annotation text font changes. 
    93110    font_changed = Signal(dict) 
    94111 
     
    101118 
    102119    def set_rect(self, (x, y, w, h)): 
    103         """Set the text geometry bounding rectangle 
    104         ((x, y, width, height) tuple). 
     120        """ 
     121        Set the text geometry bounding rectangle (``(x, y, width, height)`` 
     122        tuple). 
    105123 
    106124        """ 
     
    111129 
    112130    def rect(self): 
    113         """Text bounding rectangle 
     131        """ 
     132        Text bounding rectangle 
    114133        """ 
    115134        return self.__rect 
     
    118137 
    119138    def set_geometry(self, rect): 
    120         """Set the text geometry (same as `set_rect`) 
     139        """ 
     140        Set the text geometry (same as ``set_rect``) 
    121141        """ 
    122142        self.set_rect(rect) 
    123143 
    124144    def geometry(self): 
     145        """ 
     146        Text annotation geometry (same as ``rect`` 
     147        """ 
    125148        return self.rect 
    126149 
     
    128151 
    129152    def set_text(self, text): 
    130         """Set the annotation text. 
     153        """ 
     154        Set the annotation text. 
    131155        """ 
    132156        check_type(text, (basestring, QString)) 
     
    137161 
    138162    def text(self): 
    139         """Annotation text. 
     163        """ 
     164        Annotation text. 
    140165        """ 
    141166        return self.__text 
     
    144169 
    145170    def set_font(self, font): 
    146         """Set the annotation's font as a dictionary of font properties 
     171        """ 
     172        Set the annotation's font as a dictionary of font properties 
    147173        (at the moment only family and size are used). 
    148174 
    149             annotation.set_font({"family": "Helvetica", "size": 16}) 
     175            >>> annotation.set_font({"family": "Helvetica", "size": 16}) 
    150176 
    151177        """ 
     
    157183 
    158184    def font(self): 
    159         """Return the annotation's font property dictionary. 
     185        """ 
     186        Annotation's font property dictionary. 
    160187        """ 
    161188        return dict(self.__font) 
Note: See TracChangeset for help on using the changeset viewer.