===============
PyObjC Examples
===============

Simple scripts that demo the core modules
-----------------------------------------

The directory `Scripts`__ contains a number of simple command-line scripts
that make use of Cocoa features.

.. __: Scripts

* `autoreadme.py`_

  This script is a daemon that will open the ReadMe file in the root of any
  (removable) volume that is inserted while this script is running.

  The script is part of `Introduction to PyObjC`_, an article at O'Reilly
  `MacDevCenter.com`_.

.. _`autoreadme.py`: Scripts/autoreadme.py
.. _`Introduction to PyObjC`: http://macdevcenter.com/pub/a/mac/2003/01/31/pyobjc_one.html
.. _`MacDevCenter.com`: http://macdevcenter.com/

* `debugging.py`__

  This script shows how to use ``PyObjCTools.Debugging`` to show tracebacks
  of all (Cocoa) exceptions (handled and unhandled).

.. __: Scripts/debugging.py

* `dictionary.py`__

  Demonstrate the usage of an ``NSMutableDictionary`` object with both
  Objective-C and Python dictionary syntax.

.. __: Scripts/dictionary.py

* `exportBook.py`__

  An example of using the ``AddressBook`` framework, this script exports some
  of the information about people in your addressbook to a CSV file.

.. __: Scripts/exportBook.py

* `findPython.py`__

  Demonstrate the usage of ``objc.loadBundleFunctions`` to access
  functionality from the standard C library on Mac OS X (``libSystem``,
  which is also available as the ``System.framework`` bundle).  This
  example uses the dyld runtime to determine which dylib the Python
  runtime came from.

.. __: Scripts/findPython.py

