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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_dialogs_FolderPicker_idl__
  29 #define __com_sun_star_ui_dialogs_FolderPicker_idl__
  30
  31 #ifndef __com_sun_star_lang_XComponent_idl__
  32 #include <com/sun/star/lang/XComponent.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  36 #include <com/sun/star/lang/XServiceInfo.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_lang_XTypeProvider_idl__
  40 #include <com/sun/star/lang/XTypeProvider.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
  49 module com { module sun { module star { module ui { module dialogs {
  50
  51 //=============================================================================
  52
  53  published interface XFolderPicker;
  54
  55 //=============================================================================
  56 /** A FolderPicker service.
  57 */
  58
  59 published service FolderPicker
  60 {
  61     //-------------------------------------------------------------------------
  62     /** Provides the ability to execute a FolderPicker dialog and
  63         browse for and select folders.
  64     */
  65     interface XFolderPicker;
  66
  67     //-------------------------------------------------------------------------
  68     /** Service should always support this interface.
  69     */
  70     interface com::sun::star::lang::XServiceInfo;
  71
  72     //-------------------------------------------------------------------------
  73     /** Service should always support this interface.
  74     */
  75     interface com::sun::star::lang::XTypeProvider;
  76
  77     //-------------------------------------------------------------------------
  78     /** For canceling a running dialog instance.
  79         <p>This may be usefull for automatic test tools for instance.</p>
  80     */
  81     [optional] interface com::sun::star::util::XCancellable;
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; }; };
  87
  88 #endif