The Standard Tools

In addition to defining the core tool architecture, Facets also includes several dozen predefined tools, contained in the facets.extra.tools package. Useful in their own right, this collection of tools also provides a rich collection of examples to study or use when creating your own tools.

The remainder of this section contains descriptions of each available standard tool, providing information about:

• The module and class name for the tool.
• The purpose and function of the tool.
• The available input and output connections provided by the tool.
• Any additional features or options supported by the tool.
• Screenshots of the tool in use.

The Tools Catalog

AppMonitor

Displays views of all application objects associated with its containing tool window or any other DockWindow specified by its input Control object.

ClassBrowser

Displays a hierarchical tree view of all packages, modules, classes and methods containing in the application’s PYTHONPATH.

Clipboard

Defines a clipboard tool that allows copying and pasting text, images and arbitrary Python objects to and from the system clipboard.

ControlFlasher

A tool that causes any input Control object to flash briefly on the screen.

ControlGrabber

Allows you to grab any Facets UI control and make it available for use with other tools.

ControlStack

Displays the parent and child Controls of an input Control object and allows you to select any displayed Control for further processing by other tools.

CrossReference

Allows you display and select information about the various module-level symbols defined and referenced within a specified Python source code tree.

DropZone

Allows you to drag and drop objects which are forwarded to all connected tools.

FacetDB

Allows you to view the contents of, and optionally delete, the items contained in a Facets database.

FileBrowser

Allows you to display a hierarchical tree view of a specified portion of your file system and select directories or files within the hierarchy.

FileStack

Allows you to select files using a FileStackEditor.

ImageCollector

Allows you to collect, organize, display and select images.

ImageLibrarySelector

Allows you to select any image contained within the Facets ImageLibrary.

ImageLibraryViewer

Allows you to display, filter and select multiple images contained within the Facets ImageLibrary.

ImageZoomer

Allows you to display an input image as a zoomable image using the standard Facets ImageZoomEditor.

ObjectSource

Displays a series of tabs, one for each Python source module used to implement any HasFacets object it receives. Each tab in turn displays a hierarchical tree view of all classes and methods defined by the source module.

PrintObject

Prints the contents of any input object it receives to stdout.

SelectDockWindowTheme

Allows you to select a new default DockWindow theme from a list of available factory defined themes.

Stdout

Allows you to intercept, display, filter and search text sent to the application’s stdout and/or stderr files.

SyntaxChecker

Performs syntax checking on an input Python source file.

TextCollector

Allows you to organize, filter, display and select from a collection of input text strings.

TracebackViewer

Allows you to display and select information about Python tracebacks.

ViewTester

Allows you to display and/or test the Facets UI View associated with an input source file.

VIPShell

Displays an instance of the standard Facets VIP Shell, a graphical, interactive Python shell.