PageRenderTime 29ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/symbols/DecafMUD.plugins.Encoding.iso88591.html

https://bitbucket.org/stendec/decafmud/
HTML | 303 lines | 167 code | 116 blank | 20 comment | 0 complexity | 3b777c45f1287ccec1908b9a2334b40f MD5 | raw file
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  3. <head>
  4. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  5. <meta name="generator" content="JsDoc Toolkit" />
  6. <title>DecafMUD Reference - DecafMUD.plugins.Encoding.iso88591</title>
  7. <link href="../css/default.css" type="text/css" rel="stylesheet" media="all" />
  8. <link href="../css/shCoreDefault.css" type="text/css" rel="stylesheet" media="all" />
  9. <link href="../css/shThemeDefault.css" type="text/css" rel="stylesheet" media="all" />
  10. <link href="../img/favicon.ico" rel="shortcut icon" />
  11. <script type="text/javascript" src="../js/shCore.js"></script>
  12. <script type="text/javascript" src="../js/shBrushJScript.js"></script>
  13. </head>
  14. <body>
  15. <div id="header">
  16. <h1><a href="http://decafmud.kicks-ass.net/">DecafMUD</a></h1>
  17. <p class="paren">{</p>
  18. <p>HTML + CSS + JavaScript</p>
  19. <p class="paren last-paren">}</p>
  20. <p>keep Java away from your browser</p>
  21. <div style="clear:both"></div>
  22. </div>
  23. <div class="index">
  24. <div class="menu">
  25. <!-- begin publish.classesIndex -->
  26. <div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div>
  27. <h2 class="heading1">Classes</h2>
  28. <ul class="classList">
  29. <li class="namespace builtin"><a href="../symbols/_global_.html">_global_</a></li><li class="class"><a href="../symbols/DecafMUD.html">DecafMUD</a></li><li class="namespace">&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.html">.plugins</a></li><li class="nolink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.Display</li><li class="class">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Display.standard.html">.standard</a></li><li class="nolink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.Encoding</li><li class="namespace">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Encoding.cp437.html">.cp437</a></li><li class="namespace">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Encoding.iso88591.html">.iso88591</a></li><li class="namespace">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Encoding.iso885915.html">.iso885915</a></li><li class="namespace">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Encoding.utf8.html">.utf8</a></li><li class="nolink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.Interface</li><li class="class">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Interface.simple.html">.simple</a></li><li class="nolink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.Socket</li><li class="class">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Socket.websocket.html">.websocket</a></li><li class="nolink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.Storage</li><li class="class">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../symbols/DecafMUD.plugins.Storage.standard.html">.standard</a></li><li class="nolink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.Telopt</li><li class="class">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;DecafMUD.plugins.Telopt.]</li><li class="class">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;DecafMUD.plugins.Telopt.�</li><li class="namespace builtin"><a href="../symbols/String.html">String</a></li>
  30. </ul>
  31. <!-- end publish.classesIndex -->
  32. </div>
  33. <div class="fineprint" style="clear:both">
  34. Generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
  35. HTML template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a><br />
  36. <a href="http://decafmud.kicks-ass.net/">DecafMUD</a> &copy; 2010 Stendec
  37. </div>
  38. </div>
  39. <div class="content">
  40. <div class="innerContent">
  41. <h1 class="classTitle">
  42. Namespace <span>DecafMUD.plugins.Encoding.iso88591</span>
  43. </h1>
  44. <p class="description summary">
  45. DecafMUD Character Encoding: iso-8859-1
  46. <br /><em>Defined in: </em> <a href="../symbols/src/_mud_decafmud_src_js_decafmud.js.html">decafmud.js</a>.
  47. </p>
  48. <div class="props">
  49. <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class DecafMUD.plugins.Encoding.iso88591.">
  50. <caption>Namespace Summary</caption>
  51. <thead>
  52. <tr>
  53. <th scope="col">Constructor Attributes</th>
  54. <th scope="col">Constructor Name and Description</th>
  55. </tr>
  56. </thead>
  57. <tbody>
  58. <tr>
  59. <td class="attributes">&nbsp;</td>
  60. <td class="nameDescription" >
  61. <div class="fixedFont">
  62. <b><a href="../symbols/DecafMUD.plugins.Encoding.iso88591.html#constructor">DecafMUD.plugins.Encoding.iso88591</a></b>
  63. </div>
  64. <div class="description">This provides support for iso-8859-1 encoded data to DecafMUD, which isn't saying much as you realize that iso-8859-1 is simple, unencoded binary strings.</div>
  65. </td>
  66. </tr>
  67. </tbody>
  68. </table>
  69. </div>
  70. <!--
  71. #### METHODS SUMMARY
  72. -->
  73. <div class="props">
  74. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class DecafMUD.plugins.Encoding.iso88591.">
  75. <caption>Method Summary</caption>
  76. <thead>
  77. <tr>
  78. <th scope="col">Method Attributes</th>
  79. <th scope="col">Method Name and Description</th>
  80. </tr>
  81. </thead>
  82. <tbody>
  83. <tr>
  84. <td class="attributes">&lt;static&gt; &nbsp;</td>
  85. <td class="nameDescription">
  86. <div class="fixedFont">DecafMUD.plugins.Encoding.iso88591.<b><a href="../symbols/DecafMUD.plugins.Encoding.iso88591.html#s.decode">decode</a></b>(data)
  87. </div>
  88. <div class="description">Convert iso-8859-1 encoded text to unicode, by doing nothing.</div>
  89. </td>
  90. </tr>
  91. <tr>
  92. <td class="attributes">&lt;static&gt; &nbsp;</td>
  93. <td class="nameDescription">
  94. <div class="fixedFont">DecafMUD.plugins.Encoding.iso88591.<b><a href="../symbols/DecafMUD.plugins.Encoding.iso88591.html#s.encode">encode</a></b>(data)
  95. </div>
  96. <div class="description">Convert unicode characters to iso-8859-1 encoded text, by doing nothing.</div>
  97. </td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. </div>
  102. <!--
  103. #### EVENTS SUMMARY
  104. -->
  105. <!--
  106. #### CONSTRUCTOR DETAILS
  107. -->
  108. <div class="details props">
  109. <div class="innerProps">
  110. <a name="constructor"></a>
  111. <div class="sectionTitle">
  112. Namespace Detail
  113. </div>
  114. <div class="fixedFont">
  115. <b>DecafMUD.plugins.Encoding.iso88591</b>
  116. </div>
  117. <div class="description">
  118. This provides support for iso-8859-1 encoded data to DecafMUD, which isn't
  119. saying much as you realize that iso-8859-1 is simple, unencoded binary
  120. strings. We just have this so that the encoding system can work with a
  121. default encoder.
  122. </div>
  123. <pre class="brush: js; toolbar: false">alert(DecafMUD.plugins.Encoding.iso88591.decode("This is some text!"));</pre>
  124. </div>
  125. </div>
  126. <!--
  127. #### FIELD DETAILS
  128. -->
  129. <!--
  130. #### METHOD DETAILS
  131. -->
  132. <div class="details props">
  133. <div class="innerProps">
  134. <div class="sectionTitle">
  135. Method Detail
  136. </div>
  137. <a name="s.decode"></a>
  138. <div class="fixedFont heading">
  139. <span class='lighter'>
  140. &lt;static&gt;
  141. </span>
  142. <span class="light">DecafMUD.plugins.Encoding.iso88591.</span><b>decode</b>(data)
  143. </div>
  144. <div class="description">
  145. Convert iso-8859-1 encoded text to unicode, by doing nothing.
  146. </div>
  147. <pre class="brush: js; toolbar: false">DecafMUD.plugins.Encoding.iso88591.decode("\xE2\x96\x93");
  148. // Becomes: "\xE2\x96\x93"</pre>
  149. <dl class="detailList params">
  150. <dt class="heading">Parameters:</dt>
  151. <dt>
  152. <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>data</b>
  153. </dt>
  154. <dd>The text to decode.</dd>
  155. </dl>
  156. <div class="hr"></div>
  157. <a name="s.encode"></a>
  158. <div class="fixedFont heading">
  159. <span class='lighter'>
  160. &lt;static&gt;
  161. </span>
  162. <span class="light">DecafMUD.plugins.Encoding.iso88591.</span><b>encode</b>(data)
  163. </div>
  164. <div class="description">
  165. Convert unicode characters to iso-8859-1 encoded text, by doing
  166. nothing. Should probably add some sanity checks in later, but I
  167. don't really care for now.
  168. </div>
  169. <pre class="brush: js; toolbar: false">DecafMUD.plugins.Encoding.iso88591.encode("\xE2\x96\x93");
  170. // Becomes: "\xE2\x96\x93"</pre>
  171. <dl class="detailList params">
  172. <dt class="heading">Parameters:</dt>
  173. <dt>
  174. <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>data</b>
  175. </dt>
  176. <dd>The text to encode.</dd>
  177. </dl>
  178. </div>
  179. </div>
  180. <!--
  181. #### EVENT DETAILS
  182. -->
  183. </div>
  184. </div>
  185. <script type="text/javascript">SyntaxHighlighter.all()</script>
  186. </body>
  187. </html>