offapi/com/sun/star/util/XImportable.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 #ifndef __com_sun_star_util_XImportable_idl__
  28 #define __com_sun_star_util_XImportable_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_beans_PropertyValue_idl__
  35 #include <com/sun/star/beans/PropertyValue.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module util {
  42
  43 //=============================================================================
  44
  45 // DocMerge from xml: interface com::sun::star::util::XImportable
  46 /** makes it possible to import files into the object.
  47  */
  48 published interface XImportable: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     // DocMerge from idl: method com::sun::star::util::XImportable::createImportDescriptor
  53     /** @returns
  54                     a descriptor which contains the arguments for an import.
  55      */
  56     sequence<com::sun::star::beans::PropertyValue> createImportDescriptor( [in] boolean bEmpty );
  57
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from xml: method com::sun::star::util::XImportable::doImport
  61     /** imports data from an external database.
  62      */
  63     void doImport( [in] sequence<com::sun::star::beans::PropertyValue> aDescriptor );
  64
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif