/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: FilePicker.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 08:35:09 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_ui_dialogs_FilePicker_idl__
#define __com_sun_star_ui_dialogs_FilePicker_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_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.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 {

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

//=============================================================================
/** A FilePicker. 

	@see XFilePicker
*/

 published interface XFilePicker;
 published interface XFilePickerNotifier;
 published interface XFilePickerControlAccess;
 published interface XFilterManager;
 published interface XFilePreview;
 published interface XFilterGroupManager;
    
published service FilePicker
{
	//-------------------------------------------------------------------------
	/** Allows to associate a help URL with the file picker instance.
	*/
	[optional, property] string HelpURL;

	//-------------------------------------------------------------------------
	/** Provides access to the basic FilePicker functionality.		
	*/
	interface XFilePicker;

	//-------------------------------------------------------------------------
	/** Provides the ability to request notifications about changes.
	*/
	interface XFilePickerNotifier;

	//-------------------------------------------------------------------------
	/** Provides the ability to add different filter, query for the current 
		filters and set a current filter		
	*/
	interface XFilterManager;

	//-------------------------------------------------------------------------
	/** Provides the ability to show a preview of a selected file		
	*/
	[optional] interface XFilePreview;

	//-------------------------------------------------------------------------
	/** Provides the ability manage additional controls (checkboxes, listboxes etc.)
		offered by an extended FilePicker, these controls extend the subset of
		common controls that a FilePicker usually supports.

		@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
		@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds		
		
		@deprecated
	*/
	[optional] interface XFilePickerControlAccess;

	//-------------------------------------------------------------------------
	/** An interface which allows manipulation of groups of filters
	*/
	[optional] interface XFilterGroupManager;

	//-------------------------------------------------------------------------
	/** Provides the ability to choose between different custom templates that
		do extend the subset of common controls a FilePicker usually supports. 
		Implementers may omit this interface if the FileOpen
		dialog doesn't support custom templates. In this case a createInstance
		will create an ordinary FileOpen dialog with only the common FilePicker
		elements.
		The client has to provide one of the specified constants in 
		TemplateDescription.
		<br/><br/>	
		<p><strong>Notes for the implementation of a FileSave dialog:</strong>
		The implementation of a FileSave dialog should automatically check 
		for existens of a file and issue a warning if a file with the same 
		name already exist.</p>
		
		@see com::sun::star::ui::dialogs::TemplateDescription
	*/
	[optional] interface com::sun::star::lang::XInitialization;

	//-------------------------------------------------------------------------
	/** 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;

	//-------------------------------------------------------------------------
	/** For shutdown and listener support.
	*/
	interface com::sun::star::lang::XComponent;

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

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

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

}; }; }; }; };

#endif
