LibreOffice: com/sun/star/document/XDocumentEventBroadcaster.idl Source File

LibreOffice LibreOffice 6.3 SDK API Reference

XDocumentEventBroadcaster.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef __com_sun_star_document_XDocumentEventBroadcaster_idl__
21 #define __com_sun_star_document_XDocumentEventBroadcaster_idl__
22
23 #include <com/sun/star/frame/XController2.idl>
24 #include <com/sun/star/document/DocumentEvent.idl>
25 #include <com/sun/star/lang/IllegalArgumentException.idl>
26 #include <com/sun/star/lang/NoSupportException.idl>
27
28
29 module com { module sun { module star { module document {
30
31 interface XDocumentEventListener;
32
33
43 interface XDocumentEventBroadcaster
44 {
51 void addDocumentEventListener( [in] XDocumentEventListener Listener );
52
59 void removeDocumentEventListener( [in] XDocumentEventListener Listener );
60
90 void notifyDocumentEvent(
91 [in] string EventName,
92 [in] ::com::sun::star::frame::XController2 ViewController,
93 [in] any Supplement
94 )
95 raises ( ::com::sun::star::lang::IllegalArgumentException,
96 ::com::sun::star::lang::NoSupportException );
97 };
98
99
100 }; }; }; };
101
102
103 #endif
104
105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::document::XDocumentEventBroadcaster::addDocumentEventListener
void addDocumentEventListener([in] XDocumentEventListener Listener)
registers a listener which is notified about document events
com::sun::star::document::XDocumentEventBroadcaster::notifyDocumentEvent
void notifyDocumentEvent([in] string EventName, [in] ::com::sun::star::frame::XController2 ViewController, [in] any Supplement)
causes the broadcaster to notify all registered listeners of the given event
com::sun::star::frame::XController2
extends the XController interface
Definition: XController2.idl:37
com::sun::star::document::XDocumentEventBroadcaster::removeDocumentEventListener
void removeDocumentEventListener([in] XDocumentEventListener Listener)
revokes a listener which has previously been registered to be notified about document events.
com::sun::star::document::XDocumentEventBroadcaster
allows to be notified of events happening in an OfficeDocument, and to cause notification of such eve...
Definition: XDocumentEventBroadcaster.idl:44
com
Definition: Ambiguous.idl:22
NoSupportException.idl
XController2.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
IllegalArgumentException.idl
DocumentEvent.idl
com::sun::star::document::XDocumentEventListener
allows to be notified of events happening in an OfficeDocument
Definition: XDocumentEventListener.idl:39
com::sun::star::lang::NoSupportException
This exception is thrown when a feature of an interface is not supported.
Definition: NoSupportException.idl:39