<html> <head> <title>Interface XDocumentEventBroadcaster</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="XDocumentEventBroadcaster-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">document</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 XDocumentEventBroadcaster</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>allows to be notified of events happening in an <a href="OfficeDocument.html">OfficeDocument</a>, and to cause notification of such events. </dd> <dd><p>This interface is the successor of the XEventBroadcaster interface, which should not be used anymore.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 3.1</dd> <dt><b>See also</b></dt> <dd><a href="DocumentEvent.html">DocumentEvent</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="#addDocumentEventListener">addDocumentEventListener</a></td> <td class="imsum_right">registers a listener which is notified about document events </td> </tr> <tr> <td class="imsum_left"><a href="#removeDocumentEventListener">removeDocumentEventListener</a></td> <td class="imsum_right">revokes a listener which has previously been registered to be notified about document events. </td> </tr> <tr> <td class="imsum_left"><a href="#notifyDocumentEvent">notifyDocumentEvent</a></td> <td class="imsum_right">causes the broadcaster to notify all registered listeners of the given event </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="addDocumentEventListener" class="membertitle">addDocumentEventListener</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>addDocumentEventListener</b>(</td> <td valign="top">[in] <a href="XDocumentEventListener.html">XDocumentEventListener</a></td> <td valign="bottom"> _Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers a listener which is notified about document events </dd> <dt><b>Parameter _Listener</b></dt> <dd>the listener to register. The behavior of the method is undefined this listener is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeDocumentEventListener" class="membertitle">removeDocumentEventListener</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>removeDocumentEventListener</b>(</td> <td valign="top">[in] <a href="XDocumentEventListener.html">XDocumentEventListener</a></td> <td valign="bottom"> _Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>revokes a listener which has previously been registered to be notified about document events. </dd> <dt><b>Parameter _Listener</b></dt> <dd>the listener to revoke. The behavior of the method is undefined this listener is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="notifyDocumentEvent" class="membertitle">notifyDocumentEvent</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>notifyDocumentEvent</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> _EventName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController2.html">XController2</a></td> <td valign="bottom"> _ViewController,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> _Supplement )</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> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>causes the broadcaster to notify all registered listeners of the given event </dd> <dd><p>The method will create a <a href="DocumentEvent.html">DocumentEvent</a> instance with the given parameters, and fill in the <code>Source</code> member (denoting the broadcaster) as appropriate.</p> <p>Whether the actual notification happens synchronously or asynchronously is up to the implementor of this method. However, implementations are encouraged to specify this, for the list of supported event types, in their service contract.</p> <p>Implementations might also decide to limit the list of allowed events (means event names) at their own discretion. Again, in this case they're encouraged to document this in their service contract.</p> </dd> <dt><b>Parameter _EventName</b></dt> <dd>the name of the event to be notified. </dd> <dt><b>Parameter _ViewController</b></dt> <dd>the view/controller which the event applies to. May be <b>NULL</b> </dd> <dt><b>Parameter _Supplement</b></dt> <dd>supplemental information related to the event. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if <arg>_EventName</arg> is empty, or if <arg>_EventName</arg> is not supported by the document implementation. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::NoSupportException if the broadcaster implementation does not supported broadcasting events induced externally. This is usually used for components which multiplex events from multiple sources, and thus would be unable to fill in the <code>Source</code> member of the <a href="DocumentEvent.html">DocumentEvent</a> instance. </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>
