offapi/com/sun/star/ui/dialogs/FilePicker.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FilePicker.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_dialogs_FilePicker_idl__
  32 #define __com_sun_star_ui_dialogs_FilePicker_idl__
  33
  34 #ifndef __com_sun_star_lang_XComponent_idl__
  35 #include <com/sun/star/lang/XComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  39 #include <com/sun/star/lang/XServiceInfo.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XTypeProvider_idl__
  43 #include <com/sun/star/lang/XTypeProvider.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_lang_XInitialization_idl__
  47 #include <com/sun/star/lang/XInitialization.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_util_XCancellable_idl__
  51 #include <com/sun/star/util/XCancellable.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56 module com { module sun { module star { module ui { module dialogs {
  57
  58 //=============================================================================
  59
  60 //=============================================================================
  61 /** A FilePicker.
  62
  63     It is <strong>NOT</strong> recommended to cache a reference to a file
  64     picker instance. Due to restrictions by the underlying system there can
  65     be specific limitations possible. To overcome these problems it'
  66     s recommended to create a new instance on demand.
  67
  68     @see XFilePicker
  69 */
  70
  71  published interface XFilePicker;
  72  published interface XFilePickerNotifier;
  73  published interface XFilePickerControlAccess;
  74  published interface XFilterManager;
  75  published interface XFilePreview;
  76  published interface XFilterGroupManager;
  77
  78 published service FilePicker
  79 {
  80     //-------------------------------------------------------------------------
  81     /** Allows to associate a help URL with the file picker instance.
  82     */
  83     [optional, property] string HelpURL;
  84
  85     //-------------------------------------------------------------------------
  86     /** Provides access to the basic FilePicker functionality.
  87     */
  88     interface XFilePicker;
  89
  90     //-------------------------------------------------------------------------
  91     /** Provides the ability to request notifications about changes.
  92     */
  93     interface XFilePickerNotifier;
  94
  95     //-------------------------------------------------------------------------
  96     /** Provides the ability to add different filter, query for the current
  97         filters and set a current filter
  98     */
  99     interface XFilterManager;
 100
 101     //-------------------------------------------------------------------------
 102     /** Provides the ability to show a preview of a selected file
 103     */
 104     [optional] interface XFilePreview;
 105
 106     //-------------------------------------------------------------------------
 107     /** Provides the ability manage additional controls (checkboxes, listboxes etc.)
 108         offered by an extended FilePicker, these controls extend the subset of
 109         common controls that a FilePicker usually supports.
 110
 111         @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
 112         @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
 113
 114         @deprecated
 115     */
 116     [optional] interface XFilePickerControlAccess;
 117
 118     //-------------------------------------------------------------------------
 119     /** An interface which allows manipulation of groups of filters
 120     */
 121     [optional] interface XFilterGroupManager;
 122
 123     //-------------------------------------------------------------------------
 124     /** Provides the ability to choose between different custom templates that
 125         do extend the subset of common controls a FilePicker usually supports.
 126         Implementers may omit this interface if the FileOpen
 127         dialog doesn't support custom templates. In this case a createInstance
 128         will create an ordinary FileOpen dialog with only the common FilePicker
 129         elements.
 130         The client has to provide one of the specified constants in
 131         TemplateDescription.
 132         <br/><br/>
 133         <p><strong>Notes for the implementation of a FileSave dialog:</strong>
 134         The implementation of a FileSave dialog should automatically check
 135         for existens of a file and issue a warning if a file with the same
 136         name already exist.</p>
 137
 138         @see com::sun::star::ui::dialogs::TemplateDescription
 139     */
 140     [optional] interface com::sun::star::lang::XInitialization;
 141
 142     //-------------------------------------------------------------------------
 143     /** For canceling a running dialog instance.
 144         <p>This may be usefull for automatic test tools for instance.</p>
 145     */
 146     [optional] interface com::sun::star::util::XCancellable;
 147
 148     //-------------------------------------------------------------------------
 149     /** For shutdown and listener support.
 150     */
 151     interface com::sun::star::lang::XComponent;
 152
 153     //-------------------------------------------------------------------------
 154     /** Service should always support this interface.
 155     */
 156     interface com::sun::star::lang::XServiceInfo;
 157
 158     //-------------------------------------------------------------------------
 159     /** Service should always support this interface.
 160     */
 161     interface com::sun::star::lang::XTypeProvider;
 162 };
 163
 164 //=============================================================================
 165
 166 }; }; }; }; };
 167
 168 #endif