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

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