Identifying and Handling Transient or Special Data on the Clipboard

The Issue

TextExpander, Butler, TypeIt4Me, Typinator, Keyboard Maestro, pasteboard history applications, and other applications briefly commandeer Mac OS X’s general pasteboard to transport large chunks of data into the user’s current context quickly. Often, shortly after this data is inserted, the pasteboard is returned to its previous contents. These applications need a way to identify their data as being temporary, different than content Copied by the user, and/or otherwise special – additional pasteboard types offer a solution.

CopyPaste, PTHPasteboard, iClip, and other pasteboard history utilities maintain histories of the pasteboard’s contents. Pasteboard data identified as transient should not be included in these histories.

Additionally, password utilities such as 1Password might mark passwords or other sensitive data, either placed programmatically or user-Copied to the pasteboard, so that pasteboard history utilities could obfuscate passwords when displayed on screen (to avoid inadvertently revealing your password to a “shoulder surfer”), and/or avoid writing them as plain text to a pasteboard history file.

Pasteboard history utilities may also choose to treat content identified as not explicitly Copied by the user differently, either by excluding it, or by presenting it differently

The Solution

  1. Identify and respect currently-defined transient and not-user-Copied pasteboard data identifiers.

  2. Define new, shared transient, not-user-Copied, and confidential pasteboard data identifiers to use and respect in the future.

Existing Identifiers

Known ‘proprietary’ pasteboard marker types identifying the pasteboard content as “transient”:

Known ‘proprietary’ pasteboard marker types identifying the pasteboard content as confidential:

Please send other existing identifiers to: register@nspasteboard.org, and we’ll add them to this list.

Universal Identifiers

To avoid a proliferation of marker types from a variety of developers, use these universal identifiers:

Actions for Applications Which Manipulate the General Pasteboard

If you are writing a new application in this area, please don’t create new identifiers for generated or transient data. If you feel some other type of marker is needed for your software’s needs, join the discussion as mentioned below and propose it there.

Actions for Clipboard Historians or Displayers

If your software shows a history of the pasteboard contents, displays the current pasteboard contents, or otherwise manipulates or responds to changes in the general pasteboard:

Discussion

These pasteboard marker types and proposals for others are discussed on a Google Group discussion list. To request an invitation to the group, send an email to textexpander@smilesoftware.com with subject: NSPasteboard.org.

Document History


Hosted by Smile Software