1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_FilePicker_idl__ 25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_FilePicker_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_lang_XComponent_idl__ 28cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_lang_XServiceInfo_idl__ 32cdf0e10cSrcweir#include <com/sun/star/lang/XServiceInfo.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_lang_XTypeProvider_idl__ 36cdf0e10cSrcweir#include <com/sun/star/lang/XTypeProvider.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_lang_XInitialization_idl__ 40cdf0e10cSrcweir#include <com/sun/star/lang/XInitialization.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir#ifndef __com_sun_star_util_XCancellable_idl__ 44cdf0e10cSrcweir#include <com/sun/star/util/XCancellable.idl> 45cdf0e10cSrcweir#endif 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir//============================================================================= 54cdf0e10cSrcweir/** A FilePicker. 55cdf0e10cSrcweir 56cdf0e10cSrcweir It is <strong>NOT</strong> recommended to cache a reference to a file 57cdf0e10cSrcweir picker instance. Due to restrictions by the underlying system there can 58cdf0e10cSrcweir be specific limitations possible. To overcome these problems it' 59cdf0e10cSrcweir s recommended to create a new instance on demand. 60cdf0e10cSrcweir 61cdf0e10cSrcweir @see XFilePicker 62cdf0e10cSrcweir*/ 63cdf0e10cSrcweir 64cdf0e10cSrcweir published interface XFilePicker; 65cdf0e10cSrcweir published interface XFilePickerNotifier; 66cdf0e10cSrcweir published interface XFilePickerControlAccess; 67cdf0e10cSrcweir published interface XFilterManager; 68cdf0e10cSrcweir published interface XFilePreview; 69cdf0e10cSrcweir published interface XFilterGroupManager; 70cdf0e10cSrcweir 71cdf0e10cSrcweirpublished service FilePicker 72cdf0e10cSrcweir{ 73cdf0e10cSrcweir //------------------------------------------------------------------------- 74cdf0e10cSrcweir /** Allows to associate a help URL with the file picker instance. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir [optional, property] string HelpURL; 77cdf0e10cSrcweir 78cdf0e10cSrcweir //------------------------------------------------------------------------- 79cdf0e10cSrcweir /** Provides access to the basic FilePicker functionality. 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir interface XFilePicker; 82cdf0e10cSrcweir 83cdf0e10cSrcweir //------------------------------------------------------------------------- 84cdf0e10cSrcweir /** Provides the ability to request notifications about changes. 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir interface XFilePickerNotifier; 87cdf0e10cSrcweir 88cdf0e10cSrcweir //------------------------------------------------------------------------- 89cdf0e10cSrcweir /** Provides the ability to add different filter, query for the current 90cdf0e10cSrcweir filters and set a current filter 91cdf0e10cSrcweir */ 92cdf0e10cSrcweir interface XFilterManager; 93cdf0e10cSrcweir 94cdf0e10cSrcweir //------------------------------------------------------------------------- 95cdf0e10cSrcweir /** Provides the ability to show a preview of a selected file 96cdf0e10cSrcweir */ 97cdf0e10cSrcweir [optional] interface XFilePreview; 98cdf0e10cSrcweir 99cdf0e10cSrcweir //------------------------------------------------------------------------- 100cdf0e10cSrcweir /** Provides the ability manage additional controls (checkboxes, listboxes etc.) 101cdf0e10cSrcweir offered by an extended FilePicker, these controls extend the subset of 102cdf0e10cSrcweir common controls that a FilePicker usually supports. 103cdf0e10cSrcweir 104cdf0e10cSrcweir @see com::sun::star::ui::dialogs::CommonFilePickerElementIds 105cdf0e10cSrcweir @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds 106cdf0e10cSrcweir 107cdf0e10cSrcweir @deprecated 108cdf0e10cSrcweir */ 109cdf0e10cSrcweir [optional] interface XFilePickerControlAccess; 110cdf0e10cSrcweir 111cdf0e10cSrcweir //------------------------------------------------------------------------- 112cdf0e10cSrcweir /** An interface which allows manipulation of groups of filters 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir [optional] interface XFilterGroupManager; 115cdf0e10cSrcweir 116cdf0e10cSrcweir //------------------------------------------------------------------------- 117cdf0e10cSrcweir /** Provides the ability to choose between different custom templates that 118cdf0e10cSrcweir do extend the subset of common controls a FilePicker usually supports. 119cdf0e10cSrcweir Implementers may omit this interface if the FileOpen 120cdf0e10cSrcweir dialog doesn't support custom templates. In this case a createInstance 121cdf0e10cSrcweir will create an ordinary FileOpen dialog with only the common FilePicker 122cdf0e10cSrcweir elements. 123cdf0e10cSrcweir The client has to provide one of the specified constants in 124cdf0e10cSrcweir TemplateDescription. 125cdf0e10cSrcweir <br/><br/> 126cdf0e10cSrcweir <p><strong>Notes for the implementation of a FileSave dialog:</strong> 127cdf0e10cSrcweir The implementation of a FileSave dialog should automatically check 128cdf0e10cSrcweir for existens of a file and issue a warning if a file with the same 129cdf0e10cSrcweir name already exist.</p> 130cdf0e10cSrcweir 131cdf0e10cSrcweir @see com::sun::star::ui::dialogs::TemplateDescription 132cdf0e10cSrcweir */ 133cdf0e10cSrcweir [optional] interface com::sun::star::lang::XInitialization; 134cdf0e10cSrcweir 135cdf0e10cSrcweir //------------------------------------------------------------------------- 136cdf0e10cSrcweir /** For canceling a running dialog instance. 137*a893be29SPedro Giffuni <p>This may be useful for automatic test tools for instance.</p> 138cdf0e10cSrcweir */ 139cdf0e10cSrcweir [optional] interface com::sun::star::util::XCancellable; 140cdf0e10cSrcweir 141cdf0e10cSrcweir //------------------------------------------------------------------------- 142cdf0e10cSrcweir /** For shutdown and listener support. 143cdf0e10cSrcweir */ 144cdf0e10cSrcweir interface com::sun::star::lang::XComponent; 145cdf0e10cSrcweir 146cdf0e10cSrcweir //------------------------------------------------------------------------- 147cdf0e10cSrcweir /** Service should always support this interface. 148cdf0e10cSrcweir */ 149cdf0e10cSrcweir interface com::sun::star::lang::XServiceInfo; 150cdf0e10cSrcweir 151cdf0e10cSrcweir //------------------------------------------------------------------------- 152cdf0e10cSrcweir /** Service should always support this interface. 153cdf0e10cSrcweir */ 154cdf0e10cSrcweir interface com::sun::star::lang::XTypeProvider; 155cdf0e10cSrcweir}; 156cdf0e10cSrcweir 157cdf0e10cSrcweir//============================================================================= 158cdf0e10cSrcweir 159cdf0e10cSrcweir}; }; }; }; }; 160cdf0e10cSrcweir 161cdf0e10cSrcweir#endif 162