Changeset 2239

Show
Ignore:
Timestamp:
03/02/08 23:26:38 (7 months ago)
Author:
arj..@yirdis.nl
Message:

updated docs of canvas module

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • gaphas/trunk/gaphas/canvas.py

    r2221 r2239  
    5555    solver = property(lambda s: s._solver) 
    5656 
     57 
    5758    @observed 
    5859    def add(self, item, parent=None): 
    …… 
    9293        self._dirty_matrix_items.discard(item) 
    9394 
     95 
    9496    def remove(self, item): 
    9597        """ 
    …… 
    126128            h.disconnect = lambda: 0 
    127129 
     130 
     131    def reparent(self, item, parent): 
     132        """ 
     133        Set new parent for an item. 
     134        """ 
     135        self._tree.reparent(item, parent) 
     136 
     137 
    128138    def get_all_items(self): 
    129139        """ 
    …… 
    140150        """ 
    141151        return self._tree.nodes 
    142      
     152 
     153 
    143154    def get_root_items(self): 
    144155        """ 
    …… 
    157168        """ 
    158169        return self._tree.get_children(None) 
    159  
    160     def reparent(self, item, parent): 
    161         """ 
    162         Set new parent for an item. 
    163         """ 
    164         self._tree.reparent(item, parent) 
    165170 
    166171 
    …… 
    180185        """ 
    181186        return self._tree.get_parent(item) 
     187 
    182188 
    183189    def get_ancestors(self, item): 
    …… 
    202208        return self._tree.get_ancestors(item) 
    203209 
     210 
    204211    def get_children(self, item): 
    205212        """ 
    …… 
    223230        return self._tree.get_children(item) 
    224231 
     232 
    225233    def get_all_children(self, item): 
    226234        """ 
    …… 
    243251        """ 
    244252        return self._tree.get_all_children(item) 
     253 
    245254 
    246255    def get_connected_items(self, item): 
    …… 
    276285        return connected_items 
    277286 
     287 
     288    #{ Matrices 
     289 
    278290    def get_matrix_i2c(self, item, calculate=False): 
    279291        """ 
    …… 
    285297        calculate: 
    286298            True will allow this function to actually calculate it, 
    287             in stead of raising an AttributeError when no matrix is present 
     299            in stead of raising an `AttributeError` when no matrix is present 
    288300            yet. Note that out-of-date matrices are not recalculated. 
    289301        """ 
    …… 
    302314        return item._matrix_c2i 
    303315 
     316 
     317    #{ Update cycle 
    304318 
    305319    @observed 
    …… 
    329343    reversible_method(request_update, reverse=request_update) 
    330344 
     345 
    331346    def request_matrix_update(self, item): 
    332347        """ 
    …… 
    334349        """ 
    335350        self.request_update(item, update=False, matrix=True) 
     351 
    336352 
    337353    def require_update(self): 
    …… 
    352368        """ 
    353369        return bool(self._dirty_items) 
     370 
    354371 
    355372    @async(single=True, priority=PRIORITY_HIGH_IDLE) 
    …… 
    555572 
    556573 
     574    #{ Views 
     575 
    557576    def register_view(self, view): 
    558577        """ 
    …… 
    570589        self._registered_views.discard(view) 
    571590 
     591 
    572592    def _update_views(self, dirty_items=(), dirty_matrix_items=(), removed_items=()): 
    573593        """ 
    …… 
    576596        for v in self._registered_views: 
    577597            v.request_update(dirty_items, dirty_matrix_items, removed_items) 
     598 
    578599 
    579600    def _obtain_cairo_context(self):