ClassBrowser
============

* :download:`Download example <PyObjCExample-ClassBrowser.zip>`

A simple class browser, demonstrating the use of ``NSBrowser`` (a "column view" hierarchical widget) and ``NSTableView``.


.. rst-class:: tabber

Sources
-------

.. rst-class:: tabbertab

ClassBrowser.py
...............

.. sourcecode:: python

    """ClassBrowser.py -- A simple class browser, demonstrating the use of an NSBrowser.
    
    To build the demo program, run this line in Terminal.app:
    
        $ python setup.py py2app -A
    
    This creates a directory "dist" containing ClassBrowser.app. (The
    -A option causes the files to be symlinked to the .app bundle instead
    of copied. This means you don't have to rebuild the app if you edit the
    sources or nibs.)
    
    See also the iClass demo.
    """
    import sys
    
    import objc
    from Foundation import NSObject
    from objc import getClassList, objc_object
    from PyObjCTools import AppHelper
    
    try:
        import AddressBook  # noqa: F401
    except ImportError:
        pass
    
    try:
        import PreferencePanes  # noqa: F401
    except ImportError:
        pass
    
    try:
        import InterfaceBuilder  # noqa: F401
    except ImportError:
        pass
    
    
    def _sortClasses(classList):
        classes = [(cls.__name__, cls) for cls in classList]
        classes.sort()
        return [cls for name, cls in classes]
    
    
    if sys.version_info[0] == 2:
    
        def formatSelector(selector):
            if selector.isClassMethod:
                return "+" + selector.selector
            else:
                return "-" + selector.selector
    
    
    else:
    
        def formatSelector(selector):
            if selector.isClassMethod:
                return "+" + selector.selector.decode("ascii")
            else:
                return "-" + selector.selector.decode("ascii")
    
    
    class ClassBrowserDelegate(NSObject):
        browser = objc.IBOutlet()
        pathLabel = objc.IBOutlet()
        table = objc.IBOutlet()
    
        selectedClassMethods = None
    
        def awakeFromNib(self):
            classes = getClassList()
            rootClasses = []
            for cls in classes:
                if cls.__base__ == objc_object:
                    rootClasses.append(cls)
            rootClasses = _sortClasses(rootClasses)
            self.columns = [rootClasses]
            self.browser.setMaxVisibleColumns_(7)
            self.browser.setMinColumnWidth_(150)
            self.selectedClass = None
            self.selectedClassMethods = None
    
        def browser_willDisplayCell_atRow_column_(self, browser, cell, row, col):
            cell.setLeaf_(not self.columns[col][row].__subclasses__())
            cell.setStringValue_(self.columns[col][row].__name__)
    
        def browser_numberOfRowsInColumn_(self, browser, col):
            if col == 0:
                return len(self.columns[0])
            del self.columns[col:]
            cls = self.columns[col - 1][browser.selectedRowInColumn_(col - 1)]
            subclasses = _sortClasses(cls.__subclasses__())
            self.columns.append(subclasses)
            return len(subclasses)
    
        @objc.IBAction
        def browserAction_(self, browser):
            self.pathLabel.setStringValue_(browser.path())
    
            self.selectedClass = None
            self.selectedClassMethods = None
            col = len(self.columns)
            row = -1
            while row == -1:
                col -= 1
                if col < 0:
                    break
                row = self.browser.selectedRowInColumn_(col)
    
            if row >= 0:
                self.selectedClass = self.columns[col][row]
                self.selectedClassMethods = [
                    formatSelector(obj)
                    for obj in self.selectedClass.pyobjc_instanceMethods.__dict__.values()
                    if hasattr(obj, "selector")
                ]
                self.selectedClassMethods += [
                    formatSelector(obj)
                    for obj in self.selectedClass.pyobjc_classMethods.__dict__.values()
                    if hasattr(obj, "selector")
                ]
                self.selectedClassMethods.sort()
    
            self.table.reloadData()
    
        # table view delegate methods
        def numberOfRowsInTableView_(self, tableView):
            if self.selectedClassMethods is None:
                return 0
            return len(self.selectedClassMethods)
    
        def tableView_objectValueForTableColumn_row_(self, tableView, col, row):
            return str(self.selectedClassMethods[row])
    
        def tableView_shouldEditTableColumn_row_(self, tableView, col, row):
            return 0
    
    
    if __name__ == "__main__":
        AppHelper.runEventLoop()

.. rst-class:: tabbertab

setup.py
........

.. sourcecode:: python

    """
    Script for building the example.
    
    Usage:
        python3 setup.py py2app
    """
    from setuptools import setup
    
    plist = {"NSMainNibFile": "ClassBrowser"}
    setup(
        name="ClassBrowser",
        app=["ClassBrowser.py"],
        data_files=["ClassBrowser.nib"],
        options={"py2app": {"plist": plist}},
        setup_requires=["py2app", "pyobjc-framework-Cocoa"],
    )

