Changeset 4059

Timestamp:

05/03/2008 05:33:31 PM (2 months ago)

Author:

ed

Message:

Added a ToolTipText? property for Nodes. This way we can set the tooltips on a per-node basis.

Added the UseNodeToolTips? property on the tree. When this is True, the ToolTipText? is set to the node currently under the mouse; if there is no node, the tree's ToolTipText? is displayed. If the node does not have a specific ToolTipText? set, the node's Caption will be displayed in the ToolTipText?.

Added the ImageSize? property to the tree. This is a two-tuple of ints, with a default of (16, 16). This will ensure that all images added to a tree are consistent in size; some of the standard bitmaps are 16x15 or otherwise not acceptable for use in a tree, especially under Windows.

Added the option 'clearImageList' to the clear() method of the tree.

Greatly improved the makeDirTree() method. Added two parameters: 'ignore' and 'expand'; the first allows you to specify file patterns to exclude from the tree (e.g., "*pyc" to exclude compiled scripts); the latter will expand the tree once it is built. Also added default folder/file images to the generated tree. The nodes also include the full path to the file in their ToolTipText?.

Files:

• trunk/dabo/ui/uiwx/dTreeView.py (modified) (22 diffs)

trunk/dabo/ui/uiwx/dTreeView.py

@@ -24 +24 @@
-        # Nodes can have objects associated with them
-        self._object = None
+        # Custom text to display as a tooltip
+        self._toolTipText = None
-        # Add minimal Dabo functionality
-        self.afterInit()
@@ -262 +264 @@
-
-    
+    def _getToolTipText(self):
+        return self._toolTipText
+
+    def _setToolTipText(self, val):
+        if self._constructed():
+            self._toolTipText = val
+        else:
+            self._properties["ToolTipText"] = val
+
+
-    BackColor = property(_getBackColor, _setBackColor, None,
-            _("Background color of this node  (str, 3-tuple, or wx.Colour)") )
@@ -325 +337 @@
-    Siblings = property(_getSiblings, None, None,
-            _("List of all nodes with the same parent node.  (list of dNodes)") )
-
+
+
+
+
+
+
-
-    DynamicBackColor = makeDynamicProperty(BackColor)
@@ -338 +355 @@
-    DynamicImage = makeDynamicProperty(Image)
-    DynamicSelected = makeDynamicProperty(Selected)
-
+
+
-    
-
@@ -352 +370 @@
-        # Class to use for creating nodes
-        self._nodeClass = dNode
+        # Default size for images added to the tree.
+        self._imageSize = (16, 16)
+        # Do we set tooltips from the nodes?
+        self._useNodeToolTips = False
+        # Store the default ToolTipText while UseNodeToolTips is True
+        self._storedToolTipText = None
-        
-        style = self._extractKey((properties, attProperties, kwargs), "style", 0) | wx.TR_HAS_VARIABLE_ROW_HEIGHT
@@ -405 +429 @@
-        self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.__onTreeBeginDrag)
-        self.Bind(wx.EVT_TREE_END_DRAG, self.__onTreeEndDrag)
+        self.Bind(wx.EVT_MOTION, self.__onTreeMouseMove)
-
-
@@ -446 +471 @@
-
-        
-
+, clearImageList=False
-        self.DeleteAllItems()
-        self.nodes = []
+        if clearImageList:
+            il = self.GetImageList()
+            if il:
+                il.RemoveAll()
+            self.__imageList = {}
-    
-    
@@ -531 +561 @@
-        a reference to it that is retrievable via the key value.
-        """
+        # Default image size
+        wd, ht = self.ImageSize
+        il = self.GetImageList()
+        if not il:
+            il = wx.ImageList(wd, ht, initialCount=0)
+            self.AssignImageList(il)
+        else:
+            if il.GetImageCount():
+                wd, ht = il.GetSize(0)
-        if key is None:
-            key = str(img)
-        if isinstance(img, basestring):
-
-
-
-
-
+
-        idx = il.Add(img)
-        self.__imageList[key] = idx
@@ -783 +818 @@
-    
-    
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-        Warning: Don't use this for huge hierarchies, as it blocks while
@@ -790 +839 @@
-        they are opened.
-        """
-
+
+
+
+
+
+
+
-        # Add any trailing slash character
-        self._pathNode = {}
@@ -796 +851 @@
-        def addNode(showHid, currDir, fNames):
-            prnt, nm = os.path.split(currDir)
-
-
-
+
+
-            try:
-                nd = self._pathNode[currDir] = self._pathNode[prnt].appendChild(nm)
@@ -808 +862 @@
-                    # parent wasn't added, because it was hidden
-                    return
+            self.setNodeImg(nd, "folder", "normal")
+            self.setNodeImg(nd, "folderopen", "expanded")
+            nd.ToolTipText = currDir
+            acceptedNames = ignoredNames = None
+            if wildcard is not None:
+                acceptedNames = glob.glob(os.path.join(currDir, wildcard))
+            if ignored is not None:
+                ignoredNames = []
+                for ig in ignored:
+                    ignoredNames += glob.glob(os.path.join(currDir, ig))
-            for f in fNames:
-                fullName = os.path.join(currDir, f)
@@ -813 +877 @@
-                    # it will be added as a directory
-                    continue
-
-
+
+
+
+
-                        continue
-
-
-
+
+
-                        continue
-
+
+
+
-
-        def sortNode(arg, currDir, fNames):
@@ -826 +893 @@
-                self.SortChildren(self._pathNode[currDir].itemID)
-
+        if ignored and not isinstance(ignored, (list, tuple)):
+            # single string passed
+            ignored = [ignored]
-        os.path.walk(dirPath, addNode, showHidden)
-        os.path.walk(dirPath, sortNode, None)
+        if expand:
+            self.expandAll()
-
-
@@ -965 +1037 @@
-
-
+    def __onTreeMouseMove(self, evt):
+        if self._useNodeToolTips:
+            nd = self.getNodeUnderMouse()
+            if nd:
+                if nd.ToolTipText:
+                    self.ToolTipText = nd.ToolTipText
+                else:
+                    self.ToolTipText = nd.Caption
+            else:
+                if self._storedToolTipText is not None:
+                    self.ToolTipText = self._storedToolTipText
+                else:
+                    self.ToolTipText = ""
+        
+
-    def _getBaseNodes(self):
-        if self.ShowRootNode:
@@ -981 +1068 @@
-        if val:
-            self._addWindowStyleFlag(wx.TR_EDIT_LABELS)
+
+
+    def _getImageSize(self):
+        return self._imageSize
+
+    def _setImageSize(self, val):
+        if self._constructed():
+            self._imageSize = val
+        else:
+            self._properties["ImageSize"] = val
-
-
@@ -1100 +1197 @@
-            # Control may not be constructed yet
-            pass
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    BaseNodes = property(_getBaseNodes, None, None,
@@ -1110 +1222 @@
-        _("""Specifies whether the tree labels can be edited by the user."""))
-
+    ImageSize = property(_getImageSize, _setImageSize, None,
+            _("Size of images added to the tree. Default=(15, 15)  (2-tuple of int)"))
+
-    MultipleSelect = property(_getMultipleSelect, _setMultipleSelect, None,
-        _("""Specifies whether more than one node may be selected at once."""))
@@ -1138 +1253 @@
-    ShowRootNodeLines = property(_getShowRootNodeLines, _setShowRootNodeLines, None,
-        _("""Specifies whether vertical lines are shown between root siblings."""))
+    
+    UseNodeToolTips = property(_getUseNodeToolTips, _setUseNodeToolTips, None,
+            _("""When True, the ToolTipText displayed is taken from the node.  
+            Default=False  (bool)"""))
+
-
-
@@ -1163 +1283 @@
-        self.expandAll()
-        self.Hover = True
-
-
-
-
-
-
-
-
+
+
+
-    def onHit(self, evt):
-        ## pkm: currently, Hit happens on left mouse up, which totally ignores
-        ##      keyboarding through the tree. I'm wondering about mapping 
-        ##      TreeSelection instead... thoughts?
-        print "Hit!"
-    
@@ -1240 +1352 @@
-            chk = dabo.ui.dCheckBox(mp, Caption="ShowRootNodeLines", 
-                    DataSource=tree, DataField="ShowRootNodeLines")
+            sz.append(chk, halign="Left")
+            
+            chk = dabo.ui.dCheckBox(mp, Caption="UseNodeToolTips", 
+                    DataSource=tree, DataField="UseNodeToolTips")
-            sz.append(chk, halign="Left")
-            
@@ -1255 +1371 @@
-            sz.appendSpacer(10)
-        
-        
-        def onExpandAll(self, evt):
-            self.tree.expandAll()
-        
-        
-        def onCollapseAll(self, evt):