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