SloodlePresenterSlide.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  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 SloodlePresenterSlide</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"> SloodlePresenterSlide</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-var-summary">Vars</a> (<a href="#sec-vars">details</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">Defines a single slide from a presentation, containing raw data.</p>
  99. <p class="description"><p>The data will usually need to interpreted by a slide plugin.</p></p>
  100. <p class="notes">
  101. Located in <a class="field" href="_lib---modules---module_presenter.php.html">/lib/modules/module_presenter.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a402">402</a></span>)
  102. </p>
  103. <pre></pre>
  104. </div>
  105. </div>
  106. <a name="sec-var-summary"></a>
  107. <div class="info-box">
  108. <div class="info-box-title">Variable Summary</span></div>
  109. <div class="nav-bar">
  110. <a href="#sec-description">Description</a> |
  111. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  112. |
  113. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  114. </div>
  115. <div class="info-box-body">
  116. <div class="var-summary">
  117. <div class="var-title">
  118. <img src="../media/images/Variable.png" alt=" " />
  119. <span class="var-type">int</span>
  120. <a href="#$id" title="details" class="var-name">$id</a>
  121. </div>
  122. <div class="var-title">
  123. <img src="../media/images/Variable.png" alt=" " />
  124. <span class="var-type">string</span>
  125. <a href="#$name" title="details" class="var-name">$name</a>
  126. </div>
  127. <div class="var-title">
  128. <img src="../media/images/Variable.png" alt=" " />
  129. <span class="var-type">integer</span>
  130. <a href="#$ordering" title="details" class="var-name">$ordering</a>
  131. </div>
  132. <div class="var-title">
  133. <img src="../media/images/Variable.png" alt=" " />
  134. <span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
  135. <a href="#$presenter" title="details" class="var-name">$presenter</a>
  136. </div>
  137. <div class="var-title">
  138. <img src="../media/images/Variable.png" alt=" " />
  139. <span class="var-type">integer</span>
  140. <a href="#$slideposition" title="details" class="var-name">$slideposition</a>
  141. </div>
  142. <div class="var-title">
  143. <img src="../media/images/Variable.png" alt=" " />
  144. <span class="var-type">string</span>
  145. <a href="#$source" title="details" class="var-name">$source</a>
  146. </div>
  147. <div class="var-title">
  148. <img src="../media/images/Variable.png" alt=" " />
  149. <span class="var-type">string</span>
  150. <a href="#$type" title="details" class="var-name">$type</a>
  151. </div>
  152. </div>
  153. </div>
  154. </div>
  155. <a name="sec-method-summary"></a>
  156. <div class="info-box">
  157. <div class="info-box-title">Method Summary</span></div>
  158. <div class="nav-bar">
  159. <a href="#sec-description">Description</a> |
  160. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  161. |
  162. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  163. </div>
  164. <div class="info-box-body">
  165. <div class="method-summary">
  166. <div class="method-definition">
  167. <img src="../media/images/Constructor.png" alt=" "/>
  168. <span class="method-result">SloodlePresenterSlide</span>
  169. <a href="#SloodlePresenterSlide" title="details" class="method-name">SloodlePresenterSlide</a>
  170. ([<span class="var-type"></span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$presenter</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$source</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$ordering</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$slideposition</span> = <span class="var-default">0</span>])
  171. </div>
  172. </div>
  173. </div>
  174. </div>
  175. <a name="sec-vars"></a>
  176. <div class="info-box">
  177. <div class="info-box-title">Variables</div>
  178. <div class="nav-bar">
  179. <a href="#sec-description">Description</a> |
  180. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  181. |
  182. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  183. </div>
  184. <div class="info-box-body">
  185. <a name="var$id" id="$id"><!-- --></A>
  186. <div class="oddrow">
  187. <div class="var-header">
  188. <img src="../media/images/Variable.png" />
  189. <span class="var-title">
  190. <span class="var-type">int</span>
  191. <span class="var-name">$id</span>
  192. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a425">425</a></span>)
  193. </span>
  194. </div>
  195. <!-- ========== Info from phpDoc block ========= -->
  196. <p class="short-description">The ID of this slide in the DB table of slides.</p>
  197. <ul class="tags">
  198. <li><span class="field">access:</span> public</li>
  199. </ul>
  200. </div>
  201. <a name="var$name" id="$name"><!-- --></A>
  202. <div class="evenrow">
  203. <div class="var-header">
  204. <img src="../media/images/Variable.png" />
  205. <span class="var-title">
  206. <span class="var-type">string</span>
  207. <span class="var-name">$name</span>
  208. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a439">439</a></span>)
  209. </span>
  210. </div>
  211. <!-- ========== Info from phpDoc block ========= -->
  212. <p class="short-description">The name of this slide</p>
  213. <ul class="tags">
  214. <li><span class="field">access:</span> public</li>
  215. </ul>
  216. </div>
  217. <a name="var$ordering" id="$ordering"><!-- --></A>
  218. <div class="oddrow">
  219. <div class="var-header">
  220. <img src="../media/images/Variable.png" />
  221. <span class="var-title">
  222. <span class="var-type">integer</span>
  223. <span class="var-name">$ordering</span>
  224. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a462">462</a></span>)
  225. </span>
  226. </div>
  227. <!-- ========== Info from phpDoc block ========= -->
  228. <p class="short-description">The ordering value for this slide. This should not generally be used. Refer to 'slideposition' instead.</p>
  229. <ul class="tags">
  230. <li><span class="field">access:</span> public</li>
  231. </ul>
  232. </div>
  233. <a name="var$presenter" id="$presenter"><!-- --></A>
  234. <div class="evenrow">
  235. <div class="var-header">
  236. <img src="../media/images/Variable.png" />
  237. <span class="var-title">
  238. <span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
  239. <span class="var-name">$presenter</span>
  240. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a432">432</a></span>)
  241. </span>
  242. </div>
  243. <!-- ========== Info from phpDoc block ========= -->
  244. <p class="short-description">The SloodleModulePresenter object relating the presentation this slide is in</p>
  245. <ul class="tags">
  246. <li><span class="field">access:</span> public</li>
  247. </ul>
  248. </div>
  249. <a name="var$slideposition" id="$slideposition"><!-- --></A>
  250. <div class="oddrow">
  251. <div class="var-header">
  252. <img src="../media/images/Variable.png" />
  253. <span class="var-title">
  254. <span class="var-type">integer</span>
  255. <span class="var-name">$slideposition</span>
  256. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a469">469</a></span>)
  257. </span>
  258. </div>
  259. <!-- ========== Info from phpDoc block ========= -->
  260. <p class="short-description">The position of this slide in the presentation. This is a 1-based count.</p>
  261. <ul class="tags">
  262. <li><span class="field">access:</span> public</li>
  263. </ul>
  264. </div>
  265. <a name="var$source" id="$source"><!-- --></A>
  266. <div class="evenrow">
  267. <div class="var-header">
  268. <img src="../media/images/Variable.png" />
  269. <span class="var-title">
  270. <span class="var-type">string</span>
  271. <span class="var-name">$source</span>
  272. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a448">448</a></span>)
  273. </span>
  274. </div>
  275. <!-- ========== Info from phpDoc block ========= -->
  276. <p class="short-description">The source data for this slide. Normally this would be an absolute url (starting with a protocol specifier like HTTP), or a relative path, in which case it is treated as an internal Moodle file.</p>
  277. <p class="description"><p>Plugins may alternatively use this to store data which is to be rendered.</p></p>
  278. <ul class="tags">
  279. <li><span class="field">access:</span> public</li>
  280. </ul>
  281. </div>
  282. <a name="var$type" id="$type"><!-- --></A>
  283. <div class="oddrow">
  284. <div class="var-header">
  285. <img src="../media/images/Variable.png" />
  286. <span class="var-title">
  287. <span class="var-type">string</span>
  288. <span class="var-name">$type</span>
  289. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a455">455</a></span>)
  290. </span>
  291. </div>
  292. <!-- ========== Info from phpDoc block ========= -->
  293. <p class="short-description">The type of this slide. This will be the ID of a plugin, or it may be a legacy type, 'web', 'image', or 'video'.</p>
  294. <ul class="tags">
  295. <li><span class="field">access:</span> public</li>
  296. </ul>
  297. </div>
  298. </div>
  299. </div>
  300. <a name="sec-methods"></a>
  301. <div class="info-box">
  302. <div class="info-box-title">Methods</div>
  303. <div class="nav-bar">
  304. <a href="#sec-description">Description</a> |
  305. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  306. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  307. </div>
  308. <div class="info-box-body">
  309. <A NAME='method_detail'></A>
  310. <a name="methodSloodlePresenterSlide" id="SloodlePresenterSlide"><!-- --></a>
  311. <div class="evenrow">
  312. <div class="method-header">
  313. <img src="../media/images/Constructor.png" />
  314. <span class="method-title">Constructor SloodlePresenterSlide</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a407">407</a></span>)
  315. </div>
  316. <!-- ========== Info from phpDoc block ========= -->
  317. <div class="method-signature">
  318. <span class="method-result">SloodlePresenterSlide</span>
  319. <span class="method-name">
  320. SloodlePresenterSlide
  321. </span>
  322. ([<span class="var-type"></span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$presenter</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$source</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$ordering</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$slideposition</span> = <span class="var-default">0</span>])
  323. </div>
  324. <ul class="parameters">
  325. <li>
  326. <span class="var-type"></span>
  327. <span class="var-name">$id</span> </li>
  328. <li>
  329. <span class="var-type"></span>
  330. <span class="var-name">$presenter</span> </li>
  331. <li>
  332. <span class="var-type"></span>
  333. <span class="var-name">$name</span> </li>
  334. <li>
  335. <span class="var-type"></span>
  336. <span class="var-name">$source</span> </li>
  337. <li>
  338. <span class="var-type"></span>
  339. <span class="var-name">$type</span> </li>
  340. <li>
  341. <span class="var-type"></span>
  342. <span class="var-name">$ordering</span> </li>
  343. <li>
  344. <span class="var-type"></span>
  345. <span class="var-name">$slideposition</span> </li>
  346. </ul>
  347. </div>
  348. </div>
  349. </div>
  350. <p class="notes" id="credit">
  351. Documentation generated on Fri, 17 Jul 2009 11:02:06 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  352. </p>
  353. </div></body>
  354. </html>