xref: /trunk/main/offapi/com/sun/star/ui/dialogs/FolderPicker.idl (revision a893be29)

/**************************************************************
 *
 * 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_ui_dialogs_FolderPicker_idl__
#define __com_sun_star_ui_dialogs_FolderPicker_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_lang_XServiceInfo_idl__
#include <com/sun/star/lang/XServiceInfo.idl>
#endif

#ifndef __com_sun_star_lang_XTypeProvider_idl__
#include <com/sun/star/lang/XTypeProvider.idl>
#endif

#ifndef __com_sun_star_util_XCancellable_idl__
#include <com/sun/star/util/XCancellable.idl>
#endif

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

module com { module sun { module star { module ui { module dialogs {

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

 published interface XFolderPicker;

//=============================================================================
/** A FolderPicker service.
*/

published service FolderPicker
{
	//-------------------------------------------------------------------------
	/** Provides the ability to execute a FolderPicker dialog and
		browse for and select folders.
	*/
	interface XFolderPicker;

	//-------------------------------------------------------------------------
	/** Service should always support this interface.
	*/
	interface com::sun::star::lang::XServiceInfo;

	//-------------------------------------------------------------------------
	/** Service should always support this interface.
	*/
	interface com::sun::star::lang::XTypeProvider;

	//-------------------------------------------------------------------------
	/** For canceling a running dialog instance.
		<p>This may be useful for automatic test tools for instance.</p>
	*/
	[optional] interface com::sun::star::util::XCancellable;
};

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

}; }; }; }; };

#endif