Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 4551

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XSlideShowController</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XSlideShowController-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">presentation</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XSlideShowController</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>interface to control a running slideshow.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</dd>
<dt><b>See also</b></dt>
<dd><a href="XPresentation2.html">XPresentation2</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isRunning">isRunning</a></td>
<td class="imsum_right">returns true if the slideshow is still running.
 If this returns false, this component is already disposed.
 You can start a new slideshow and get a new instance
 of <a href="XSlideShowController.html">XSlideShowController</a> from <a href="XPresentation2.html">XPresentation2</a>
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSlideCount">getSlideCount</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSlideByIndex">getSlideByIndex</a></td>
<td class="imsum_right">gives access to the slides that will be shown in this slideshow.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addSlideShowListener">addSlideShowListener</a></td>
<td class="imsum_right">addes a listener that recieves events while the slideshow is running. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeSlideShowListener">removeSlideShowListener</a></td>
<td class="imsum_right">removes a listener. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoNextEffect">gotoNextEffect</a></td>
<td class="imsum_right">start next effects that wait on a generic trigger.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoPreviousEffect">gotoPreviousEffect</a></td>
<td class="imsum_right">undo the last effects that where triggered by a generic trigger.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoFirstSlide">gotoFirstSlide</a></td>
<td class="imsum_right">goto and display first slide &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoNextSlide">gotoNextSlide</a></td>
<td class="imsum_right">goto and display next slide.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoPreviousSlide">gotoPreviousSlide</a></td>
<td class="imsum_right">goto and display previous slide.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoLastSlide">gotoLastSlide</a></td>
<td class="imsum_right">goto and display last slide.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoBookmark">gotoBookmark</a></td>
<td class="imsum_right">goto the given textual bookmark &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoSlide">gotoSlide</a></td>
<td class="imsum_right">jumps to the given slide.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#gotoSlideIndex">gotoSlideIndex</a></td>
<td class="imsum_right">jumps to the slide at the given index.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#stopSound">stopSound</a></td>
<td class="imsum_right">stop all currently played sounds &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#pause">pause</a></td>
<td class="imsum_right">pauses the slideshow. All effects are paused.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#resume">resume</a></td>
<td class="imsum_right">resumes a paused slideshow.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isPaused">isPaused</a></td>
<td class="imsum_right">returns <b>true</b> if the slideshow is currently paused.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#blankScreen">blankScreen</a></td>
<td class="imsum_right">pauses the slideshow and blanks the screen in the given color.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#activate">activate</a></td>
<td class="imsum_right">activates the user interface of this slideshow.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#deactivate">deactivate</a></td>
<td class="imsum_right">can be called to deactivate the user interface of this slideshow.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isActive">isActive</a></td>
<td class="imsum_right">determines if the slideshow is active.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCurrentSlide">getCurrentSlide</a></td>
<td class="imsum_right">returns slide that is currently displayed &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCurrentSlideIndex">getCurrentSlideIndex</a></td>
<td class="imsum_right">returns the index of the current slide. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getNextSlideIndex">getNextSlideIndex</a></td>
<td class="imsum_right">the index for the slide that is displayed next. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isEndless">isEndless</a></td>
<td class="imsum_right">returns <b>true</b> if the slideshow was started to run endlessly.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isFullScreen">isFullScreen</a></td>
<td class="imsum_right">Returns <b>true</b> if the slideshow was started in full-screen mode.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSlideShow">getSlideShow</a></td>
<td class="imsum_right">returns the actuall <a href="XSlideShow.html">XSlideShow</a> instance that runs the
 slideshow.
 <br>Normaly all navigation should be done using this controller and
 not the <a href="XSlideShow.html">XSlideShow</a> itself. &nbsp;</td>
</tr>
</table>
<a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Attributes' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#AlwaysOnTop">AlwaysOnTop</a></td>
<td class="imsum_right">If this attribute is set to <b>true</b>, the window of the slideshow is 
 always on top of all other windows.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#MouseVisible">MouseVisible</a></td>
<td class="imsum_right">If this attribute is <b>true</b>, the mouse is visible during the
 slideshow.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#UsePen">UsePen</a></td>
<td class="imsum_right">If this is <b>true</b>, a pen is shown during presentation.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#PenColor">PenColor</a></td>
<td class="imsum_right">This attribute changes the color of the pen. &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="isRunning" class="membertitle">isRunning</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isRunning</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns true if the slideshow is still running.
 If this returns false, this component is already disposed.
 You can start a new slideshow and get a new instance
 of <a href="XSlideShowController.html">XSlideShowController</a> from <a href="XPresentation2.html">XPresentation2</a>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSlideCount" class="membertitle">getSlideCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getSlideCount</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the number of slides in this slideshow.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#getSlideByIndex">getSlideByIndex</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSlideByIndex" class="membertitle">getSlideByIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XDrawPage.html">XDrawPage</a></td>
</tr>
<tr>
<td valign="top"><b>getSlideByIndex</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Index )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gives access to the slides that will be shown in this slideshow.
 
 </dd>
<dd><p>Slides are returned in the order they will be displayed in the
 presentation which can be different than the orders of slides in
 the document. Not all slides must be present and each slide can
 be used more than once.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>the slide at the specified index.
 
 </dd>
