xref: /aoo42x/main/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_document_XDocumentEventBroadcaster_idl__
#define __com_sun_star_document_XDocumentEventBroadcaster_idl__

#ifndef __com_sun_star_frame_XController2_idl__
#include <com/sun/star/frame/XController2.idl>
#endif

#ifndef __com_sun_star_document_DocumentEvent_idl__
#include <com/sun/star/document/DocumentEvent.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif

//=============================================================================

module com { module sun { module star { module document {

published interface XDocumentEventListener;

//=============================================================================

/** allows to be notified of events happening in an <type>OfficeDocument</type>, and to cause notification
    of such events.

    <p>This interface is the successor of the XEventBroadcaster interface, which should not be used
    anymore.</p>

    @see DocumentEvent
    @since OOo 3.1
*/
published interface XDocumentEventBroadcaster
{
    /** registers a listener which is notified about document events

        @param _Listener
            the listener to register. The behaviour of the method is undefined this listener
            is <NULL/>.
    */
    void    addDocumentEventListener( [in] XDocumentEventListener _Listener );

    /** revokes a listener which has previously been registered to be notified about document events.

        @param _Listener
            the listener to revoke. The behaviour of the method is undefined this listener
            is <NULL/>.
    */
    void    removeDocumentEventListener( [in] XDocumentEventListener _Listener );

    /** causes the broadcaster to notify all registered listeners of the given event

        <p>The method will create a <type>DocumentEvent</type> 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
        implementator 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>

        @param _EventName
            the name of the event to be notified.
        @param _ViewController
            the view/controller which the event applies to. May be <NULL/>
        @param _Supplement
            supplemental information related to the event.

        @throws ::com::sun::star::lang::IllegalArgumentException
            if <arg>_EventName</arg> is empty, or if <arg>_EventName</arg> is not supported by the
            document implementation.

        @throws ::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 <type>DocumentEvent</type> instance.
    */
    void    notifyDocumentEvent(
                [in] string _EventName,
                [in] ::com::sun::star::frame::XController2 _ViewController,
                [in] any _Supplement
            )
            raises ( ::com::sun::star::lang::IllegalArgumentException,
                     ::com::sun::star::lang::NoSupportException );
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif