offapi/com/sun/star/document/XDocumentInsertable.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {   module sun {   module star {   module document {
  23
  24
  25 /** Makes it possible to import a document from a given URL
  26     into this document.
  27  */
  28 published interface XDocumentInsertable: com::sun::star::uno::XInterface
  29 {
  30     /** Inserts the document that is specified by the URL.
  31         The document will be inserted at the current cursor position.
  32
  33         Make sure that you insert at a position which can be split
  34         in two paragraphs (i.e. not inside of a field).
  35      */
  36     void insertDocumentFromURL( [in] string aURL,
  37              [in] sequence<com::sun::star::beans::PropertyValue> aOptions )
  38             raises( com::sun::star::lang::IllegalArgumentException,
  39                     com::sun::star::io::IOException );
  40
  41 };
  42
  43
  44 }; }; }; };
  45
  46 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */