xref: /trunk/main/offapi/com/sun/star/util/XDataEditor.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_util_XDataEditor_idl__
28#define __com_sun_star_util_XDataEditor_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_util_XDataEditorListener_idl__
35#include <com/sun/star/util/XDataEditorListener.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module util {
41
42/** connects to a model and broadcasts status change events.
43 */
44published interface XDataEditor: com::sun::star::uno::XInterface
45{
46	/** makes the data editor visible to the user.
47	 */
48	void show();
49
50	//--------------------------------------------------------------------------
51	/** connects the data editor to a data model.
52	 */
53	void setModel( [in] com::sun::star::uno::XInterface model );
54
55	//--------------------------------------------------------------------------
56	/** @returns
57			the data model which was set by <method>XDataEditor::setModel</method>.
58	 */
59	com::sun::star::uno::XInterface getModel();
60
61	//--------------------------------------------------------------------------
62	/** registers a listener to receive <type>DataEditorEvent</type>s.
63	 */
64	void addDataEditorListener( [in] XDataEditorListener listener );
65
66	//--------------------------------------------------------------------------
67	/** unregisters a listener which received <type>DataEditorEvent</type>s.
68	 */
69	void removeDataEditorListener( [in] XDataEditorListener listener );
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77