Introduction
This Documentation is meant for those with a basic grasp of HTML, javascript and jQuery. You can find documentation on them here. It would also be good if you knew some of the concepts on files and other firefox specific routines which documentation can be found on them here. You can go here to read up on jQuery. Another Plugin used is jDesktop which you can read up on here
Javascript Extensions
String.replaceAll(target,replacement)
Replaces all findings of target in the string with replacement
Array.clean(value)
Removes all elements in the arrray with the value held in value
jQuery Extensions
Referencing jQuery Extensions
To reference anything in jQuery Extensions you must call it with either $.function or jQuery.function
apps
An array containing all the apps currently installed on the system
createObject(type,id,class,html,css)
Returns an object by what is input
textNode(string)
Returns a textnode with the contents of the string as the text
lineBreak()
Appends a linebreak to the end of the content in the object referenced
appendChild(child)
Appends the child to the object or objects referenced
removeChildren()
Deletes all the contents of the object or objects referenced
disableSelection()
Disables the ability for someone to select the content in the object or objects referenced
System
Referencing System
To reference anything in System you must call it with either $.system.function or jQuery.system.function
OSname()
Returns the name of the Operating system
Possible names are 'Win', 'Mac', 'Linux' and 'Solaris'.
alert(message)
logs a message to firefox's console.
message is a string
warn(message)
logs a warning to firefox's console.
message is a string
error(message)
logs an error to firefox's console.
message is a string
info(message)
logs info to firefox's console.
message is a string
growl(message,title)
creates a notification in the loading bar
message and title are strings
md5(string)
encrypts the string in md5
OSslash
A string containing the type of slash used in paths on the current system
File
Referencing File
To reference anything in System you must call it with either $.file.function or jQuery.file.function
read(path)
Returns a string containing the contents of the file pointed to by path
pathFix(path)
Fixes the path to contain the right directory seperators for the system
cwd()
returns the directory containing boot.html
list(path)
Returns an array containing all the files in the folder pointed to by path
Settings
Referencing Settings
To reference anything in System you must call it with either $.settings.function or jQuery.settings.function
background
contains a relative path to the background
username
contains the username of the current user
theme
contains the name of the current theme in use by the system
getSettings()
Returns the settings in the settings file in a two part object. object.setting and object.value, both of which are arrays.
setSettings(object)
Sets the settings contained in the obejct, which is a two part object. object.setting and object.value, both of which are arrays.
setBackground(path)
Sets the background to the path and performs a quick refresh of the desktop's background
Window
Referencing Window
To reference anything in System you must call it with either $.window.function or jQuery.window.function
title(id[,title])
Sets or returns the title of the window identified by the window id
html(id[,string])
Sets or returns the html of the window identified by the window id
contianer(id)
returns a reference to the container object of the window specified by the window id
theme(theme)
Sets the window themes to the one in theme and performs a quick refresh of the desktop's windows