SloodlePluginBasePresenterSlide.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class SloodlePluginBasePresenterSlide</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <script src="../media/lib/classTree.js"></script>
  9. <script language="javascript" type="text/javascript">
  10. var imgPlus = new Image();
  11. var imgMinus = new Image();
  12. imgPlus.src = "../media/images/plus.png";
  13. imgMinus.src = "../media/images/minus.png";
  14. function showNode(Node){
  15. switch(navigator.family){
  16. case 'nn4':
  17. // Nav 4.x code fork...
  18. var oTable = document.layers["span" + Node];
  19. var oImg = document.layers["img" + Node];
  20. break;
  21. case 'ie4':
  22. // IE 4/5 code fork...
  23. var oTable = document.all["span" + Node];
  24. var oImg = document.all["img" + Node];
  25. break;
  26. case 'gecko':
  27. // Standards Compliant code fork...
  28. var oTable = document.getElementById("span" + Node);
  29. var oImg = document.getElementById("img" + Node);
  30. break;
  31. }
  32. oImg.src = imgMinus.src;
  33. oTable.style.display = "block";
  34. }
  35. function hideNode(Node){
  36. switch(navigator.family){
  37. case 'nn4':
  38. // Nav 4.x code fork...
  39. var oTable = document.layers["span" + Node];
  40. var oImg = document.layers["img" + Node];
  41. break;
  42. case 'ie4':
  43. // IE 4/5 code fork...
  44. var oTable = document.all["span" + Node];
  45. var oImg = document.all["img" + Node];
  46. break;
  47. case 'gecko':
  48. // Standards Compliant code fork...
  49. var oTable = document.getElementById("span" + Node);
  50. var oImg = document.getElementById("img" + Node);
  51. break;
  52. }
  53. oImg.src = imgPlus.src;
  54. oTable.style.display = "none";
  55. }
  56. function nodeIsVisible(Node){
  57. switch(navigator.family){
  58. case 'nn4':
  59. // Nav 4.x code fork...
  60. var oTable = document.layers["span" + Node];
  61. break;
  62. case 'ie4':
  63. // IE 4/5 code fork...
  64. var oTable = document.all["span" + Node];
  65. break;
  66. case 'gecko':
  67. // Standards Compliant code fork...
  68. var oTable = document.getElementById("span" + Node);
  69. break;
  70. }
  71. return (oTable && oTable.style.display == "block");
  72. }
  73. function toggleNodeVisibility(Node){
  74. if (nodeIsVisible(Node)){
  75. hideNode(Node);
  76. }else{
  77. showNode(Node);
  78. }
  79. }
  80. </script>
  81. </head>
  82. <body>
  83. <div class="page-body">
  84. <h2 class="class-name"><img src="../media/images/Class_logo.png"
  85. alt=" Class"
  86. title=" Class"
  87. style="vertical-align: middle"> SloodlePluginBasePresenterSlide</h2>
  88. <a name="sec-description"></a>
  89. <div class="info-box">
  90. <div class="info-box-title">Description</div>
  91. <div class="nav-bar">
  92. <span class="disabled">Description</span> |
  93. <a href="#sec-descendents">Descendents</a>
  94. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  95. </div>
  96. <div class="info-box-body">
  97. <!-- ========== Info from phpDoc block ========= -->
  98. <p class="short-description">Base class for plugins which provide slide types for the SLOODLE Presenter.</p>
  99. <p class="description"><p>Sub-classes should override the essential functions, in addition to those in the SloodlePluginBase class. The purpose of the plugin is to render slides for output to a browser or to SL.</p></p>
  100. <p class="notes">
  101. Located in <a class="field" href="_plugin---presenter---_base.php.html">/plugin/presenter/_base.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__pluginpresenter_base.php.html#a24">24</a></span>)
  102. </p>
  103. <pre><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a>
  104. |
  105. --SloodlePluginBasePresenterSlide</pre>
  106. </div>
  107. </div>
  108. <a name="sec-descendents"></a>
  109. <div class="info-box">
  110. <div class="info-box-title">Direct descendents</div>
  111. <div class="nav-bar">
  112. <a href="#sec-description">Description</a> |
  113. <span class="disabled">Descendents</span>
  114. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <table cellpadding="2" cellspacing="0" class="class-table">
  118. <tr>
  119. <th class="class-table-header">Class</th>
  120. <th class="class-table-header">Description</th>
  121. </tr>
  122. <tr>
  123. <td style="padding-right: 2em; white-space: nowrap">
  124. <img src="../media/images/Class.png"
  125. alt=" class"
  126. title=" class"
  127. style="vertical-align: center"/>
  128. <a href="../sloodle/SloodlePluginPresenterSlideImage.html">SloodlePluginPresenterSlideImage</a>
  129. </td>
  130. <td>
  131. Presenter plugin for showing image slides.
  132. </td>
  133. </tr>
  134. <tr>
  135. <td style="padding-right: 2em; white-space: nowrap">
  136. <img src="../media/images/Class.png"
  137. alt=" class"
  138. title=" class"
  139. style="vertical-align: center"/>
  140. <a href="../sloodle/SloodlePluginPresenterSlideVideo.html">SloodlePluginPresenterSlideVideo</a>
  141. </td>
  142. <td>
  143. Presenter plugin for showing video slides.
  144. </td>
  145. </tr>
  146. <tr>
  147. <td style="padding-right: 2em; white-space: nowrap">
  148. <img src="../media/images/Class.png"
  149. alt=" class"
  150. title=" class"
  151. style="vertical-align: center"/>
  152. <a href="../sloodle/SloodlePluginPresenterSlideWeb.html">SloodlePluginPresenterSlideWeb</a>
  153. </td>
  154. <td>
  155. Presenter plugin for showing web slides.
  156. </td>
  157. </tr>
  158. </table>
  159. </div>
  160. </div>
  161. <a name="sec-method-summary"></a>
  162. <div class="info-box">
  163. <div class="info-box-title">Method Summary</span></div>
  164. <div class="nav-bar">
  165. <a href="#sec-description">Description</a> |
  166. <a href="#sec-descendents">Descendants</a> |
  167. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  168. </div>
  169. <div class="info-box-body">
  170. <div class="method-summary">
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">string</span>
  174. <a href="#render_slide_for_browser" title="details" class="method-name">render_slide_for_browser</a>
  175. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">array</span>
  180. <a href="#render_slide_for_sl" title="details" class="method-name">render_slide_for_sl</a>
  181. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  182. </div>
  183. </div>
  184. </div>
  185. </div>
  186. <a name="sec-methods"></a>
  187. <div class="info-box">
  188. <div class="info-box-title">Methods</div>
  189. <div class="nav-bar">
  190. <a href="#sec-description">Description</a> |
  191. <a href="#sec-descendents">Descendents</a> |
  192. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  193. </div>
  194. <div class="info-box-body">
  195. <A NAME='method_detail'></A>
  196. <a name="methodrender_slide_for_browser" id="render_slide_for_browser"><!-- --></a>
  197. <div class="oddrow">
  198. <div class="method-header">
  199. <img src="../media/images/Method.png" />
  200. <span class="method-title">render_slide_for_browser</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenter_base.php.html#a39">39</a></span>)
  201. </div>
  202. <!-- ========== Info from phpDoc block ========= -->
  203. <p class="short-description">Render the given slide for browser output -- NOTE: render to a string, and return the string.</p>
  204. <p class="description"><p>The title of the slide need not be included -- simply the basic iFrame or embedded player etc.</p></p>
  205. <div class="method-signature">
  206. <span class="method-result">string</span>
  207. <span class="method-name">
  208. render_slide_for_browser
  209. </span>
  210. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  211. </div>
  212. <ul class="parameters">
  213. <li>
  214. <span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>
  215. <span class="var-name">$slide</span><span class="var-description">: An object containing the raw slide data.</span> </li>
  216. </ul>
  217. <hr class="separator" />
  218. <div class="notes">Redefined in descendants as:</div>
  219. <ul class="redefinitions">
  220. <li>
  221. <a href="../sloodle/SloodlePluginPresenterSlideImage.html#methodrender_slide_for_browser">SloodlePluginPresenterSlideImage::render_slide_for_browser()</a>
  222. : Render the given slide for browser output -- NOTE: render to a string, and return the string.
  223. </li>
  224. <li>
  225. <a href="../sloodle/SloodlePluginPresenterSlideVideo.html#methodrender_slide_for_browser">SloodlePluginPresenterSlideVideo::render_slide_for_browser()</a>
  226. : Render the given slide for browser output -- NOTE: render to a string, and return the string.
  227. </li>
  228. <li>
  229. <a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodrender_slide_for_browser">SloodlePluginPresenterSlideWeb::render_slide_for_browser()</a>
  230. : Render the given slide for browser output -- NOTE: render to a string, and return the string.
  231. </li>
  232. </ul>
  233. </div>
  234. <a name="methodrender_slide_for_sl" id="render_slide_for_sl"><!-- --></a>
  235. <div class="evenrow">
  236. <div class="method-header">
  237. <img src="../media/images/Method.png" />
  238. <span class="method-title">render_slide_for_sl</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenter_base.php.html#a54">54</a></span>)
  239. </div>
  240. <!-- ========== Info from phpDoc block ========= -->
  241. <p class="short-description">Render the given slide for virtual-world output.</p>
  242. <p class="description"><p>This returns two items of data in a numeric array. The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type). The second is the absolute URL to give it.</p></p>
  243. <ul class="tags">
  244. <li><span class="field">return:</span> Numeric array containg (type, url)</li>
  245. </ul>
  246. <div class="method-signature">
  247. <span class="method-result">array</span>
  248. <span class="method-name">
  249. render_slide_for_sl
  250. </span>
  251. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  252. </div>
  253. <ul class="parameters">
  254. <li>
  255. <span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>
  256. <span class="var-name">$slide</span><span class="var-description">: An object containing the raw slide data.</span> </li>
  257. </ul>
  258. <hr class="separator" />
  259. <div class="notes">Redefined in descendants as:</div>
  260. <ul class="redefinitions">
  261. <li>
  262. <a href="../sloodle/SloodlePluginPresenterSlideImage.html#methodrender_slide_for_sl">SloodlePluginPresenterSlideImage::render_slide_for_sl()</a>
  263. : Render the given slide for virtual-world output.
  264. </li>
  265. <li>
  266. <a href="../sloodle/SloodlePluginPresenterSlideVideo.html#methodrender_slide_for_sl">SloodlePluginPresenterSlideVideo::render_slide_for_sl()</a>
  267. : Render the given slide for virtual-world output.
  268. </li>
  269. <li>
  270. <a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodrender_slide_for_sl">SloodlePluginPresenterSlideWeb::render_slide_for_sl()</a>
  271. : Render the given slide for virtual-world output.
  272. </li>
  273. </ul>
  274. </div>
  275. <h4>Inherited Methods</h4>
  276. <a name='inherited_methods'><!-- --></a>
  277. <!-- =========== Summary =========== -->
  278. <p>Inherited From <span class="classname"><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a></span></p>
  279. <blockquote>
  280. <img src="../media/images/Method.png" alt=" "/>
  281. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_id">SloodlePluginBase::get_id()</a></span><br>
  282. <img src="../media/images/Method.png" alt=" "/>
  283. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_description">SloodlePluginBase::get_plugin_description()</a></span><br>
  284. <img src="../media/images/Method.png" alt=" "/>
  285. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_name">SloodlePluginBase::get_plugin_name()</a></span><br>
  286. <img src="../media/images/Method.png" alt=" "/>
  287. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_version">SloodlePluginBase::get_version()</a></span><br>
  288. </blockquote>
  289. </div>
  290. </div>
  291. <p class="notes" id="credit">
  292. Documentation generated on Fri, 17 Jul 2009 11:02:50 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  293. </p>
  294. </div></body>
  295. </html>