Code Capture Tool

Code Capture Tool

Introduction

The Code Capture Tool (or CCT) is a LabVIEW development tool targeted at LabVIEW users to share images of their code on internet forums. It is originally released by Chilly Charlie on the NI Forums as starware. It transformed in a multi-OS multi LabVIEW version tool for creating code-shots and documentation shots. A collaboration between Yen and Ton Plomp resulted in the 0.9.1 version of the CCT that is currently available through the LAVA CR at this site.

Interface

The CCT offers two interaces to make and distribute screenshots a user interface and an API

GUI

The user interface of the CCT allows the user to select which parts of a Front_Panel or Block_Diagram should be captured. The resulting image will be stored on disc and optionally the image or the path can be copied to the OS clipboard.

Code Capture Tool user interface

Front panel settings

The Front Panel listbox supplies the following options:

Listbox	Item	Captured parts
	None	Nothing
	Selected	All selected parts and items in between
	Visible	Everything visible in the current panel view
	All	Everything on the front panel

Block diagram settings

The Block Diagram listbox supplies the following options:

Listbox	Item	Captured parts
	None	Nothing
	Selected	All selected parts and items in between
	Visible	Everything visible in the current block diagram view
	All	Everything on the block diagram

Clipboard settings

The clipboard listbox supplies the following options:

Listbox	Item	Copied item	Remarks
	None	Nothing
	Path	Path of the captured image	On Linux/Mac only in LabVIEW 8.x
	Image	The captured image	Only on Windows

Layout settings

The Layout picture ring supplies the following layout options:

Menu Ring	Item	Description
		Front panel in top, block diagram below
		Block diagram in top, front panel below
		Front panel in left, block diagram on the right
		Block diagram in left, front panel on the right

File settings

The file settings consists of two controls, the string control to name the file and a browse button to set the folder where the file should be stored. To detect which folder is currently used hover over one of the two controls, the tip-strip will show the folder.

Resetting the folder

By default the storage folder is the LabVIEW temp folder (which by is the same as the OS temp folder), this can be changed with the browse folder, to restore the temp folder use this button .

Zoom function

The zoom slider allows the user to zoom in and out on the captured image and inspect it in detail, it only has a cosmetic function it won't change the stored image.

Help

The help button calls the about window of the CCT including a short description of the main functions, a link to the webpage, a list of know issues and licensing info.

Capture

The capture button will apply all the settings and perform the storage and copy of items and closes the window.

Key navigation

The CCT has several special key navigations to be a fast tool.

Key	Function
Enter	Applies the current settings and does a capture
F1	Loads the about window centered on the help tab
Escape	Closes the CCT

API

The API provides an interface to the various functions of the CCT. It's palette is accessible under the user.lib\Code Capture Tool.

Methods
Set properties
Get properties
Support

Methods

These VIs are used to activate methods for the CCT.

Create CCT Instance

This VI must be called for every instance of the CCT, it creates a GOOP dataspace that will contain the data of the instance. Calling this VI must be done with a valid VI reference.

Capture Image

This VI will apply the current settings and store the captured image in the CCT instance, additionally it returns the image itself.

Save Image

This VI will save the image to the path specified by a folder and filename stored in the CCT instance.

Copy to Clipboard

This VI will store the data specified by the clipboard settings to the clipboard.

Destroy CCT Instance

This VI must be called to close the CCT Instance and will free up used memory resources.

Generate File Name

This VI will generate a default filename based on the captured parts and VI name. This filename will not be stored inside the CCT session.

Set properties

These VIs are used to change properties for the CCT instance.

Set Front Panel Mode

This VI will change the current front panel capture mode.

Set Block Diagram Mode

This VI will change the current block diagram capture mode.

Set Layout Mode

This VI will change the current layout orientation.

Set Clipboard Mode

This VI will change the current clipboard mode.

Set Folder

This VI will change the folder where the images will be saved.

Set Filename

This VI will change the filename of the stored image.

Get properties

These VIs are used to retrieve properties for the CCT instance.

Get Front Panel Mode

This VI will read the current front panel capture mode.

Get Block Diagram Mode

This VI will read the current block diagram capture mode.

Get Layout Mode

This VI will read the current layout orientation.

Get Clipboard Mode

This VI will read the current clipboard mode.

Get Folder

This VI will read the folder where the images will be saved.

Get Filename

This VI will read the filename of the stored image.

Support

This submenu shows additional low level functions of the CCT.

Capture Front panel

Use this VI to have direct access to the capturing of a front panel.

Capture Block diagram

Use this VI to have direct access to the capturing of a block diagram.

Show CCT GUI

Use this VI to show the user interface of the CCT.

7.0 container VI

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 7.0 and up.

8.0 container VI

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 8.0 and up, don't forget to include the 7.0 container.

Licensing

The CCT is licensed under the BSD license