<html> <head> <title>Interface XTransitionFilter</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="XTransitionFilter-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">Methods' Summary</td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub">Methods' Details</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">animations</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 XTransitionFilter</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XTransitionFilter</strong> ┗ <a href="XAnimate.html">XAnimate</a> ┗ <a href="XAnimationNode.html">XAnimationNode</a> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XAnimate.html">XAnimate</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Interface for generic animation. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Base members <a href="XAnimate.html">XAnimate</a>::<a href="XAnimate.html#Values">Values</a>, <a href="XAnimate.html">XAnimate</a>::<a href="XAnimate.html#From">From</a>, <a href="XAnimate.html">XAnimate</a>::<a href="XAnimate.html#To">To</a> and <a href="XAnimate.html">XAnimate</a>::<a href="XAnimate.html#By">By</a> can be used with <code>double</code> values that set the transition progress the specific amount of time. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> <hr> <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="#Transition">Transition</a></td> <td class="imsum_right">This is the type or family of transition. <br>This attribute is required and must be one of the transition families listed in <b>TransitionType</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#Subtype">Subtype</a></td> <td class="imsum_right">This is the subtype of the transition. <br> This must be one of the transition subtypes appropriate for the specified <a href="#Type">Type</a> as listed in <b>TransitionSubType</b>. <b>TransitionSubType::DEFAULT</b> is the default. </td> </tr> <tr> <td class="imsum_left"><a href="#Mode">Mode</a></td> <td class="imsum_right">Indicates whether the transitionFilter's parent element will transition in or out. Legal values are <b>true</b> indicating that the parent media will become more visible as the transition progress increases and <b>false</b> indicating that the parent media will become less visible as the transition progress increases. The default value is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#Direction">Direction</a></td> <td class="imsum_right">This specifies the direction the transition will run. <br> The legal values are <b>true</b> for forward and <b>false</b> for reverse. The default value is <b>true</b>. Note that this does not impact the media being transitioned to, but only affects the geometry of the transition. Transitions which do not have a reverse interpretation should ignore the direction attribute and assume the default value of <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#FadeColor">FadeColor</a></td> <td class="imsum_right">If the value of the <a href="#Type">Type</a> attribute is <b>TransitionType::FADE</b> and the value of the <a href="#Subtype">Subtype</a> attribute is <b>TransitionSubType::FADETOCOLOR</b> or <b>TransitionSubType::FADEFROMCOLOR</b>, then this attribute specifies the starting or ending color of the fade. The default value is 0 (black). </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="Transition" class="membertitle">Transition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Transition</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the type or family of transition. <br>This attribute is required and must be one of the transition families listed in <b>TransitionType</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Subtype" class="membertitle">Subtype</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Subtype</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the subtype of the transition. <br> This must be one of the transition subtypes appropriate for the specified <a href="#Type">Type</a> as listed in <b>TransitionSubType</b>. <b>TransitionSubType::DEFAULT</b> is the default. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Mode" class="membertitle">Mode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Mode</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates whether the transitionFilter's parent element will transition in or out. Legal values are <b>true</b> indicating that the parent media will become more visible as the transition progress increases and <b>false</b> indicating that the parent media will become less visible as the transition progress increases. The default value is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Direction" class="membertitle">Direction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Direction</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This specifies the direction the transition will run. <br> The legal values are <b>true</b> for forward and <b>false</b> for reverse. The default value is <b>true</b>. Note that this does not impact the media being transitioned to, but only affects the geometry of the transition. Transitions which do not have a reverse interpretation should ignore the direction attribute and assume the default value of <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FadeColor" class="membertitle">FadeColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>FadeColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If the value of the <a href="#Type">Type</a> attribute is <b>TransitionType::FADE</b> and the value of the <a href="#Subtype">Subtype</a> attribute is <b>TransitionSubType::FADETOCOLOR</b> or <b>TransitionSubType::FADEFROMCOLOR</b>, then this attribute specifies the starting or ending color of the fade. The default value is 0 (black). </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>