| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!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">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>Docs For Class SloodlePluginBasePresenterImporter</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <script src="../media/lib/classTree.js"></script>
- <script language="javascript" type="text/javascript">
- var imgPlus = new Image();
- var imgMinus = new Image();
- imgPlus.src = "../media/images/plus.png";
- imgMinus.src = "../media/images/minus.png";
-
- function showNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgMinus.src;
- oTable.style.display = "block";
- }
-
- function hideNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgPlus.src;
- oTable.style.display = "none";
- }
-
- function nodeIsVisible(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- break;
- }
- return (oTable && oTable.style.display == "block");
- }
-
- function toggleNodeVisibility(Node){
- if (nodeIsVisible(Node)){
- hideNode(Node);
- }else{
- showNode(Node);
- }
- }
- </script>
- </head>
- <body>
- <div class="page-body">
- <h2 class="class-name"><img src="../media/images/Class_logo.png"
- alt=" Class"
- title=" Class"
- style="vertical-align: middle"> SloodlePluginBasePresenterImporter</h2>
- <a name="sec-description"></a>
- <div class="info-box">
- <div class="info-box-title">Description</div>
- <div class="nav-bar">
- <span class="disabled">Description</span> |
- <a href="#sec-descendents">Descendents</a>
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Base class for plugins which provide slide importers for the SLOODLE Presenter.</p>
- <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 take a specified file (locally), process it, and add slides to the Presentation at the given point.</p></p>
- <p class="notes">
- 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#a68">68</a></span>)
- </p>
-
-
- <pre><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a>
- |
- --SloodlePluginBasePresenterImporter</pre>
-
- </div>
- </div>
- <a name="sec-descendents"></a>
- <div class="info-box">
- <div class="info-box-title">Direct descendents</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Descendents</span>
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <table cellpadding="2" cellspacing="0" class="class-table">
- <tr>
- <th class="class-table-header">Class</th>
- <th class="class-table-header">Description</th>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodlePluginPresenterPDFImporter.html">SloodlePluginPresenterPDFImporter</a>
- </td>
- <td>
- Presenter plugin for importing a PDF file as a series of image slides.
- </td>
- </tr>
- </table>
- </div>
- </div>
- <a name="sec-method-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Method Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-descendents">Descendants</a> |
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
- </div>
- <div class="info-box-body">
- <div class="method-summary">
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">bool</span>
- <a href="#import" title="details" class="method-name">import</a>
- (<span class="var-type">string</span> <span class="var-name">$file</span>, [<span class="var-type">int</span> <span class="var-name">$position</span> = <span class="var-default">-1</span>])
- </div>
- </div>
- </div>
- </div>
-
- <a name="sec-methods"></a>
- <div class="info-box">
- <div class="info-box-title">Methods</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-descendents">Descendents</a> |
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
-
- </div>
- <div class="info-box-body">
- <A NAME='method_detail'></A>
- <a name="methodimport" id="import"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">import</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenter_base.php.html#a85">85</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Import the given file, and insert the new slides at the specified position in the Presentation.</p>
- <p class="description"><p>The best approach to inserting slides is to insert the first one at the specified position, and then increment the position on each insertion. Inserting at the same point repeatedly will cause the slides to appear in reverse order! :-)</p></p>
- <ul class="tags">
- <li><span class="field">return:</span> True if successful, or false otherwise.</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">bool</span>
- <span class="method-name">
- import
- </span>
- (<span class="var-type">string</span> <span class="var-name">$file</span>, [<span class="var-type">int</span> <span class="var-name">$position</span> = <span class="var-default">-1</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$file</span><span class="var-description">: The path of the file to import.</span> </li>
- <li>
- <span class="var-type">int</span>
- <span class="var-name">$position</span><span class="var-description">: Position at which the first new slide should be imported. (If negative, then insert at end)</span> </li>
- </ul>
-
-
- </div>
- <h4>Inherited Methods</h4>
- <a name='inherited_methods'><!-- --></a>
- <!-- =========== Summary =========== -->
- <p>Inherited From <span class="classname"><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a></span></p>
- <blockquote>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_id">SloodlePluginBase::get_id()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_description">SloodlePluginBase::get_plugin_description()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_name">SloodlePluginBase::get_plugin_name()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_version">SloodlePluginBase::get_version()</a></span><br>
- </blockquote>
-
- </div>
- </div>
-
- <p class="notes" id="credit">
- Documentation generated on Fri, 17 Jul 2009 11:02:49 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </div></body>
- </html>
|