xref: /trunk/main/offapi/com/sun/star/form/XLoadable.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_XLoadable_idl__
28#define __com_sun_star_form_XLoadable_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_form_XLoadListener_idl__
35#include <com/sun/star/form/XLoadListener.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module form {
41
42//=============================================================================
43
44/** provides functionality to implement objects which may be loaded.
45
46	<p>The object is typically implemented by high-level objects which can connect to a data source.</p>
47
48	@see XLoadListener
49 */
50published interface XLoadable: com::sun::star::uno::XInterface
51{
52	//-------------------------------------------------------------------------
53
54	/** loads the data.
55
56        <p>If the data is already loaded (->isLoaded), then the method returns silently.
57        In this case, you should use ->reload.</p>
58	 */
59	[oneway] void load();
60
61	//-------------------------------------------------------------------------
62
63	/** unloads the data.
64	 */
65	[oneway] void unload();
66
67	//-------------------------------------------------------------------------
68
69	/** does a smart refresh of the object.
70
71		<p>The final state will be the same as if unload and load were called, but reload
72		is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p>
73	 */
74	[oneway] void reload();
75
76	//-------------------------------------------------------------------------
77
78	/** returns if the object is in loaded state.
79	 */
80	boolean isLoaded();
81
82	//-------------------------------------------------------------------------
83
84	/** adds the specified listener to receive load-related events
85
86		@param aListener
87			the listener to add.
88	 */
89	[oneway] void addLoadListener( [in] com::sun::star::form::XLoadListener aListener );
90
91	//-------------------------------------------------------------------------
92
93	/** removes the specified listener.
94
95		@param aListener
96			the listener to remove.
97	 */
98	[oneway] void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener );
99};
100
101}; }; }; };
102
103#endif
104
105/*=============================================================================
106
107=============================================================================*/
108