Vvidget Code Reference Manual

Vvidget Code > Dictionary > Document

This section explains how to form a dictionary for a Document such as this:

Document
USA

A document is simply any Vvidget Builder document, i.e.: anything made by Vvidget Builder and then saved as its native document. See the Vvidget Builder User Manual for further information. Although any document can be inserted into an application, there are specialized documents that perform specific tasks. For example, documents that show Maps.

An example code fragment illustration follows:

/* Start of Illustration Code Fragment */

[constructor VC_append_key:"file_path" string_value:@"<any valid path to a book document>"];

/* End of Illustration Code Fragment */

The code fragment above can be inserted into the illustration code section of the Illustration project for an immediate running Cocoa application. Just make sure to set the value of @"<any valid path to a book document>" to an actual Vvidget Builder document that you previously saved. For additional information consult the Illustration section.

The following table defines the input string key and value pairs:

Dictionary Entries
KeyValue Description
file_pathAn absolute file path that references a Vvidget Builder book document.

If you incorporate this functionality into your own application then please consult Cocoa Programming. If you incorporate this functionality into CLI scripts then please consult Script Programming.

For example, if you include a Vvidget Builder document in the language resource directory of your project then the following code can be used to retrieve the document and image it within your application as you would any other dictionary.

NSString *file_path;

file_path = [[NSBundle mainBundle] resourcePath];
file_path = [file_path stringByAppendingPathComponent:@"English.lproj"];
file_path = [file_path stringByAppendingPathComponent:@"my_subdirectory"];
file_path = [file_path stringByAppendingPathComponent:@"USA"];

[EX_constructor VC_append_key:"file_path" string_value:file_path];

The following are vvidget name components in the template that can be used to adjust graphical attributes of the respective parts.

Vvidget Names
NameDescription
PVS_groupA group graphic. This is an optional component. If a group graphic is named, and if the graphical elements of the group have Descriptions and Names, then the Group Event Qualifier can be used to retrieve a mouse click or touch event in order to process the event, in particular retrieve the hit component name and description as set in the document.

You can obtain the same effect of loading a document into your application by simply loading a raster image file such as a PNG file; except the document loads into your application as live objects and thus can be processed upon. That processing can include many things and as demonstrated by the Map section it includes hit event processing and resize behavior that is beyond simple image resizing.

Please help improve this documentation. If a section is hard to understand, there is a typo, you would like a new section added, or you detect any other improvement that can be made then please email support@vvi.com with your information.




© Copyright 1993-2011 by VVimaging, Inc. (VVI); All Rights Reserved. Please email support@vvi.com with any comments you have concerning this documentation. See Legal for trademark and legal information.