* `HelloWorld.py`__

  Demonstrates a nib-less Cocoa GUI (purely for informational purposes, you
  probably shouldn't make a habit of this)

.. __: Scripts/HelloWorld.py

* `kvo-debugging.py`__

  XXX
  An example script that demonstrates how PyObjC interacts with Key-Value
  Observing (KVO) at the lowest level.  This script was used to debug
  the PyObjC runtime and should not be used as a guideline for writing
  new KVO code.  It may be interesting to some until we ensure that we
  have proper unit tests for KVO and remove this example!

.. __: Scripts/kvo-debugging.py

* `pydict-to-objcdict.py`__

  Shows how ``PyObjCTools.Conversion`` can be used to convert a Python
  collection into an Objective-C property list.  These functions should
  not typically be necessary as the proxies for Python objects are
  compatible with Objective-C plists.

.. __: Scripts/pydict-to-objcdict.py

* `rendezvous.py`__

  Use an NSNetService class to look for servers using rendezvous.

.. __: Scripts/rendezvous.py

* `signal-demo.py`__

  Demonstrates how to get a backtrace when handling a fatal signal using
  ``PyObjCTools.Signals``.

.. __: Scripts/signal-demo.py

* `stdinreader.py`__

  Demonstrates how to write a console runloop based application that uses
  ``NSFileHandle`` to read stdin asynchronously.

.. __: Scripts/stdinreader.py

* `subclassing-objective-c.py`__

  A doctest that demonstrates the subclassing of an Objective-C class from
  Python.  Note that it is typically discouraged to define a ``__del__``
  method.

.. __: Scripts/subclassing-objective-c.py

* `super-call.py`__

  Demonstrates how create a subclass of an Objective-C class that overrides
  a selector, but calls the super implementation using Python syntax
  equivalent to ``[super init]``.

.. __: Scripts/super-call.py

* `wmEnable.py`__

  Another ``objc.loadBundleFunctions`` demonstration that shows how to
  call into a private CoreGraphics SPI and enable full WindowManager
  access from a process that would not otherwise have it due to a
  quirk in the implementation of WindowManager (the reason why ``pythonw``
  should be used instead of ``python``).  Use at your own risk!

.. __: Scripts/wmEnable.py


Cocoa Applications
------------------

The directory `AppKit`__ contains example applications using the Cocoa
Application Framework (aka "AppKit").

.. __: AppKit

Most of the following examples contain a ``setup.py`` script that can
build an application. See `Building applications`_ for details how to invoke
these scripts. Some examples contain an ``Xcode`` or ``Project Builder``
project file; simply double-click it and choose ``Build and Run``, or invoke
``xcodebuild`` or ``pbxbuild`` from the command line depending on which you
have installed.

.. _`Building applications`: ../Doc/intro.html#building-applications

* `ClassBrowser`__

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

.. __: AppKit/ClassBrowser

* `CurrencyConverter`_

  A simple NIB based application. Start with this one. Also see the
  `PyObjC tutorial`_.

.. _`CurrencyConverter`: AppKit/CurrencyConverter
.. _`PyObjC tutorial`: ../Doc/tutorial/tutorial.html

* `DotView`__

  A simple one-window demo showing how to custom drawing in a custom
  ``NSView``. Additionally shows how easy it is to embed a view in an
  ``NSScrollView``, as well as how to use an ``NSColorWell``.

.. __: AppKit/DotView

* `FieldGraph`__

  This shows an simple example of an MVC based application, that also
  makes use of ``NSBezierPaths``.  Contains a ``Project Builder`` project,
  as well as a ``setup.py`` script.

  The application calculates the field pattern and RMS field of an antenna
  array with up to three elements.

.. __: AppKit/FieldGraph

* `HotKeyPython`__

  Demonstrates how to use Carbon global hot keys from a PyObjC application.
  Also demonstrates how to use a ``NSApplication`` subclass.

.. __: AppKit/HotKeyPYthon

* `iClass`__

  A more elaborate class browser; demonstrates ``NSOutlineView`` and
  ``NSTableView``.

.. __: AppKit/iClass

* `PackageManager`__

  An implementation of the MacPython PackageManager application using
  Cocoa.

.. __: AppKit/PackageManager

* `PyInterpreter`__

  A full featured embedded Python interpreter.  This demonstrates
  more complicated uses of ``NSTextView``, manual event dispatching,
  and the new text completion feature of OS X 10.3.

.. __: AppKit/PyInterpreter

* `PyObjCLauncher`__

  A reimplementation of the Python script launcher helper application
  in PyObjC.

.. __: AppKit/PyObjCLauncher

* `PythonBrowser`__

  A reusable Python object browser, demonstrating the use of ``NSOutlineView``
  as well as how to use an ``NSWindowController`` subclass to create a window
  from a menu action.

.. __: AppKit/PythonBrowser

* `SimpleService`__

  Shows how to implement entries for the Services menu.

.. __: AppKit/SimpleService

* `TableModel`__

  Basic demo that shows how to use a ``NSTableView``.

.. __: AppKit/TableModel

* `TinyTinyEdit`__

  A minimal Document-based text editor application.

.. __: AppKit/TinyTinyEdit

* `TinyURLService`__

  Another simple service, this one converts URL or strings from the
  pasteboard to tinyurl.com equivalents.

.. __: AppKit/TinyURLService

* `Todo`_

  A more complex NIB based applications. This is a document-based application.
  The code is a translation into Python of an example project in
  `Learning Cocoa`_ from O'Reilly

.. _`Todo`: AppKit/ToDo
.. _`Learning Cocoa`: http://shop.oreilly.com/product/9780596003012.do

* `WebServicesTool`__

  Queries an XML-RPC enabled web server for the methods that it implements.
  Demonstrates a more advanced use of an ``NSTableView``, how to make a
  toolbar as well as how to use multi-threading.  Contains a
  ``Project Builder`` project as well as a ``setup.py`` script.

.. __: AppKit/WebServicesTool


Cocoa Bindings
--------------

The `CocoaBindings`__ directory contains a number of examples that make use of
Key-Value Coding and Cocoa Bindings. These scripts require Mac OS X 10.3 or
later.

.. __: CocoaBindings

* `Bookmarks`_

  Shows custom array controller that implements table view data
  source methods to support drag and drop, including copying
  objects from one window to another, drop of URLs, and
  re-ordering of the content array.

  Originally from `Cocoa Bindings Examples and Hints`_,
  converted to PyObjC by u.fiedler.

.. _`Bookmarks`: CocoaBindings/Bookmarks

* `ControlledPreferences`_

  Demonstrates how to use Cocoa Bindings to simplify storing and
  retrieving user preferences.  Also demonstrates how to use an
  ``NSValueTransformer`` to archive/unarchive a non-property-list
  type automatically (``NSColor``, in this case).

  Originally from `Cocoa Bindings Examples and Hints`_,
  converted to PyObjC by u.fiedler.

.. _`ControlledPreferences`: CocoaBindings/ControlledPreferences

* `CurrencyConvBinding`_

  A rewrite of `CurrencyConverter`_ using Cocoa Bindings.

  Originally from
  `Introduction to Developing Cocoa Applications Using Bindings`_,
  converted to PyObjC by u.fiedler.

.. _`CurrencyConvBinding`: CocoaBindings/CurrencyConvBinding
.. _`Introduction to Developing Cocoa Applications Using Bindings`: http://developer.apple.com/documentation/Cocoa/Conceptual/CurrencyConverterBindings/index.html

* `FilteringController`_

  Demonstrates how to subclass ``NSArrayController`` to implement filtering
  of a ``NSTableView``.  Also demonstrates the use of indexed accessors.

  Originally from `Cocoa Bindings Examples and Hints`_,
  converted to PyObjC by u.fiedler.

.. _`FilteringController`: CocoaBindings/FilteringController

* `GraphicsBindings`_

   Shows the use of a custom controller, a value transformer, and two custom
   bindings-enabled views. One view is a control that allows you to set the
   angle and offset of a shadow; the other view observes and displays a
   collection of graphic objects.

  Originally from `Cocoa Bindings Examples and Hints`_,
  converted to PyObjC by u.fiedler.

.. _`GraphicsBindings`: CocoaBindings/GraphicsBindings

* `ManualBindings`_

  A simple example that illustrates establishing bindings
  programmatically, including a number of options such as validation
  and an array operator, and indexed accessor methods. A custom model
  object implements custom validation method.

  Originally from `Cocoa Bindings Examples and Hints`_,
  converted to PyObjC by u.fiedler.

.. _`ManualBindings`: CocoaBindings/ManualBindings
.. _`Cocoa Bindings Examples and Hints`: http://homepage.mac.com/mmalc/CocoaExamples/controllers.html

* `TableModel`__

  Shows how to fill an ``NSTableView`` using Key-Value Coding.  Contains
  contains an ``Xcode`` project as well as a ``setup.py`` script.

.. __: CocoaBindings/TableModel

* `TableModelWithSearch`__

  A more advanced example of Key-Value Coding. This uses a custom
  ``NSArrayController``.  Contains contains an ``Xcode`` project
  as well as a ``setup.py`` script.

.. __: CocoaBindings/TableModelWithSearch

* `TemperatureTransformer`_

  An example that uses ``NSValueTransformer`` to convert between Celsius
  and Fahrenheit.

  Based on Apple's `Value Transformers`_ documentation,
  converted to PyObjC by u.fiedler.

.. _`TemperatureTransformer`: CocoaBindings/TemperatureTransformer
.. _`Value Transformers`: https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/ValueTransformers/index.html

* `ToDos`_

  Shows two array controllers, one to manage the contents of a table
  view, the other to manage a pop-up menu in a table column. Also
  shows two value transformers to alter the color of text.

  Originally from `Cocoa Bindings Examples and Hints`_,
  converted to PyObjC by u.fiedler.

.. _`ToDos`: CocoaBindings/ToDos

CoreData
--------

The directory `CoreData`__ contains a number of examples
that use the CoreData framework. This framework is available
in MacOS X 10.4 and later.

.. __: CoreData

* `OutlineEdit`__

  A python version of the OutlineEdit example that's included with
  Xcode 2.0.

.. __: CoreData/OutlineEdit

Foundation
----------

The directory `Foundation`_ contains a number of examples
that use only Foundation facilities.

* `simple-kvo.py`__

  Demonstrates the use of Key-Value Observing from a simple
  script, without a runloop.  Requires Mac OS X 10.3 or later.

.. __: Foundation/simple-kvo.py

Inject
------

The directory `Inject`_ contains a number of examples that use the
``objc.inject`` facility to inject code into another process.  These
examples require Mac OS X 10.3 or later.

.. _`Inject`: Inject

* `IDNSnitch`_

  A proof of concept `IDN spoofing defense`_ for Safari (tested with
  v1.2.4 on Mac OS X 10.3.8).  Demonstrates how to write an application
  that detects the launch of another application by bundle identifier,
  how to use ``objc.inject`` to load code into another application,
  how to override the implementation of an existing class but still
  call back into the original implementation, and how to reduce the
  size of such an application/plugin combination by using symlinks
  to share object files (the PyObjC extensions in this case).

.. _`IDNSnitch`: Inject/IDNSnitch
.. _`IDN spoofing defense`: http://bob.pythonmac.org/archives/2005/02/07/idn-spoofing-defense-for-safari/

* `InjectInterpreter`_:

  Shows how to inject an in-process Python interpreter into another
  process.  Based on the AppKit PyInterpreter example.

.. _`InjectInterpreter`: Inject/InjectInterpreter

* `InjectBrowser`_:

  Shows how to inject an in-process Python class browser into another
  process.  Based on the AppKit ClassBrowser example.

.. _`InjectBrowser`: Inject/ClassBrowser


OpenGL
------

The directory `OpenGL`_ contains a number of examples that use OpenGL with
a Cocoa UI.  These examples also require `PyOpenGL`__.

.. _`OpenGL`: OpenGL
.. __: http://pyopengl.sourceforge.net/

* `OpenGLDemo`__

  A simple program that shows how to use OpenGL in a Cocoa program.  It is a
  port of Apple's "CocoaGL" example.

.. __: OpenGL/OpenGLDemo


Plugins
-------

The directory `Plugins`__ contains a number of examples that embed a Python
plugin into another application.  Note that due to an implementation detail
of the py2app bundle template, these plugins are only compatible with
Mac OS X 10.3 and later.

.. __: Plugins

* `EnvironmentPrefs`__

  This ``NSPreferencePane`` can be used to edit the default environment
  for the current user. It also is a simple example of a localized application.

.. __: Plugins/EnvironmentPrefs

* `ProgressViewPalette`__

  A simple InterfaceBuilder palette written in Python.

.. __: Plugins/ProgressViewPalette

* `SillyBallsSaver`__

  A simple screensaver written in Python.

.. __: Plugins/SillyBallsSaver

* `WebKitInterpreter`__

  Uses the new WebKit Cocoa plugin API available in Safari 1.3
  and later to embed a PyInterpreter in the browser.

.. __: Plugins/WebKitInterpreter

Twisted Integration
-------------------

The directory `Twisted`_ contains a number of examples that use
`Twisted (2.0 or later)`__ with Cocoa.

.. _`Twisted`: Twisted
.. __: http://www.twistedmatrix.com

* `WebServicesTool`__

  This is a refactor of the WebServicesTool example that is made much simpler
  and faster by using Twisted.

.. __: Twisted/WebServicesTool

* `WebServicesTool-ControllerLayer`__

  This is an even simpler refactor of the Twisted WebServicesTool example that
  uses Cocoa Bindings to remove a lot of the UI related code.

.. __: Twisted/WebServicesTool-ControllerLayer


WebKit
------

The directory `WebKit`__ contains a number of examples that use the ``WebKit``
framework, the HTML rendering engine from Safari.

.. __: WebKit

* `PyDocURLProtocol`__

  This example implements a subclass of ``NSURLProtocol`` that can be used
  to load the ``pydoc`` documentation of a module.

  It also includes a simple documentation browser using ``WebKit`` and the
  ``PyDocURLProtocol`` class.

.. __: WebKit/PyDocURLProtocol


Some work-in-progress examples
------------------------------

The directory `NonFunctional`__ may contain a number of examples that are not working
for one reason or another. The most likely reason is that example relies on features
that have not yet been implemented.

.. __: NonFunctional
