xref: /aoo42x/main/offapi/com/sun/star/util/XDataEditor.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_util_XDataEditor_idl__
#define __com_sun_star_util_XDataEditor_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_util_XDataEditorListener_idl__
#include <com/sun/star/util/XDataEditorListener.idl>
#endif

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

module com {  module sun {  module star {  module util {

/** connects to a model and broadcasts status change events.
 */
published interface XDataEditor: com::sun::star::uno::XInterface
{
	/** makes the data editor visible to the user.
	 */
	void show();

	//--------------------------------------------------------------------------
	/** connects the data editor to a data model.
	 */
	void setModel( [in] com::sun::star::uno::XInterface model );

	//--------------------------------------------------------------------------
	/** @returns
			the data model which was set by <method>XDataEditor::setModel</method>.
	 */
	com::sun::star::uno::XInterface getModel();

	//--------------------------------------------------------------------------
	/** registers a listener to receive <type>DataEditorEvent</type>s.
	 */
	void addDataEditorListener( [in] XDataEditorListener listener );

	//--------------------------------------------------------------------------
	/** unregisters a listener which received <type>DataEditorEvent</type>s.
	 */
	void removeDataEditorListener( [in] XDataEditorListener listener );
};

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

}; }; }; };

#endif