xref: /aoo42x/main/offapi/com/sun/star/util/XRefreshable.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_util_XRefreshable_idl__
#define __com_sun_star_util_XRefreshable_idl__

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

#ifndef __com_sun_star_util_XRefreshListener_idl__
#include <com/sun/star/util/XRefreshListener.idl>
#endif


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

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

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

/** is supported by objects with data that can be refreshed from a data source.
 */
published interface XRefreshable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** refreshes the data of the object from the connected data source.
	 */
	void refresh();

	//-------------------------------------------------------------------------
	/** adds the specified listener to receive the event "refreshed."
	 */
	[oneway] void addRefreshListener( [in] com::sun::star::util::XRefreshListener l );

	//-------------------------------------------------------------------------
	/** removes the specified listener.
	 */
	[oneway] void removeRefreshListener( [in] com::sun::star::util::XRefreshListener l );

};

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

}; }; }; };

#endif