<dt><b>Parameter Index</b></dt>
<dd>specifies the position in the list of slides that are displayed
 in this slideshow. The first index is 0. 
 
 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IndexOutOfBoundException 
 if the index is not valid. 
 
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addSlideShowListener" class="membertitle">addSlideShowListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>addSlideShowListener</b>(</td>
<td valign="top">[in] <a href="XSlideShowListener.html">XSlideShowListener</a></td>
<td valign="bottom">&nbsp;Listener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>addes a listener that recieves events while the slideshow is running. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeSlideShowListener" class="membertitle">removeSlideShowListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>removeSlideShowListener</b>(</td>
<td valign="top">[in] <a href="XSlideShowListener.html">XSlideShowListener</a></td>
<td valign="bottom">&nbsp;Listener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes a listener. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoNextEffect" class="membertitle">gotoNextEffect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoNextEffect</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>start next effects that wait on a generic trigger.
 </dd>
<dd><p>If no generic triggers are waiting the next
 slide will be displayed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoPreviousEffect" class="membertitle">gotoPreviousEffect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoPreviousEffect</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>undo the last effects that where triggered by a generic trigger.
 </dd>
<dd><p>If there is no previous effect that can be undone then the
 previous slide will be displayed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoFirstSlide" class="membertitle">gotoFirstSlide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoFirstSlide</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>goto and display first slide </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoNextSlide" class="membertitle">gotoNextSlide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoNextSlide</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>goto and display next slide.
 </dd>
<dd><p>Remaining effects on the current slide will be skiped.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoPreviousSlide" class="membertitle">gotoPreviousSlide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoPreviousSlide</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>goto and display previous slide.
 </dd>
<dd><p>Remaining effects on the current slide will be skiped.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoLastSlide" class="membertitle">gotoLastSlide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoLastSlide</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>goto and display last slide.
 </dd>
<dd><p>Remaining effects on the current slide will be skiped.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoBookmark" class="membertitle">gotoBookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoBookmark</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Bookmark );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>goto the given textual bookmark </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoSlide" class="membertitle">gotoSlide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoSlide</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XDrawPage.html">XDrawPage</a></td>
<td valign="bottom">&nbsp;Page )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>jumps to the given slide.
 </dd>
<dd><p>The slide can also be a slide that would normaly not be shown during
 the current slideshow.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the given page is not a valid slide of the document for
 which this slideshow is started. Also not allowed are master,
 notes and handout pages.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="gotoSlideIndex" class="membertitle">gotoSlideIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>gotoSlideIndex</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Index );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>jumps to the slide at the given index.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="stopSound" class="membertitle">stopSound</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>stopSound</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>stop all currently played sounds </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="pause" class="membertitle">pause</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>pause</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>pauses the slideshow. All effects are paused.
 </dd>
<dd><p>The slideshow continues on next user input or if
 <a href="#resume">resume</a> is called.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="resume" class="membertitle">resume</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>resume</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>resumes a paused slideshow.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isPaused" class="membertitle">isPaused</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isPaused</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b> if the slideshow is currently paused.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#pause">pause</a>, <a href="#resume">resume</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="blankScreen" class="membertitle">blankScreen</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>blankScreen</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Color );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>pauses the slideshow and blanks the screen in the given color.
 </dd>
<dd><p>Change attribute <a href="#Pause">Pause</a> to false to unpause
 the slideshow.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="activate" class="membertitle">activate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>activate</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>activates the user interface of this slideshow.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#deactivate()">deactivate()</a>, <a href="#isActive()">isActive()</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="deactivate" class="membertitle">deactivate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>deactivate</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>can be called to deactivate the user interface of this slideshow.

 </dd>
<dd><p>A deactivated 
 </dd>
<dt><b>See also</b></dt>
<dd><a href="#activate()">activate()</a>, <a href="#isActive()">isActive()</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isActive" class="membertitle">isActive</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isActive</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines if the slideshow is active.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> for UI active slideshow
 <br>
 <b>false</b> otherwise
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getCurrentSlide" class="membertitle">getCurrentSlide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XDrawPage.html">XDrawPage</a></td>
</tr>
<tr>
<td valign="top"><b>getCurrentSlide</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns slide that is currently displayed </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getCurrentSlideIndex" class="membertitle">getCurrentSlideIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getCurrentSlideIndex</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the index of the current slide. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getNextSlideIndex" class="membertitle">getNextSlideIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getNextSlideIndex</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the index for the slide that is displayed next. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isEndless" class="membertitle">isEndless</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isEndless</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b> if the slideshow was started to run endlessly.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isFullScreen" class="membertitle">isFullScreen</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isFullScreen</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns <b>true</b> if the slideshow was started in full-screen mode.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSlideShow" class="membertitle">getSlideShow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XSlideShow.html">XSlideShow</a></td>
</tr>
<tr>
<td valign="top"><b>getSlideShow</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the actuall <a href="XSlideShow.html">XSlideShow</a> instance that runs the
 slideshow.
 <br>Normaly all navigation should be done using this controller and
 not the <a href="XSlideShow.html">XSlideShow</a> itself. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Attributes' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="AlwaysOnTop" class="membertitle">AlwaysOnTop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AlwaysOnTop</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If this attribute is set to <b>true</b>, the window of the slideshow is 
 always on top of all other windows.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="MouseVisible" class="membertitle">MouseVisible</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>MouseVisible</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If this attribute is <b>true</b>, the mouse is visible during the
 slideshow.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="UsePen" class="membertitle">UsePen</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>UsePen</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If this is <b>true</b>, a pen is shown during presentation.

 </dd>
<dd><p>You can draw on the presentation with this pen.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PenColor" class="membertitle">PenColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>PenColor</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This attribute changes the color of the pen. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>