About File Events

File waypoints can include any of the main file operations, such as file changed, open, close, new, save, save as, or revert.

File waypoint data includes:

• Document name
• Document path
• Thumbnail of the document (optional)

Note: Your API call is responsible for providing the thumbnail image. The icon can be static or generated by your application dynamically. The sample application in the SDK provides a detailed example of instrumenting file events.

This type of waypoint appears on the File track of the Screencast timeline. The icons are displayed in tooltips associated with the waypoints.

Examples of Chronicle::Metadata::FilesCategory waypoints:

#include <Chronicle/Chronicle.h>

const wchar_t *documentName = L"Drawing1";
const wchar_t *documentPath = L"C:\\Documents\\Drawing1.dwg";

Chronicle::Waypoint *waypoint;
Chronicle::Error err;

// Whenever a new document is opened
waypoint = Chronicle::Facade::Waypoints::newDocument(documentName);
err = Chronicle::Facade::waypointReached(waypoint);

// Whenever the current document changes (for appications supporting multiple documents)
waypoint = Chronicle::Facade::Waypoints::currentDocument(documentName);
err = Chronicle::Facade::waypointReached(waypoint);

// Whenever an existing document is opened
waypoint = Chronicle::Facade::Waypoints::documentOpened(documentName, documentPath);
err = Chronicle::Facade::waypointReached(waypoint);

// Whenever a document is saved
waypoint = Chronicle::Facade::Waypoints::documentSaved(documentName, documentPath);
err = Chronicle::Facade::waypointReached(waypoint);

// Whenever a document is reverted
waypoint = Chronicle::Facade::Waypoints::documentReverted(documentName, documentPath);
err = Chronicle::Facade::waypointReached(waypoint);

// Whenever a document is closed
waypoint = Chronicle::Facade::Waypoints::documentClosed(documentName, documentPath);
err = Chronicle::Facade::waypointReached(waypoint);