xref: /aoo41x/main/offapi/com/sun/star/ui/dialogs/FolderPicker.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_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 usefull for automatic test tools for instance.</p>
	*/
	[optional] interface com::sun::star::util::XCancellable;
};

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

}; }; }; }; };

#endif