Changeset 270

Timestamp:

10/03/08 06:44:16 (3 months ago)

Author:

tal

Message:

Added some documentation. Fixed a few small bugs.

Files:

• packages/defconAppKit/trunk/Lib/defconAppKit/views/glyphCollectionView.py (modified) (10 diffs)

packages/defconAppKit/trunk/Lib/defconAppKit/views/glyphCollectionView.py

@@ -154 +154 @@
-        ## tweak the scroll view
-        self._nsObject.setBackgroundColor_(gridColor)
+        ## table view tweak
+        self._haveTweakedColumnWidths = initialMode == "list"
-        ## set the mode
-        self._mode = None
-        self.setMode(initialMode)
-        ## table view tweak
-        self._haveTweakedColumnWidths = initialMode == "list"
-
-    def _breakCycles(self):
@@ -200 +200 @@
-            self._haveTweakedColumnWidths = True
-
+    def getMode(self):
+        """
+        Get the current mode.
+        """
+        return self._mode
+
-    # --------------------
-    # selection management
@@ -205 +211 @@
-
-    def getSelection(self):
+        """
+        Get the selection in the view as a list of indexes.
+        """
-        if self._mode == "list":
-            return super(GlyphCollectionView, self).getSelection()
@@ -210 +219 @@
-
-    def setSelection(self, selection):
+        """
+        Sets the selection in the view. The passed value
+        should be a list of indexes.
+        """
-        if self._mode == "list":
-            super(GlyphCollectionView, self).setSelection(selection)
@@ -216 +229 @@
-
-    def scrollToSelection(self):
+        """
+        Scroll the view so that the current selection is visible.
+        """
-        super(GlyphCollectionView, self).scrollToSelection()
-        selection = self.getSelection()
@@ -268 +284 @@
-    def _glyphChanged(self, notification):
-        glyph = notification.object
+        if glyph not in self._wrappedListItems:
+            return
-        d = self._wrappedListItems[glyph]
-        for key, attr in self._keyToAttribute.items():
@@ -426 +444 @@
-
-    def index(self, glyph):
-(glyph)
+[glyph]
-        return super(GlyphCollectionView, self).index(item)
-
@@ -444 +462 @@
-
-    def set(self, glyphs):
+        """
+        Set the glyphs in the view.
+        """
-        # remove removed wrapped items
-        removedGlyphs = set(self._wrappedListItems) - set(glyphs)
@@ -451 +472 @@
-        # wrap the glyphs for the list
-        wrappedGlyphs = [self._wrapGlyphForList(glyph) for glyph in glyphs]
+        # set the list
+        super(GlyphCollectionView, self).set(wrappedGlyphs)
-        # set the cell view
-        self._glyphCellView.setGlyphs_(glyphs)
-        # set the list
-        super(GlyphCollectionView, self).set(wrappedGlyphs)
-
-    def get(self):
+        """
+        Get the glyphs in the view.
+        """
-        return self._unwrapListItems()
-
@@ -464 +488 @@
-
-    def getGlyphCellView(self):
+        """
+        Get the cell NSView.
+        """
-        return self._glyphCellView
-
-    def setCellSize(self, (width, height)):
+        """
+        Set the size of the cells.
+        """
-        self._glyphCellView.setCellSize_((width, height))
-
-    def setCellRepresentationArguments(self, **kwargs):
+        """
+        Set the arguments that should be passed to the cell representation factory.
+        """
-        self._glyphCellView.setCellRepresentationArguments_(**kwargs)
-
-    def getCellRepresentationArguments(self):
+        """
+        Get the arguments passed to the cell representation factory.
+        """
-        return self._glyphCellView.getCellRepresentationArguments()
-
+    def preloadGlyphCellImages(self):
+        """
+        Preload the images to be used in the cells. This is useful
+        when lots of cellsneed to be displayed.
+        """
+        self._glyphCellView.preloadGlyphCellImages()
-
-# -------------