<html> <head> <title>Interface XEmbeddedObject</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="XEmbeddedObject-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="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</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">embed</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 XEmbeddedObject</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XEmbeddedObject</strong> ┣ <a href="XVisualObject.html">XVisualObject</a> ┣ <a href="XClassifiedObject.html">XClassifiedObject</a> ┣ <a href="XComponentSupplier.html">XComponentSupplier</a> ┣ <a href="XStateChangeBroadcaster.html">XStateChangeBroadcaster</a> ┣ ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a> ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a> ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseBroadcaster.html">XCloseBroadcaster</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XVisualObject.html">XVisualObject</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>represents common visualisation functionality for embedded objects. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XClassifiedObject.html">XClassifiedObject</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to detect class ID of the object. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XComponentSupplier.html">XComponentSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to get access to the component handled by the object. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XStateChangeBroadcaster.html">XStateChangeBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to be notified when object changes the state. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to be notified about object related events. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to control lifetime of the object. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents common functionality for embedded objects. </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="#changeState">changeState</a></td> <td class="imsum_right">changes the state of the object to the requested one. </td> </tr> <tr> <td class="imsum_left"><a href="#getReachableStates">getReachableStates</a></td> <td class="imsum_right">returns supported states for the object. </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentState">getCurrentState</a></td> <td class="imsum_right">returns the current state of the object. </td> </tr> <tr> <td class="imsum_left"><a href="#doVerb">doVerb</a></td> <td class="imsum_right">lets object perform an action referenced by nVerbID. </td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedVerbs">getSupportedVerbs</a></td> <td class="imsum_right">returns supported verbs for the object. </td> </tr> <tr> <td class="imsum_left"><a href="#setClientSite">setClientSite</a></td> <td class="imsum_right">sets a connection to the container's client. </td> </tr> <tr> <td class="imsum_left"><a href="#getClientSite">getClientSite</a></td> <td class="imsum_right">provides access to the internal link to the container client. </td> </tr> <tr> <td class="imsum_left"><a href="#update">update</a></td> <td class="imsum_right">updates object's representations. </td> </tr> <tr> <td class="imsum_left"><a href="#setUpdateMode">setUpdateMode</a></td> <td class="imsum_right">specifies how often the object's representation should be updated. </td> </tr> <tr> <td class="imsum_left"><a href="#getStatus">getStatus</a></td> <td class="imsum_right">retrieves the status of the object. </td> </tr> <tr> <td class="imsum_left"><a href="#setContainerName">setContainerName</a></td> <td class="imsum_right">provides object with the name of container document. </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="changeState" class="membertitle">changeState</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>changeState</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nNewState )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnreachableStateException.html">UnreachableStateException</a>,<br> <a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>changes the state of the object to the requested one. </dd> <dt><b>Parameter nNewState</b></dt> <dd>specifies the new state, can take values from the constant set <a href="EmbedStates.html">EmbedStates</a> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::UnreachableStateException the specified state can not be reached </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException in case object is in invalid state </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in case of other problems </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getReachableStates" class="membertitle">getReachableStates</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">sequence< long ></td> </tr> <tr> <td valign="top"><b>getReachableStates</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="NeedsRunningStateException.html">NeedsRunningStateException</a>,<br> <a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns supported states for the object. </dd> <dt><b>Returns</b></dt> <dd>the sequence of states the object can be set to </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::NeedsRunnignStateException means that the object is in loaded state now and can be switched to running state, other possible states can be detected only when the object is not in loaded state any more </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException in case object is in invalid state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentState" class="membertitle">getCurrentState</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>getCurrentState</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the current state of the object. </dd> <dt><b>Returns</b></dt> <dd>the current state of the object </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException in case object is in invalid state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="doVerb" class="membertitle">doVerb</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>doVerb</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nVerbID )</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>,<br> <a href="WrongStateException.html">WrongStateException</a>,<br> <a href="UnreachableStateException.html">UnreachableStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>lets object perform an action referenced by nVerbID. </dd> <dt><b>Parameter nVerbID</b></dt> <dd>specifies an action to perform, can take values from <a href="EmbedVerbs.html">EmbedVerbs</a> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException the verb is not supported </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state to call the function </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::UnreachableStateException the state, required by the verb, can not be reached </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in case of other problems </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSupportedVerbs" class="membertitle">getSupportedVerbs</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">sequence< <a href="VerbDescriptor.html">VerbDescriptor</a> ></td> </tr> <tr> <td valign="top"><b>getSupportedVerbs</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="NeedsRunningStateException.html">NeedsRunningStateException</a>,<br> <a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns supported verbs for the object. </dd> <dt><b>Returns</b></dt> <dd>the sequence of verbs the object supports </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::NeedsRunnignStateException means that the object is in loaded state now and can be switched to running state, acceptable verbs can be detected only when the object is not in loaded state any more </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state to call the function </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setClientSite" class="membertitle">setClientSite</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>setClientSite</b>(</td> <td valign="top">[in] <a href="XEmbeddedClient.html">XEmbeddedClient</a></td> <td valign="bottom"> xClient )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a connection to the container's client. </dd> <dt><b>Parameter xClient</b></dt> <dd>provides a reference to a client implementation </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getClientSite" class="membertitle">getClientSite</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="XEmbeddedClient.html">XEmbeddedClient</a></td> </tr> <tr> <td valign="top"><b>getClientSite</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the internal link to the container client. </dd> <dt><b>Returns</b></dt> <dd>a reference to related container client if any is set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="update" class="membertitle">update</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>update</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>updates object's representations. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state to call the function </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in case problems detected </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setUpdateMode" class="membertitle">setUpdateMode</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>setUpdateMode</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nMode )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies how often the object's representation should be updated. </dd> <dt><b>Parameter nMode</b></dt> <dd>the new update mode, can take values from ::EmbeddedUpdateModes </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::WrongStateException the object is in wrong state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStatus" class="membertitle">getStatus</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">hyper</td> </tr> <tr> <td valign="top"><b>getStatus</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> nAspect )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the status of the object. </dd> <dt><b>Parameter nAspect</b></dt> <dd>the aspect specifying the form of object representation </dd> <dt><b>Returns</b></dt> <dd>the value specifying the status of the object for specified aspect can take values from <a href="EmbedMisc.html">EmbedMisc</a> constant set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setContainerName" class="membertitle">setContainerName</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>setContainerName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides object with the name of container document. </dd> <dt><b>Parameter sName</b></dt> <dd>name of the container document </dd> </dl> </td> </tr> </table> </td> </tr> </table> <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
>
2951
