xref: /AOO41X/main/offapi/com/sun/star/util/XRefreshable.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_util_XRefreshable_idl__
24#define __com_sun_star_util_XRefreshable_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_util_XRefreshListener_idl__
31#include <com/sun/star/util/XRefreshListener.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module util {
38
39//=============================================================================
40
41/** is supported by objects with data that can be refreshed from a data source.
42 */
43published interface XRefreshable: com::sun::star::uno::XInterface
44{
45    //-------------------------------------------------------------------------
46    /** refreshes the data of the object from the connected data source.
47     */
48    void refresh();
49
50    //-------------------------------------------------------------------------
51    /** adds the specified listener to receive the event "refreshed."
52     */
53    [oneway] void addRefreshListener( [in] com::sun::star::util::XRefreshListener l );
54
55    //-------------------------------------------------------------------------
56    /** removes the specified listener.
57     */
58    [oneway] void removeRefreshListener( [in] com::sun::star::util::XRefreshListener l );
59
60};
61
62//=============================================================================
63
64}; }; }; };
65
66#endif
67