offapi/com/sun/star/frame/XStorable2.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 frame {
  23
  24 /** extends XStorable.
  25  */
  26 published interface XStorable2: XStorable
  27 {
  28     /** stores the data to the URL from which it was loaded.
  29
  30         <p>
  31             Only objects which know their locations can be stored.
  32         </p>
  33
  34         <p>
  35             This is an extension of the XStorable::store().
  36             This method allows to specify some additional parameters for
  37             storing process.
  38         </p>
  39
  40         @param lArguments
  41             optional parameters for saving, can take values from subset of
  42             com::sun::star::document::MediaDescriptor
  43
  44         @throws ::com::sun::star::lang::IllegalArgumentException
  45             the optional parameters contain unacceptable for save entry
  46
  47         @throws com::sun::star::io::IOException
  48             if an IO error occurred during save operation
  49
  50         @see XStorable::store
  51      */
  52     void storeSelf(
  53         [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
  54             raises( com::sun::star::lang::IllegalArgumentException,
  55                     com::sun::star::io::IOException );
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */