main/offapi/com/sun/star/ucb/XCommandEnvironment.idl

/**************************************************************
 * 
 * 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_ucb_XCommandEnvironment_idl__
#define __com_sun_star_ucb_XCommandEnvironment_idl__

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

#ifndef __com_sun_star_task_XInteractionHandler_idl__
#include <com/sun/star/task/XInteractionHandler.idl>
#endif

#ifndef __com_sun_star_ucb_XProgressHandler_idl__
#include <com/sun/star/ucb/XProgressHandler.idl>
#endif

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

module com { module sun { module star { module ucb {

//=============================================================================
/** defines the environment for a command.

	@version  1.0
	@author   Kai Sommerfeld
	@see XCommandProcessor
*/
published interface XCommandEnvironment : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** returns the command's interaction handler.

		<p>If called multiple times, this method should consistently return the
		same value (to allow caching).

		@returns
		an interaction handler
	*/
	com::sun::star::task::XInteractionHandler getInteractionHandler();

	//-------------------------------------------------------------------------
	/** returns the command's progress handler.

		<p>If called multiple times, this method should consistently return the
		same value (to allow caching).

		@returns
		a progress handler
	*/
	com::sun::star::ucb::XProgressHandler getProgressHandler();
};

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

}; }; }; };

#endif