Changeset 199

Timestamp:

04/26/08 11:28:19 (9 months ago)

Author:

tal

Message:

Vanilla Cleanup Phase 1:

Prior to this checkin, various objects had private attributes that defined the NS class that they should use. For example, List defined _tableViewClass. Subclasses that wished to add custom behavior to the NS classes had to override these private attributes. This was not a nice API. I've now made these attributes public with names like nsTableViewClass. If you overrode these attributes in your objects, you need to update your code. I've made it so that your code will still work, but you will get DeprecationWarnings.

Files:

• packages/vanilla/trunk/Lib/vanilla/vanillaBase.py (modified) (2 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaButton.py (modified) (4 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaCheckBox.py (modified) (3 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaEditText.py (modified) (4 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaGradientButton.py (modified) (1 diff)
• packages/vanilla/trunk/Lib/vanilla/vanillaList.py (modified) (6 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaRadioGroup.py (modified) (3 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaScrollView.py (modified) (3 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaTextEditor.py (modified) (3 diffs)
• packages/vanilla/trunk/Lib/vanilla/vanillaWindows.py (modified) (5 diffs)

packages/vanilla/trunk/Lib/vanilla/vanillaBase.py

@@ -17 +17 @@
-
-    def _setupView(self, classOrName, posSize, callback=None):
+        self._testForDeprecatedAttributes()
-        cls = getNSSubclass(classOrName)
-        self._nsObject = cls(self)
@@ -26 +27 @@
-        if hasattr(self, "_target"):
-            self._target.callback = None
+
+    def _testForDeprecatedAttributes(self):
+        pass
-
-    def _setCallback(self, callback):

packages/vanilla/trunk/Lib/vanilla/vanillaButton.py

@@ -47 +47 @@
-    """
-
-_
-_
+
+
-    _frameAdjustments = {
-        'mini': (-1, -2, 2, 2),
@@ -77 +77 @@
-        self._setSizeStyle(sizeStyle)
-        self._nsObject.setTitle_(title)
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def getNSButton(self):
@@ -139 +149 @@
-    """
-    
-_
+
-    _frameAdjustments = None
-    
@@ -292 +302 @@
-    """
-
-_
+
-    _frameAdjustments = {
-        'regular': (0, -3, 0, 3),

packages/vanilla/trunk/Lib/vanilla/vanillaCheckBox.py

@@ -13 +13 @@
-class _CheckBoxStandardBuild(Button):
-
-_
+
-    _frameAdjustments = {
-        'mini': (-4, -4, 6, 8),
@@ -50 +50 @@
-class _CheckBoxManualBuildButton(Button):
-    
-_
+
-    _frameAdjustments = {
-        'regular': (-2, -3, 4, 4),
@@ -70 +70 @@
-class _CheckBoxManualBuildTextButton(Button):
-    
-_
+
-    _frameAdjustments = None
-    

packages/vanilla/trunk/Lib/vanilla/vanillaEditText.py

@@ -38 +38 @@
-    """
-    
-_t
+nsT
-
-    def __init__(self, posSize, text="", callback=None, continuous=True, readOnly=False, formatter=None, placeholder=None, sizeStyle="regular"):
@@ -69 +69 @@
-        #
-        self._continuous = continuous
-_t
+nsT
-        self._posSize = posSize
-        #
@@ -84 +84 @@
-        if placeholder:
-            cell.setPlaceholderString_(placeholder)
+
+    def _testForDeprecatedAttributes(self):
+        super(EditText, self)._testForDeprecatedAttributes()
+        from warnings import warn
+        if hasattr(self, "_textFieldClass"):
+            warn(DeprecationWarning("The _textFieldClass attribute is deprecated. Use the nsTextFieldClass attribute."))
+            self.nsTextFieldClass = self._textFieldClass
-
-    def getNSTextField(self):
@@ -142 +149 @@
-    """
-
-_t
+nsT
-

packages/vanilla/trunk/Lib/vanilla/vanillaGradientButton.py

@@ -4 +4 @@
-class GradientButton(ImageButton):
-
-_
+
-

packages/vanilla/trunk/Lib/vanilla/vanillaList.py

@@ -256 +256 @@
-    """
-
-_s
-_t
-_a
-_a
+nsS
+nsT
+nsA
+nsA
-
-    def __init__(self, posSize, items, dataSource=None, columnDescriptions=None, showColumnTitles=True,
@@ -349 +349 @@
-        self._posSize = posSize
-        self._enableDelete = enableDelete
-_s
+nsS
-        self._nsObject.setAutohidesScrollers_(autohidesScrollers)
-        self._nsObject.setHasHorizontalScroller_(True)
@@ -357 +357 @@
-        self._setAutosizingFromPosSize(posSize)
-        # add a table view to the scroll view
-_t
+nsT
-        self._nsObject.setDocumentView_(self._tableView)
-        # set up an observer that will be called by the bindings when a cell is edited
-        self._editCallback = editCallback
-_a
+nsA
-        if editCallback is not None:
-            self._editObserver._targetMethod = self._edit # circular reference to be killed in _breakCycles
@@ -369 +369 @@
-            items = NSMutableArray.arrayWithArray_(items)
-            # set up an array controller
-_a
+nsA
-            self._arrayController.setSelectsInsertedObjects_(False)
-            self._arrayController.setAvoidsEmptySelection_(not allowsEmptySelection)
@@ -415 +415 @@
-        if selectionCallback is not None:
-            self._selectionCallback = selectionCallback
-_a
+nsA
-            self._arrayController.addObserver_forKeyPath_options_context_(self._selectionObserver, 'selectionIndexes', NSKeyValueObservingOptionNew, 0)
-            self._selectionObserver._targetMethod = self._selection # circular reference to be killed in _breakCycles
@@ -448 +448 @@
-        # set the drag data
-        self._dragSettings = dragSettings
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def getNSScrollView(self):
-        """

packages/vanilla/trunk/Lib/vanilla/vanillaRadioGroup.py

@@ -26 +26 @@
-    """
-
-_c
+nsC
-
-    def __init__(self, posSize, titles, isVertical=True, callback=None, sizeStyle="regular"):
@@ -48 +48 @@
-        matrix = self._nsObject
-        matrix.setMode_(NSRadioModeMatrix)
-_c
+nsC
-        # XXX! this does not work for vertical radio groups!
-        matrix.setAutosizesCells_(True)
@@ -79 +79 @@
-            cell.setFont_(font)
-
+    def _testForDeprecatedAttributes(self):
+        super(RadioGroup, self)._testForDeprecatedAttributes()
+        from warnings import warn
+        if hasattr(self, "_cellClass"):
+            warn(DeprecationWarning("The _cellClass attribute is deprecated. Use the nsCellClass attribute."))
+            self.nsCellClass = self._cellClass
+
-    def getNSMatrix(self):
-        """

packages/vanilla/trunk/Lib/vanilla/vanillaScrollView.py

@@ -31 +31 @@
-    """
-
-_s
+nsS
-
-    def __init__(self, posSize, nsView, hasHorizontalScroller=True, hasVerticalScroller=True,
@@ -48 +48 @@
-        *backgroundColor* A _NSColor_ object representing the background color of the scroll view.
-        """
-_s
+nsS
-        if clipView is not None:
-            self._nsObject.setContentView_(clipView)
@@ -58 +58 @@
-        if backgroundColor:
-            self._nsObject.setBackgroundColor_(backgroundColor)
-
+
+
+
+
+
+
+
+
-    def getNSScrollView(self):
-        """

packages/vanilla/trunk/Lib/vanilla/vanillaTextEditor.py

@@ -34 +34 @@
-    """
-
-_t
+nsT
-
-    def __init__(self, posSize, text="", callback=None, readOnly=False, checksSpelling=False):
@@ -53 +53 @@
-        self._nsObject.setBorderType_(NSBezelBorder)
-        self._nsObject.setDrawsBackground_(True)
-_t
+nsT
-        self._textView.setAllowsUndo_(True)
-        self._textView.setString_(text)
@@ -63 +63 @@
-        self._setCallback(callback)
-        self._setAutosizingFromPosSize(posSize)
+
+    def _testForDeprecatedAttributes(self):
+        super(TextEditor, self)._testForDeprecatedAttributes()
+        from warnings import warn
+        if hasattr(self, "_textViewClass"):
+            warn(DeprecationWarning("The _textViewClass attribute is deprecated. Use the nsTextViewClass attribute."))
+            self.nsTextViewClass = self._textViewClass
-
-    def getNSScrollView(self):

packages/vanilla/trunk/Lib/vanilla/vanillaWindows.py

@@ -41 +41 @@
-        return cls.alloc().init()
-
-_
+
-    # use the unified title and toolbar in 10.4+
-    try:
-_
+
-    except NameError:
-        pass
-_
-_
+
+
-
-    def __init__(self, posSize, title="", minSize=None, maxSize=None, textured=False,
@@ -71 +71 @@
-        *initiallyVisible* Boolean value representing if the window will be initially visible. Default is True. If False, you can show the window later by calling window.show().
-        """
-_
+
-        if closable:
-            mask = mask | NSClosableWindowMask
@@ -90 +90 @@
-            cascade = False
-        frame = _calcFrame(NSScreen.mainScreen().visibleFrame(), ((l, t), (w, h)))
-_
+
-            frame, mask, NSBackingStoreBuffered, False)
-        if autosaveName is not None:
@@ -104 +104 @@
-            self._window.setMaxSize_(maxSize)
-        self._window.setTitle_(title)
-_
+
-        self._window.setReleasedWhenClosed_(False)
-        self._window.setDelegate_(self)
-        self._bindings = {}
-        self._initiallyVisible = initiallyVisible
+
+    def _testForDeprecatedAttributes(self):
+        from warnings import warn
+        if hasattr(self, "_nsWindowStyleMask"):
+            warn(DeprecationWarning("The _nsWindowStyleMask attribute is deprecated. Use the nsWindowStyleMask attribute."))
+            self.nsWindowStyleMask = self._nsWindowStyleMask
+        if hasattr(self, "_nsWindowClass"):
+            warn(DeprecationWarning("The _nsWindowClass attribute is deprecated. Use the nsWindowClass attribute."))
+            self.nsWindowClass = self._nsWindowClass
+        if hasattr(self, "_nsWindowLevel"):
+            warn(DeprecationWarning("The _nsWindowLevel attribute is deprecated. Use the nsWindowLevel attribute."))
+            self.nsWindowLevel = self._nsWindowLevel
-
-    def _cascade(self):
@@ -589 +601 @@
-    """
-
-_
-_
-_
+
+
+
-
-    def __init__(self, posSize, title="", minSize=None, maxSize=None,