<html> <head> <title>Service Shape</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="Shape-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/Animations_and_Interactions" class="navimain">Devguide</a></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">Included Services</td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' 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">service Shape</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>this service is supported from all shapes inside a <a href="PresentationDocument.html">PresentationDocument</a>. This usually enahnces objects of type ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a> with presentation properties. </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/Animations_and_Interactions">Drawings - Animations and Interactions</a></dd> </dl> </td> </tr> </table> <hr> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Bookmark">Bookmark</a></td> <td class="imsum_right">is a generic URL for the property OnClick. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#DimColor">DimColor</a></td> <td class="imsum_right">This is the color for dimming this shape. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#DimHide">DimHide</a></td> <td class="imsum_right">If this property and the property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#DimPrev">DimPrev</a> are both <b>true</b>, the shape is hidden instead of dimmed to a color. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#DimPrevious">DimPrevious</a></td> <td class="imsum_right">If this property is <b>true</b>, this shape is dimmed to the color of property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#DimColor">DimColor</a> after executing its animation effect. </td> </tr> <tr> <td class="imsum_left"><a href="AnimationEffect.html">AnimationEffect</a><br> <a href="#Effect">Effect</a></td> <td class="imsum_right">selects the animation effect of this shape. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsEmptyPresentationObject">IsEmptyPresentationObject</a></td> <td class="imsum_right">If this is a default presentation object and if it is empty, this property is <b>true</b>. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsPresentationObject">IsPresentationObject</a></td> <td class="imsum_right">If this is a presentation object, this property is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="ClickAction.html">ClickAction</a><br> <a href="#OnClick">OnClick</a></td> <td class="imsum_right">selects an action performed after the user clicks on this shape. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#PlayFull">PlayFull</a></td> <td class="imsum_right">If this property is <b>true</b>, the sound of this shape is played in full. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#PresentationOrder">PresentationOrder</a></td> <td class="imsum_right">This is the position of this shape in the order of the shapes which can be animated on its page. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Sound">Sound</a></td> <td class="imsum_right">This is the URL to a soundfile that is played while the animation effect of this shape is running. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SoundOn">SoundOn</a></td> <td class="imsum_right">If this property is set to <b>true</b>, a sound is played while the animation effect is executed. </td> </tr> <tr> <td class="imsum_left"><a href="AnimationSpeed.html">AnimationSpeed</a><br> <a href="#Speed">Speed</a></td> <td class="imsum_right">This is the speed of the animation effect. </td> </tr> <tr> <td class="imsum_left"><a href="AnimationEffect.html">AnimationEffect</a><br> <a href="#TextEffect">TextEffect</a></td> <td class="imsum_right">This is the animation effect for the text inside this shape. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#Verb">Verb</a></td> <td class="imsum_right">specifies an "ole2" verb for the ClickAction VERB in the property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#OnClick">OnClick</a>. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Bookmark" class="membertitle">Bookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Bookmark</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is a generic URL for the property OnClick. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DimColor" class="membertitle">DimColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>DimColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the color for dimming this shape. </dd> <dd><p>This color is used if the property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#DimPrev">DimPrev</a> is <b>true</b> and ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#DimHide">DimHide</a> is <b>false</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DimHide" class="membertitle">DimHide</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>DimHide</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this property and the property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#DimPrev">DimPrev</a> are both <b>true</b>, the shape is hidden instead of dimmed to a color. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DimPrevious" class="membertitle">DimPrevious</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>DimPrevious</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this property is <b>true</b>, this shape is dimmed to the color of property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#DimColor">DimColor</a> after executing its animation effect. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Effect" class="membertitle">Effect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="AnimationEffect.html">AnimationEffect</a> <b>Effect</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>selects the animation effect of this shape. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsEmptyPresentationObject" class="membertitle">IsEmptyPresentationObject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsEmptyPresentationObject</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this is a default presentation object and if it is empty, this property is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsPresentationObject" class="membertitle">IsPresentationObject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsPresentationObject</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this is a presentation object, this property is <b>true</b>. </dd> <dd><p>Presentation objects are objects like TitleTextShape and OutlinerShape.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OnClick" class="membertitle">OnClick</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="ClickAction.html">ClickAction</a> <b>OnClick</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>selects an action performed after the user clicks on this shape. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PlayFull" class="membertitle">PlayFull</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>PlayFull</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this property is <b>true</b>, the sound of this shape is played in full. </dd> <dd><p>The default behavior is to stop the sound after completing the animation effect.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PresentationOrder" class="membertitle">PresentationOrder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>PresentationOrder</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the position of this shape in the order of the shapes which can be animated on its page. </dd> <dd><p>The animations are executed in this order, starting at the shape with the PresentationOrder "one." You can change the order by changing this number. Setting it to "one" makes this shape the first shape in the execution order for the animation effects.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Sound" class="membertitle">Sound</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Sound</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the URL to a soundfile that is played while the animation effect of this shape is running. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SoundOn" class="membertitle">SoundOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SoundOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this property is set to <b>true</b>, a sound is played while the animation effect is executed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Speed" class="membertitle">Speed</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="AnimationSpeed.html">AnimationSpeed</a> <b>Speed</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the speed of the animation effect. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextEffect" class="membertitle">TextEffect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="AnimationEffect.html">AnimationEffect</a> <b>TextEffect</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the animation effect for the text inside this shape. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Verb" class="membertitle">Verb</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Verb</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies an "ole2" verb for the ClickAction VERB in the property ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>::<a href="../drawing/Shape.html#OnClick">OnClick</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4408
