<html> <head> <title>Interface XConnectionPoint</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="XConnectionPoint-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">lang</a> :: </p> </td> </tr> <tr> <td class="title">interface XConnectionPoint</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>supports connection points for connectable objects. </dd> <dd><p>Connectable objects support the following features: </p> <ul> <li>outgoing interfaces, such as event sets; </li> <li>the ability to enumerate the types of the outgoing interfaces; <li>the ability to connect and disconnect sinks to the object for those outgoing types; </li> <li>the ability to enumerate the connections that exist to a particular outgoing interface. </li> </ul> <h4>When to Implement?<h4> <p>To create a connectable object, you need to implement objects that provide two related interfaces: </p> <ul> <li><a href="XConnectionPointContainer.html">XConnectionPointContainer</a> </li> <li><a href="XConnectionPoint.html">XConnectionPoint</a> </li> </ul> <p>The <a href="XConnectionPointContainer.html">XConnectionPointContainer</a> interface is implemented on the connectable object to indicate the existence of the outgoing interfaces. It provides a sequence of sub-objects. It also provides access to all the connection point sub-objects, each of which implements the <a href="XConnectionPoint.html">XConnectionPoint</a> interface. The <a href="XConnectionPoint.html">XConnectionPoint</a> interface provides a sequence of sub-objects. </p> <p>Each connection point is a separate sub-object to avoid circular reference counting problems. A connection point controls how many connections (one or more) it will allow in its implementation of <a href="XConnectionPoint.html#advise()">advise()</a>. </p> <h4>When to use?</h4> <p>A client can use the <a href="XConnectionPointContainer.html">XConnectionPointContainer</a> interface: </p> <UL> <LI>to get a sequence of connection points for each outgoing type. </LI> <LI>to obtain access to connection point sub-objects with the <a href="XConnectionPoint.html">XConnectionPoint</a> interface for each outgoing type. Through the XConnectionPoint interface, a client starts or terminates an advisory loop with the connectable object and the client's own sink. The client can also use the <a href="XConnectionPoint.html">XConnectionPoint</a> interface to get a sequence of the connections that it knows about. </LI> </UL> </dd> <dt><b>See also</b></dt> <dd><a href="XConnectionPointContainer.html">XConnectionPointContainer</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="#getConnectionType">getConnectionType</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getConnectionPointContainer">getConnectionPointContainer</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#advise">advise</a></td> <td class="imsum_right">creates a connection between a connection point and a client's sink, where the sink implements the outgoing interface supported by this connection point. </td> </tr> <tr> <td class="imsum_left"><a href="#unadvise">unadvise</a></td> <td class="imsum_right">terminates a notification previously set up with advise. </td> </tr> <tr> <td class="imsum_left"><a href="#getConnections">getConnections</a></td> <td class="imsum_right"> </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="getConnectionType" class="membertitle">getConnectionType</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">type</td> </tr> <tr> <td valign="top"><b>getConnectionType</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the type of the outgoing interface managed by this connection point. <p>Using the <a href="XConnectionPointContainer.html">XConnectionPointContainer</a>::<a href="XConnectionPointContainer.html#getConnectionPoints">getConnectionPoints</a> method, a client can obtain an <a href="XConnectionPoint.html">XConnectionPoint</a> interface. Using that interface and this method, the client can determine the type of each connection point enumerated. The type returned from this method must enable the caller to access this same connection point through <a href="XConnectionPointContainer.html">XConnectionPointContainer</a>::<a href="XConnectionPointContainer.html#findConnectionPoint">findConnectionPoint</a>. </dd> <dt><b>See also</b></dt> <dd><a href="XConnectionPointContainer.html">XConnectionPointContainer</a>::<a href="XConnectionPointContainer.html#findConnectionPoint">findConnectionPoint</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getConnectionPointContainer" class="membertitle">getConnectionPointContainer</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="XConnectionPointContainer.html">XConnectionPointContainer</a></td> </tr> <tr> <td valign="top"><b>getConnectionPointContainer</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the <a href="XConnectionPointContainer.html">XConnectionPointContainer</a> interface on the parent connectable object. </dd> <dt><b>See also</b></dt> <dd><a href="XConnectionPointContainer.html">XConnectionPointContainer</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="advise" class="membertitle">advise</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>advise</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xListener )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="ListenerExistException.html">ListenerExistException</a>,<br> <a href="InvalidListenerException.html">InvalidListenerException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a connection between a connection point and a client's sink, where the sink implements the outgoing interface supported by this connection point. </dd> <dd><p>A few <code>add...Listener</code> methods need additional parameters to add listeners or throw exceptions. One of these methods is ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>::<a href="../beans/XPropertySet.html#addPropertyChangeListener">addPropertyChangeListener</a>. We ignore the problem in this interface. A solution must be provided in an additional <a href="XConnectionPoint.html">XConnectionPoint</a> interface. </p> </dd> <dt><b>Parameter xListener</b></dt> <dd>specifies the listener interface on the client's advise sink. The client's sink receives outgoing calls from the connection point container. </dd> <dt><b>Throws</b></dt> <dd>ListenerExistException if it is a unicast broadcaster and a listener is already set. </dd> <dt><b>Throws</b></dt> <dd>InvalidListenerException if the listener does not supply the needed interfaces. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>::<a href="../beans/XPropertySet.html#addPropertyChangeListener">addPropertyChangeListener</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="unadvise" class="membertitle">unadvise</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>unadvise</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>terminates a notification previously set up with advise. </dd> <dd><p>A few <code>remove...Listener</code> methods need additional parameters to add listeners or throw exceptions. One of these methods is ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>::<a href="../beans/XPropertySet.html#removePropertyChangeListener">removePropertyChangeListener</a>. We ignore the problem in this interface. A solution must be provided in an additional <a href="XConnectionPoint.html">XConnectionPoint</a> interface. </p> </dd> <dt><b>Parameter listener</b></dt> <dd>specifies the listener interface on the client's advise sink. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>::<a href="../beans/XPropertySet.html#removePropertyChangeListener">removePropertyChangeListener</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getConnections" class="membertitle">getConnections</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< ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a> ></td> </tr> <tr> <td valign="top"><b>getConnections</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of all currently advised connections. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
