{{TOCright}}
=Code Capture Tool=
==Introduction==
The Code Capture Tool (or CCT) is a [[LabVIEW]] development tool targeted at LabVIEW users to capture images of their code and make it easier to share those images in online forums. 
The CCT is based on an idea and earlier versions originally released by [http://forums.ni.com/ni/profile?user.id=34024 Chilly Charly] on the [[NI Forums]] as [http://forums.ni.com/ni/board/message?board.id=BreakPoint&thread.id=1020 starware]. 
Later, it evolved to a multiple OS and LabVIEW versions tool for creating code-shots and documentation shots. 
A collaboration between [[User:Yen|Yen]] and [[User:Tcplomp|Ton Plomp]] resulted in the 0.9.1 version of the CCT that is currently available through the [[LAVA CR]] at [http://forums.lavag.org/downloads-file121.html this site].

=Interface=
The CCT offers two interaces to make and distribute screenshots a [[Code_Capture_Tool#GUI|user interface]] and an [[Code_Capture_Tool#API|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.

[[Image:CCT_GUI.png|center|frame|Code Capture Tool user interface]]
===Front panel settings===

The Front Panel listbox supplies the following options:
{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| Rowspan="4"| [[Image:CCT_FP.png]]
| 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:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| Rowspan="4"|[[Image:CCT_BD.png]]
| 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:
{| class="wikitable"
|-
! Listbox
! Item
! Copied item
! Remarks
|-
| Rowspan="3"|[[Image:CCT_ClipBoard.png]]
| 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:
{| class="wikitable"
|-
! Menu Ring
! Item
! Description
|-
| Rowspan="4"|[[Image:CCT_Layout.png]]
| [[Image:CCT_Layout1.png]]
| Front panel in top, block diagram below
|-
| [[Image:CCT_Layout2.png]]
| Block diagram in top, front panel below
|-
| [[Image:CCT_Layout3.png]]
| Front panel in left, block diagram on the right
|-
| [[Image:CCT_Layout4.png]]
| Block diagram in left, front panel on the right
|}
===File settings===
[[Image:CCT_FileSettings.png]]

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 [[Image:CCT_Reset.png]].

===Zoom function===
[[Image:CCT_Zoom.png]]

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 [[Image:CCT_Help.png]] 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 [[Image:CCT_Capture.png]] 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.

{| class="wikitable"
|-
! Key
! Function
|-
| Enter
| Applies the current settings and does a [[Code_Capture_Tool#Capture|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.
[[Image:CCT_palette.PNG]]

{| class="wikitable"
|-
! [[#Methods|Methods]]
| [[Image:CCT_GetSessions.png]]
| [[Image:CCT_Capture_icon.png]]
| [[Image:CCT_SaveImage.png]]
| [[Image:CCT_CopyToClipboard.png]]
|
| [[Image:CCT_CloseSession.png]]
| [[Image:CCT_GenerateFileName.png]]
|-
! [[#Set properties|Set properties]]
| [[Image:CCT_SetFP.png]]
| [[Image:CCT_SetBD.png]]
| [[Image:CCT_SetLayout.png]]
| [[Image:CCT_SetClipboard.png]]
| [[Image:CCT_SetVI.png]]
| [[Image:CCT_SetFolder.png]]
| [[Image:CCT_SetFileName.png]]
|-
! [[#Get properties|Get properties]]
| [[Image:CCT_GetFP.png]]
| [[Image:CCT_GetBD.png]]
| [[Image:CCT_GetLayout.png]]
| [[Image:CCT_GetClipboard.png]]
| [[Image:CCT_GetVI.png]]
| [[Image:CCT_GetFolder.png]]
| [[Image:CCT_GetFileName.png]]
|-
! [[#Support|Support]]
| [[Image:CCT_Support.png]]
|
| [[Image:CCT_CaptureFP.png]]
| [[Image:CCT_CaptureBD.png]]
| [[Image:CCT_ShowGUI.png]]
| [[Image:CCT_70Container.png]]
| [[Image:CCT_80_Container.png]]
|}

===Methods===
These VIs are used to activate methods for the CCT.

====Create CCT Instance====
[[Image:CCT_Create_CCT.png|Creat 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====
[[Image:CCT_Capture_VI_Images_CCT.png|Capture Images]]

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

====Save Image====
[[Image:CCT_Save_Captured_Image_CCT.png|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====
[[Image:CCT_Copy_Data_to_Clipboard_CCT.png|Copy to Clipboard]]

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

====Destroy CCT Instance====
[[Image:CCT_Destroy_CCT.png|Destroy CCT Instance]]

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

====Generate File Name====
[[IMage:CCT_Generate_File_Name_CCT.png|Generate filename]]

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====
[[Image:CCT_Set_FP_Mode_CCT.png|Set FP mode]]

This VI will change the current front panel capture mode.

====Set Block Diagram Mode====
[[Image:CCT_Set_BD_Mode_CCT.png|Set BD mode]]

This VI will change the current block diagram capture mode.

====Set Layout Mode====
[[Image:CCT_Set_Layout_Mode_CCT.png|Set Layout mode]]

This VI will change the current layout orientation.

====Set Clipboard Mode====
[[Image:CCT_Set_Clipboard_Mode_CCT.png|Set Clipboard mode]]

This VI will change the current clipboard mode.

====Set Folder====
[[Image:CCT_Set_Folder_CCT.png|Set Folder]]

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

====Set Filename====
[[Image:CCT_Set_File_CCT.png|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====
[[Image:CCT_Get_FP_Setting_CCT.png|Get FP mode]]

This VI will read the current front panel capture mode.

====Get Block Diagram Mode====
[[Image:CCT_Get_BD_Mode_CCT.png|Get BD mode]]

This VI will read the current block diagram capture mode.

====Get Layout Mode====
[[Image:CCT_Get_Layout_Mode_CCT.png|Get Layout mode]]

This VI will read the current layout orientation.

====Get Clipboard Mode====
[[Image:CCT_Get_Clipboard_Mode_CCT.png|Get Clipboard mode]]

This VI will read the current clipboard mode.

====Get Folder====
[[Image:CCT_Get_Folder_CCT.png|Get Folder]]

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

====Get Filename====
[[Image:CCT_Get_File_CCT.png|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====
[[Image:CCT_Capture_Panel_Picture__CCT.png|Capture front panel]]

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

====Capture Block diagram====
[[Image:CCT_Capture_Diagram_Picture__CCT.png|Capture block diagram]]

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

====Show CCT GUI====
[[Image:Code_Capture_Tool_GUI__CCT.png|Show CCT GUI]]

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

====7.0 container VI====
[[Image:Container_70__CCT.png|7.0 container]]

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====
[[Image:Container_80__CCT.png|8.0 container]]

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