Update of /cvsroot/dynapi/dynapi/docs/config/data
In directory usw-pr-cvs1:/tmp/cvs-serv19282/data
Added Files:
dynapi.js
Log Message:
Initial import of documentation configuration files
--- NEW FILE ---
/// A static top level object required for all DynAPI related functions
/**
* The "DynAPI" object is the top level object in the DynAPI
* library. It is used primarily as a way to organize miscelleneous
* variables, and generic functions, and to attach single instance
* objects (such as DynLayer, DynDocument etc.). Every graphical
* component branches off from the DynAPI object. For example, the
* main browser document is referenced as a DynDocument that is a
* property of the DynAPI object (DynAPI.document). All DynLayers
* that are in that document are in a collection underneath
* DynAPI.document.children[] and so on.
*/
static class DynAPI
{
private:
/// Set to true when the document has been loaded.
boolean loaded;
/// Stores an array of plugin references
Object plugins;
/// Set to true when dragging is occuring
boolean wasDragging;
/// Stores location to library path
string librarypath;
/// Called on page load
void loadHandler();
/// Called on page resize
void resizeHandler();
/// Called on page unload
void unloadHandler();
public:
/// Adds a package to the DynAPI
/**
* For example, DynAPI.addPackage("dynapi.api") makes
* the "dynapi.api" package available to be used with
* wildcards in DynAPI.include().
*/
void addPackage(string package);
/// Adds the given array of file names to the given package name
/**
* For example, DynAPI.addPackage("dynapi.api",["dynlayer","dyndocument"]).
* If the given package does not exist, it will be created automatically.
*/
void addLibrary(string packagename,string files[]);
/// Returns "DynAPI" which is a reference to the DynAPI Object
string toString();
/// Returns the DynDocument with the given id
/**
* If no id is given, the default DynDocument is returned.
*/
DynDocument getDocument(string id);
/// Removes index object from array
/**
* If id is true then it removed index.id.
*/
void removeFromArray(object array[],object index,boolean id);
/// Sets the path to the library
void setLibraryPath(string path);
/// Mounts the plugin object to be used during unload, load, and resize events
void mountplugin(object plugin);
/// Includes the given library.
/**
* If path is present, src is considered to be a acutall directory path.
* Otherwise, the given package file is included.
*/
void include(string src,string path);
};
_______________________________________________
Dynapi-CVS mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/dynapi-cvs
