diff options
Diffstat (limited to 'docs/symbols/jQuery.fn.Karma-Karma.html')
| -rw-r--r-- | docs/symbols/jQuery.fn.Karma-Karma.html | 645 |
1 files changed, 645 insertions, 0 deletions
diff --git a/docs/symbols/jQuery.fn.Karma-Karma.html b/docs/symbols/jQuery.fn.Karma-Karma.html new file mode 100644 index 0000000..3fa743a --- /dev/null +++ b/docs/symbols/jQuery.fn.Karma-Karma.html @@ -0,0 +1,645 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - jQuery.fn.Karma-Karma</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/jQuery.html">jQuery</a></li> + + <li><a href="../symbols/jQuery.fn.html">jQuery.fn</a></li> + + <li><a href="../symbols/jQuery.fn.Karma-Karma.html">jQuery.fn.Karma-Karma</a></li> + + <li><a href="../symbols/jQuery.fn.Karma-KGraphic.html">jQuery.fn.Karma-KGraphic</a></li> + + <li><a href="../symbols/jQuery.fn.Karma-KGroup.html">jQuery.fn.Karma-KGroup</a></li> + + <li><a href="../symbols/jQuery.fn.Karma-KObject.html">jQuery.fn.Karma-KObject</a></li> + + <li><a href="../symbols/Karma%23geometry.html">Karma#geometry</a></li> + + <li><a href="../symbols/Karma%23graphics.html">Karma#graphics</a></li> + + <li><a href="../symbols/Karma%23math.html">Karma#math</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class jQuery.fn.Karma-Karma + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + Represents a Karma (master) object. + + + <br /><i>Defined in: </i> <a href="../symbols/src/jquery.karma-0.5.js.html">jquery.karma-0.5.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jQuery.fn.Karma-Karma."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"><inner> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/jQuery.fn.Karma-Karma.html#constructor">jQuery.fn.Karma-Karma</a></b>(options) + </div> + <div class="description">Karma</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + +<!-- ============================== methods summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jQuery.fn.Karma-Karma."> + <caption>Method Summary</caption> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"><inner> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/jQuery.fn.Karma-Karma.html#-getLanguage">getLanguage</a></b>() + </div> + <div class="description">Gets the language acording to the browser language</div> + </td> + </tr> + + <tr> + <td class="attributes"><inner> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/jQuery.fn.Karma-Karma.html#-i18nWrapper">i18nWrapper</a></b>(options) + </div> + <div class="description">Creates a new Gettext object and returns a shortcut function to localise + defined strings.</div> + </td> + </tr> + + <tr> + <td class="attributes"><inner> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/jQuery.fn.Karma-Karma.html#-loadAlternatives">loadAlternatives</a></b>() + </div> + <div class="description">It will attempt to load a language file, the posible languages are defined + on language.alternatives.</div> + </td> + </tr> + + <tr> + <td class="attributes"><inner> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/jQuery.fn.Karma-Karma.html#-localiseContent">localiseContent</a></b>(lang) + </div> + <div class="description">Localises the inline html content and it creates the localised paths for + "images", "sounds" and "videos".</div> + </td> + </tr> + + </tbody> + </table> + + + + +<!-- ============================== events summary ======================== --> + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"><inner> + <b>jQuery.fn.Karma-Karma</b>(options) + </div> + + <div class="description"> + Karma + + </div> + + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String | Object}</span> <b>options</b> + + </dt> + <dd>Constructor arguments</dd> + + <dt> + <span class="light fixedFont">{String | Object}</span> <b>options.container</b> + <i>Optional</i> + </dt> + <dd>Target DIV-class that will contain + any canvas element created using Karma functions</dd> + + <dt> + <span class="light fixedFont">{String}</span> <b>options.language</b> + <i>Optional</i> + </dt> + <dd><ul> + <li>if it's seted: + Karma will assume that the according language file exists and Karma will try + to load it.<li> + <li>if it's not seted: + Karma will localise the content according to the Browser language + </li> + </ul></dd> + + <dt> + <span class="light fixedFont">{Array}</span> <b>options.language.alternatives</b> + <i>Optional</i> + </dt> + <dd>Alternatives for localizing the content. The first has the priority.</dd> + + <dt> + <span class="light fixedFont">{Object}</span> <b>options.i18n</b> + <i>Optional</i> + </dt> + <dd>Object that contains data for i18n.</dd> + + <dt> + <span class="light fixedFont">{Object | String}</span> <b>options.i18n.root</b> + <i>Optional, Default: self</i> + </dt> + <dd>Parent element where the i18n shortcut function will be attached.</dd> + + <dt> + <span class="light fixedFont">{String}</span> <b>options.i18n.shortcut</b> + <i>Optional, Default: _</i> + </dt> + <dd>Shortcut for calling i18n.</dd> + + <dt> + <span class="light fixedFont">{Number}</span> <b>options.fps</b> + <i>Optional, Default: 24</i> + </dt> + <dd>Frames per second at which Karma will perform any refresh action.</dd> + + </dl> + + + + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + +<!-- ============================== method details ========================= --> + + <div class="sectionTitle"> + Method Detail + </div> + + <a name="-getLanguage"> </a> + <div class="fixedFont"><inner> + + <span class="light">{Object}</span> + <b>getLanguage</b>() + + </div> + <div class="description"> + Gets the language acording to the browser language + + + </div> + + + + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd><span class="light fixedFont">{Object}</span> <br> + lang: countryCode and langCode (if specified) + langCode*: language code represented as xx, example: en.<br> + countryCode*: country code represented as YY, example: US.<br> +optional</dd> + + </dl> + + + + + <hr /> + + <a name="-i18nWrapper"> </a> + <div class="fixedFont"><inner> + + <span class="light">{Function}</span> + <b>i18nWrapper</b>(options) + + </div> + <div class="description"> + Creates a new Gettext object and returns a shortcut function to localise + defined strings.<br>We use karma.Gettext.js it's a modification of + <a href=http://jsgettext.berlios.de/doc/html/Gettext.html> + Gettext.js</a> from beril OS. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>options</b> + + </dt> + <dd>The arguments of the Gettext constructor</dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd><span class="light fixedFont">{Function}</span> A generic function to call Gettext functions + The generic function will call a Gettext function according to the number of arguments passed + <table> + <tr> + <th>No. params</th> + <th>Parameters</th> + <th>Gettext function called</th> + </tr> + <tr> + <td>1</td> + <td>msgid</td> + <td>gettext</td> + <tr> + <td>2</td> + <td>context, msgid</td> + <td>pgettext</td> + </tr> + <tr> + <td>3</td> + <td>number, singular, plural</td> + <td>ngettext</td> + </tr> + <tr> + <td>4</td> + <td>number, context, singular, plural</td> + <td>npgettext</td> + </tr> + </table></dd> + + </dl> + + + <dl class="detailList"> + <dt class="heading">Requires:</dt> + + <dd>karma.Gettext.js</dd> + + </dl> + + + + <hr /> + + <a name="-loadAlternatives"> </a> + <div class="fixedFont"><inner> + + <span class="light">{String}</span> + <b>loadAlternatives</b>() + + </div> + <div class="description"> + It will attempt to load a language file, the posible languages are defined + on language.alternatives. + <p>The language file type could be: .po (Pootle) or .json (JSON). The + precedence between file types is defined according to which is defined first + in supportedLangFileTypes. By default Pootle files has precedence over JSON, + files.</p> + + + </div> + + + + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd><span class="light fixedFont">{String}</span> The name of the language file loaded. Example: en-US.po</dd> + + </dl> + + + + <dl class="detailList"> + <dt class="heading">See:</dt> + + <dd>Karma</dd> + + </dl> + + + <hr /> + + <a name="-localiseContent"> </a> + <div class="fixedFont"><inner> + + + <b>localiseContent</b>(lang) + + </div> + <div class="description"> + Localises the inline html content and it creates the localised paths for + "images", "sounds" and "videos". + <b>Note:</b>Inline html localisation under development<br> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>lang</b> + + </dt> + <dd>The language that will be used to localise the content</dd> + + </dl> + + + + + + + + <dl class="detailList"> + <dt class="heading">See:</dt> + + <dd><a href="http://wiki.sugarlabs.org/go/Karma/Bundle_layout"> + Karma Bundle_layout</a></dd> + + </dl> + + + + + + +<!-- ============================== event details ========================= --> + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Thu Sep 03 2009 07:49:38 GMT+0545 (NPT) + </div> + </body> +</html> |